Comparable

Comparable模块

可比较的mixin被其对象可能被排序的类使用。该类必须定义<=>运算符，该运算符将接收方与另一个对象进行比较，根据接收方是否小于，等于或大于另一个对象返回-1,0或+1。如果另一个对象不可比较，则<=>运算符应该返回nil。可比较使用<=>来实现传统的比较运算符（<，<=，==，> =和>）和？之间的方法。

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

公共实例方法

obj < other → true or false Show source

根据接收方的<=>方法比较两个对象，如果返回-1，则返回true。

static VALUE
cmp_lt(VALUE x, VALUE y)
{
    if (cmpint(x, y) < 0) return Qtrue;
    return Qfalse;
}

obj <= other → true or false Show source

根据接收方的<=>方法比较两个对象，如果返回-1或0，则返回true。

static VALUE
cmp_le(VALUE x, VALUE y)
{
    if (cmpint(x, y) <= 0) return Qtrue;
    return Qfalse;
}

obj == other → true or false Show source

根据接收方的<=>方法比较两个对象，如果它返回0则返回true。如果obj和其他对象是相同的，则返回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;
    if (rb_cmpint(c, x, y) == 0) return Qtrue;
    return Qfalse;
}

obj > other → true or false Show source

根据接收方的<=>方法比较两个对象，如果返回1，则返回true。

static VALUE
cmp_gt(VALUE x, VALUE y)
{
    if (cmpint(x, y) > 0) return Qtrue;
    return Qfalse;
}

obj >= other → true or false Show source

根据接收方的<=>方法比较两个对象，如果返回0或1，则返回true。

static VALUE
cmp_ge(VALUE x, VALUE y)
{
    if (cmpint(x, y) >= 0) return Qtrue;
    return Qfalse;
}

between?(min, max) → true or false Show source

如果obj <=> min小于零或者anObject <=> 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)
{
    if (cmpint(x, min) < 0) return Qfalse;
    if (cmpint(x, max) > 0) return Qfalse;
    return Qtrue;
}

clamp(min, max) → obj Show source

如果obj <=> min小于零，则返回min，如果obj <=> 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'

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;
}