Comparable 模块

Comparable mixin 由对象可以排序的类使用。该类必须定义 <=> 运算符，该运算符将接收器与另一个对象进行比较，返回小于 0、返回 0 或返回大于 0 的值，具体取决于接收器是小于、等于还是大于另一个对象。如果另一个对象不可比较，则 <=> 运算符应返回 nil。 Comparable 使用 <=> 来实现常规比较运算符（<、<=、==、>= 和 >）和 between? 方法。

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 = 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
s4.between?(s3, s5)           #=> true
[ s3, s2, s5, s4, s1 ].sort   #=> [Z, YY, XXX, WWWW, VVVVV]

此处内容 ↑

Comparable 模块提供这些方法，所有这些方法都使用 <=> 方法

公共实例方法

obj < other → true 或 false 单击以切换源

根据接收器的 <=> 方法比较两个对象，如果它返回小于 0 的值，则返回 true。

static VALUE
cmp_lt(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) < 0);
}
obj <= other → true 或 false 单击以切换源

根据接收器的 <=> 方法比较两个对象，如果它返回小于或等于 0 的值，则返回 true。

static VALUE
cmp_le(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) <= 0);
}
obj == other → true 或 false 单击以切换源

基于接收器的 <=> 方法比较两个对象，如果返回 0，则返回 true。如果 obj 和 other 是同一对象，也返回 true。

static VALUE
cmp_equal(VALUE x, VALUE y)
{
    VALUE c;
    if (x == y) return Qtrue;

    c = rb_exec_recursive_paired_outer(cmp_eq_recursive, x, y, y);

    if (NIL_P(c)) return Qfalse;
    return RBOOL(rb_cmpint(c, x, y) == 0);
}
obj > other → true 或 false 单击以切换源

基于接收器的 <=> 方法比较两个对象，如果返回大于 0 的值，则返回 true。

static VALUE
cmp_gt(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) > 0);
}
obj >= other → true 或 false 单击以切换源

基于接收器的 <=> 方法比较两个对象，如果返回大于或等于 0 的值，则返回 true。

static VALUE
cmp_ge(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) >= 0);
}
between?(min, max) → true 或 false 单击以切换源

如果 obj <=> min 小于零或如果 obj <=> max 大于零，则返回 false，否则返回 true。

3.between?(1, 5)               #=> true
6.between?(1, 5)               #=> false
'cat'.between?('ant', 'dog')   #=> true
'gnu'.between?('ant', 'dog')   #=> false

static VALUE
cmp_between(VALUE x, VALUE min, VALUE max)
{
    return RBOOL((cmpint(x, min) >= 0 && cmpint(x, max) <= 0));
}
clamp(min, max) → obj 单击以切换源
clamp(range) → obj

在 (min, max) 形式中，如果 obj <=> min 小于零，则返回 min，如果 obj <=> max 大于零，则返回 max，否则返回 obj。

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'

如果 min 为 nil，则认为它小于 obj，如果 max 为 nil，则认为它大于 obj。

-20.clamp(0, nil)           #=> 0
523.clamp(nil, 100)         #=> 100

在 (range) 形式中，如果 obj <=> range.begin 小于零，则返回 range.begin，如果 obj <=> range.end 大于零，则返回 range.end，否则返回 obj。

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'

如果 range.begin 为 nil，则认为它小于 obj，如果 range.end 为 nil，则认为它大于 obj。

-20.clamp(0..)           #=> 0
523.clamp(..100)         #=> 100

当 range.end 被排除且不为 nil 时，将引发异常。

100.clamp(0...100)       # ArgumentError

static VALUE
cmp_clamp(int argc, VALUE *argv, VALUE x)
{
    VALUE min, max;
    int c, excl = 0;

    if (rb_scan_args(argc, argv, "11", &min, &max) == 1) {
        VALUE range = min;
        if (!rb_range_values(range, &min, &max, &excl)) {
            rb_raise(rb_eTypeError, "wrong argument type %s (expected Range)",
                     rb_builtin_class_name(range));
        }
        if (!NIL_P(max)) {
            if (excl) rb_raise(rb_eArgError, "cannot clamp with an exclusive range");
        }
    }
    if (!NIL_P(min) && !NIL_P(max) && cmpint(min, max) > 0) {
        rb_raise(rb_eArgError, "min argument must be less than or equal to max argument");
    }

    if (!NIL_P(min)) {
        c = cmpint(x, min);
        if (c == 0) return x;
        if (c < 0) return min;
    }
    if (!NIL_P(max)) {
        c = cmpint(x, max);
        if (c > 0) return max;
    }
    return x;
}