diff options
author | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2016-08-11 07:24:25 +0000 |
---|---|---|
committer | nobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2016-08-11 07:24:25 +0000 |
commit | 90bc4136ac1de574a78fb3d1b0cfe2e5049446e2 (patch) | |
tree | 270ff42cf910d737720c5d8f4fd3c9b43f0e5249 | |
parent | 81c1b12a37fbbe97a7dc17a7a9ede2cbef13b094 (diff) | |
download | ruby-90bc4136ac1de574a78fb3d1b0cfe2e5049446e2.tar.gz |
Comparable#clamp
* compar.c (cmp_clamp): Introduce Comparable#clamp. [Feature #10594]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@55863 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r-- | ChangeLog | 4 | ||||
-rw-r--r-- | NEWS | 4 | ||||
-rw-r--r-- | compar.c | 34 | ||||
-rw-r--r-- | test/ruby/test_comparable.rb | 14 |
4 files changed, 56 insertions, 0 deletions
@@ -1,3 +1,7 @@ +Thu Aug 11 16:24:23 2016 nerdinand <nerdinand@nerdinand.com> + + * compar.c (cmp_clamp): Introduce Comparable#clamp. [Feature #10594] + Thu Aug 11 03:16:59 2016 Marc-Andre Lafortune <ruby-core@marc-andre.ca> * lib/prime.rb: Optimize prime? @@ -30,6 +30,10 @@ with all sufficient information, see the ChangeLog file or Redmine This is different from Enumerable#sum in that Array#sum doesn't depend on the definition of each method. +* Comparable + + * Comparable#clamp. [Feature #10594] + * Dir * Dir.empty?. [Feature #10121] @@ -174,6 +174,39 @@ cmp_between(VALUE x, VALUE min, VALUE max) } /* + * call-seq: + * obj.clamp(min, max) -> obj + * + * Returns <i>min</i> if <i>obj</i> <code><=></code> <i>min</i> is less + * than zero, <i>max</i> if <i>obj</i> <code><=></code> <i>max</i> is + * greater than zero and <i>obj</i> otherwise. + * + * 12.clamp(0, 100) #=> 12 + * 523.clamp(0, 100) #=> 100 + * -3.123.clamp(0, 100) #=> 0 + * + * 'd'.clamp('a', 'f') #=> 'd' + * 'z'.clamp('a', 'f') #=> 'f' + */ + +static VALUE +cmp_clamp(VALUE x, VALUE min, VALUE max) +{ + int c; + + if (cmpint(min, max) > 0) { + rb_raise(rb_eArgError, "min argument must be smaller than max argument"); + } + + c = cmpint(x, min); + if (c == 0) return x; + if (c < 0) return min; + c = cmpint(x, max); + if (c > 0) return max; + return x; +} + +/* * The <code>Comparable</code> mixin is used by classes whose objects * may be ordered. The class must define the <code><=></code> operator, * which compares the receiver against another object, returning -1, 0, @@ -225,4 +258,5 @@ Init_Comparable(void) rb_define_method(rb_mComparable, "<", cmp_lt, 1); rb_define_method(rb_mComparable, "<=", cmp_le, 1); rb_define_method(rb_mComparable, "between?", cmp_between, 2); + rb_define_method(rb_mComparable, "clamp", cmp_clamp, 2); } diff --git a/test/ruby/test_comparable.rb b/test/ruby/test_comparable.rb index 7624ef2bd3..f35719a9cb 100644 --- a/test/ruby/test_comparable.rb +++ b/test/ruby/test_comparable.rb @@ -76,6 +76,20 @@ class TestComparable < Test::Unit::TestCase assert_equal(true, @o.between?(0, 0)) end + def test_clamp + cmp->(x) do 0 <=> x end + assert_equal(1, @o.clamp(1, 2)) + assert_equal(-1, @o.clamp(-2, -1)) + assert_equal(0, @o.clamp(-1, 3)) + + assert_equal(1, @o.clamp(1, 1)) + assert_equal(0, @o.clamp(0, 0)) + + assert_raise_with_message(ArgumentError, 'min argument must be smaller than max argument') { + @o.clamp(2, 1) + } + end + def test_err assert_raise(ArgumentError) { 1.0 < nil } assert_raise(ArgumentError) { 1.0 < Object.new } |