модуль Comparable

Mixin Comparable используется классами, объекты которых могут быть упорядочены. Класс должен определить оператор <=>, который сравнивает получатель с другим объектом, возвращая значение меньше 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 предоставляет следующие методы, все из которых используют метод <=>:

<: Возвращает true, если self меньше данного объекта.
<=: Возвращает true, если self меньше или равно данному объекту.
==: Возвращает true, если self равен данному объекту.
>: Возвращает true, если self больше данного объекта.
>=: Возвращает true, если self больше или равно данному объекту.
between?: Возвращает true, если self находится между двумя заданными объектами.
clamp: Для заданных объектов min и max, или диапазона (min..max), возвращает:
- min если (self <=> min) < 0.
- max если (self <=> max) > 0.
- self в противном случае.

Общедоступные методы экземпляров

obj < other → true или false

Исходный код

static VALUE
cmp_lt(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) < 0);
}

Сравнивает два объекта на основе метода <=> получателя, возвращая true, если он возвращает значение меньше 0.

obj <= other → true или false

Исходный код

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

Сравнивает два объекта на основе метода <=> получателя, возвращая true, если он возвращает значение меньше или равно 0.

obj == other → true или false

Исходный код

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

Сравнивает два объекта на основе метода <=> получателя, возвращая true, если он возвращает 0. Также возвращает true, если obj и other — один и тот же объект.

obj > other → true или false

Исходный код

static VALUE
cmp_gt(VALUE x, VALUE y)
{
    return RBOOL(cmpint(x, y) > 0);
}

Сравнивает два объекта на основе метода <=> получателя, возвращая true, если он возвращает значение больше 0.

obj >= other → true или false

Исходный код

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

Сравнивает два объекта на основе метода <=> получателя, возвращая true, если он возвращает значение больше или равно 0.

between?(min, max) → true или false

Исходный код

static VALUE
cmp_between(VALUE x, VALUE min, VALUE max)
{
    return RBOOL((cmpint(x, min) >= 0 && cmpint(x, max) <= 0));
}

Возвращает true, если obj <=> min меньше нуля или если obj <=> max больше нуля, true в противном случае.

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

clamp(min, max) → obj

clamp(range) → obj

Исходный код

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

В форме с двумя параметрами возвращает min, если obj <=> min меньше нуля, max, если 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'

Если min — nil, оно считается меньше obj, а если max — nil, оно считается больше obj.

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

В форме с одним параметром, диапазоном, возвращает range.begin, если obj <=> range.begin меньше нуля, range.end, если obj <=> 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

Ruby Core © 1993–2024 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.