модуль Comparable
Миксин 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 предоставляет следующие методы, каждый из которых использует метод <=>:
-
<: возвращает, меньше лиselfуказанного объекта. -
<=: возвращает, меньше лиselfуказанного объекта или равно ему. -
==: возвращает, равен лиselfуказанному объекту. -
>: возвращает, больше лиselfуказанного объекта. -
>=: возвращает, больше лиselfуказанного объекта или равно ему. -
between?: возвращаетtrue, еслиselfнаходится между двумя заданными объектами. -
clamp: для заданных объектовminиmaxлибо диапазона(min..max)возвращает:-
min, если(self <=> min) < 0. -
max, если(self <=> max) > 0. -
selfв противном случае.
-
Открытые методы экземпляра
static VALUE
cmp_lt(VALUE x, VALUE y)
{
return RBOOL(cmpint(x, y) < 0);
} Возвращает, является ли self «меньше чем» other; эквивалентно (self <=> other) < 0:
'foo' < 'foo' # => false 'foo' < 'food' # => true
static VALUE
cmp_le(VALUE x, VALUE y)
{
return RBOOL(cmpint(x, y) <= 0);
} Возвращает, является ли self «меньше или равно» other; эквивалентно (self <=> other) <= 0:
'foo' <= 'foo' # => true 'foo' <= 'food' # => true 'food' <= 'foo' # => 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 являются одним и тем же объектом.
static VALUE
cmp_gt(VALUE x, VALUE y)
{
return RBOOL(cmpint(x, y) > 0);
} Сравнивает два объекта на основе метода <=> принимающего объекта и возвращает true, если метод возвращает значение больше 0.
static VALUE
cmp_ge(VALUE x, VALUE y)
{
return RBOOL(cmpint(x, y) >= 0);
} Сравнивает два объекта на основе метода <=> принимающего объекта и возвращает true, если метод возвращает значение больше или равное 0.
static VALUE
cmp_between(VALUE x, VALUE min, VALUE max)
{
return RBOOL((cmpint(x, min) >= 0 && cmpint(x, max) <= 0));
} Возвращает false, если 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
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, max) возвращает 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) возвращает 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
Если конец диапазона исключён и не nil, возникает исключение.
100.clamp(0...100) # ArgumentError
Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.