diff options
Diffstat (limited to 'compar.c')
| -rw-r--r-- | compar.c | 68 |
1 files changed, 47 insertions, 21 deletions
@@ -95,10 +95,13 @@ cmpint(VALUE x, VALUE y) /* * call-seq: - * obj > other -> true or false + * self > other -> true or false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns a value greater than 0. + * Returns whether +self+ is "greater than" +other+; + * equivalent to <tt>(self <=> other) > 0</tt>: + * + * 'foo' > 'foo' # => false + * 'food' > 'foo' # => true */ static VALUE @@ -109,10 +112,15 @@ cmp_gt(VALUE x, VALUE y) /* * call-seq: - * obj >= other -> true or false + * self >= other -> true or false + * + * Returns whether +self+ is "greater than or equal to" +other+; + * equivalent to <tt>(self <=> other) >= 0</tt>: + * + * 'food' >= 'foo' # => true + * 'foo' >= 'foo' # => true + * 'foo' >= 'food' # => false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns a value greater than or equal to 0. */ static VALUE @@ -123,10 +131,14 @@ cmp_ge(VALUE x, VALUE y) /* * call-seq: - * obj < other -> true or false + * self < other -> true or false + * + * Returns whether +self+ is "less than" +other+; + * equivalent to <tt>(self <=> other) < 0</tt>: + * + * 'foo' < 'foo' # => false + * 'foo' < 'food' # => true * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns a value less than 0. */ static VALUE @@ -137,10 +149,15 @@ cmp_lt(VALUE x, VALUE y) /* * call-seq: - * obj <= other -> true or false + * self <= other -> true or false + * + * Returns whether +self+ is "less than or equal to" +other+; + * equivalent to <tt>(self <=> other) <= 0</tt>: + * + * 'foo' <= 'foo' # => true + * 'foo' <= 'food' # => true + * 'food' <= 'foo' # => false * - * Compares two objects based on the receiver's <code><=></code> - * method, returning true if it returns a value less than or equal to 0. */ static VALUE @@ -187,6 +204,12 @@ cmp_between(VALUE x, VALUE min, VALUE max) * 'd'.clamp('a', 'f') #=> 'd' * 'z'.clamp('a', 'f') #=> 'f' * + * If _min_ is +nil+, it is considered smaller than _obj_, + * and if _max_ is +nil+, it is considered greater than _obj_. + * + * -20.clamp(0, nil) #=> 0 + * 523.clamp(nil, 100) #=> 100 + * * In <code>(range)</code> form, returns _range.begin_ if _obj_ * <code><=></code> _range.begin_ is less than zero, _range.end_ * if _obj_ <code><=></code> _range.end_ is greater than zero, and @@ -257,25 +280,28 @@ cmp_clamp(int argc, VALUE *argv, VALUE x) * <code>==</code>, <code>>=</code>, and <code>></code>) and the * method <code>between?</code>. * - * class SizeMatters + * class StringSorter * include Comparable + * * attr :str * def <=>(other) * str.size <=> other.str.size * end + * * def initialize(str) * @str = str * end + * * def inspect * @str * end * end * - * s1 = SizeMatters.new("Z") - * s2 = SizeMatters.new("YY") - * s3 = SizeMatters.new("XXX") - * s4 = SizeMatters.new("WWWW") - * s5 = SizeMatters.new("VVVVV") + * s1 = StringSorter.new("Z") + * s2 = StringSorter.new("YY") + * s3 = StringSorter.new("XXX") + * s4 = StringSorter.new("WWWW") + * s5 = StringSorter.new("VVVVV") * * s1 < s2 #=> true * s4.between?(s1, s3) #=> false @@ -284,13 +310,13 @@ cmp_clamp(int argc, VALUE *argv, VALUE x) * * == What's Here * - * \Module \Comparable provides these methods, all of which use method <tt><=></tt>: + * Module \Comparable provides these methods, all of which use method <tt>#<=></tt>: * * - #<: Returns whether +self+ is less than the given object. * - #<=: Returns whether +self+ is less than or equal to the given object. * - #==: Returns whether +self+ is equal to the given object. - * - #>: Returns whether +self+ is greater than or equal to the given object. - * - #>=: Returns whether +self+ is greater than the given object. + * - #>: Returns whether +self+ is greater than the given object. + * - #>=: Returns whether +self+ is greater than or equal to the given object. * - #between?: Returns +true+ if +self+ is between two given objects. * - #clamp: For given objects +min+ and +max+, or range <tt>(min..max)</tt>, returns: * |