instance method Comparable#clamp

self を範囲内に収めます。

min と max の2つの引数が渡された場合は次のようになります。 self <=> min が負数を返したときは min を、 self <=> max が正数を返したときは max を、それ以外の場合は self を返します。

range が1つ渡された場合は次のようになります。 self <=> range.begin が負数を返したときは range.begin を、 self <=> range.end が正数を返したときは range.end を、それ以外の場合は self を返します。

range.begin が nil の場合、range.begin は self よりも小さい値として扱われます。 range.end が nil の場合、range.end は self よりも大きい値として扱われます。

[PARAM] min:

範囲の下端を表すオブジェクトを指定します。

[PARAM] max:

範囲の上端を表すオブジェクトを指定します。

[PARAM] range:

範囲を表す Range オブジェクトを指定します。

[EXCEPTION] ArgumentError:

rangeが終端を含まない範囲オブジェクトであり、終端が nil でないときに発生します。

例

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 を渡す例

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'

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

range の始端か終端が nil の場合

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