module Comparable

要約

比較演算を許すクラスのための Mix-in です。このモジュールをインクルードするクラスは、基本的な比較演算子である <=> 演算子を定義している必要があります。

self <=> other は

self が other より大きいなら正の整数
self と other が等しいなら 0
self が other より小さいなら負の整数
self と other が比較できない場合は nil

をそれぞれ返すことが期待されています。

他の比較演算子は、 <=> 演算子を利用して定義されます。

インスタンスメソッド

self < other -> bool[permalink][rdoc]

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が負の整数を返した場合に、true を返します。それ以外の整数を返した場合に、false を返します。

[PARAM] other:: 自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:: <=> が nil を返したときに発生します。

例

1 < 1   # => false
1 < 2   # => true

self <= other -> bool[permalink][rdoc]

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が負の整数か 0 を返した場合に、true を返します。それ以外の整数を返した場合に、false を返します。

[PARAM] other:: 自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:: <=> が nil を返したときに発生します。

例

1 <= 0   # => false
1 <= 1   # => true
1 <= 2   # => true

self == other -> bool[permalink][rdoc]

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が 0 を返した時に、true を返します。それ以外を返した場合は、false を返します。

[PARAM] other:: 自身と比較したいオブジェクトを指定します。

例

1 == 1   # => true
1 == 2   # => false

self > other -> bool[permalink][rdoc]

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が正の整数を返した場合に、true を返します。それ以外の整数を返した場合に、false を返します。

[PARAM] other:: 自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:: <=> が nil を返したときに発生します。

例

1 > 0   # => true
1 > 1   # => false

self >= other -> bool[permalink][rdoc]

比較演算子 <=> をもとにオブジェクト同士を比較します。 <=> が正の整数か 0 を返した場合に、true を返します。それ以外の整数を返した場合に、false を返します。

[PARAM] other:: 自身と比較したいオブジェクトを指定します。
[EXCEPTION] ArgumentError:: <=> が nil を返したときに発生します。

例

1 >= 0   # => true
1 >= 1   # => true
1 >= 2   # => false

between?(min, max) -> bool[permalink][rdoc]

比較演算子 <=> をもとに self が min と max の範囲内(min, max を含みます)にあるかを判断します。

以下のコードと同じです。


self >= min and self <= max

[PARAM] min:: 範囲の下端を表すオブジェクトを指定します。
[PARAM] max:: 範囲の上端を表すオブジェクトを指定します。
[EXCEPTION] ArgumentError:: self <=> min か、self <=> max が nil を返したときに発生します。

例

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

clamp(min, max) -> object[permalink][rdoc]

self を範囲内に収めます。

self <=> min が負数を返したときは min を、 self <=> max が正数を返したときは max を、それ以外の場合は self を返します。

例:

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'

module Comparable

要約

目次

インスタンスメソッド