include

2007-01-10T08:45:00Z

include(value) -> Boolean

Determines whether the value is included in the range.

This assumes the values in the range have a valid strict weak ordering (have valid semantics for the < operator). While ObjectRange mixes in Enumerable, this method overrides the default version of include, and is way more efficient (it uses a maximum of two comparisons).

Examples


$R(1, 10).include(5)
// -> true

$R('a', 'h').include('x')
// -> false

$R(1, 10).include(10)
// -> true

$R(1, 10, true).include(10)
// -> false

ObjectRange

2007-01-06T19:00:00Z

Ranges represent an interval of values. The value type just needs to be “compatible,” that is, to implement a succ method letting us step from one value to the next (its successor).

Prototype provides such a method for Number and String, but you are of course welcome to implement useful semantics in your own objects, in order to enable ranges based on them.

ObjectRange mixes in Enumerable, which makes ranges very versatile. It takes care, however, to override the default code for include, to achieve better efficiency.

While ObjectRange does provide a constructor, the preferred way to obtain a range is to use the $R utility function, which is strictly equivalent (only way more concise to use).

Examples

The most common use of ranges is, undoubtedly, numerical:


$A($R(1, 5)).join(', ')
// -> '1, 2, 3, 4, 5'

$R(1, 5).zip(['one', 'two', 'three', 'four', 'five'], function(tuple) {
  return tuple.join(' = ');
})
// -> ['1 = one', '2 = two', '3 = three', '4 = four', '5 = five']

Be careful with String ranges: as described in its succ method, it does not use alphabetical boundaries, but goes all the way through the character table:


$A($R('a', 'e'))
// -> ['a', 'b', 'c', 'd', 'e'], no surprise there

$A($R('ax', 'ba'))
// -> Ouch!  Humongous array, starting as ['ax', 'ay', 'az', 'a{', 'a|', 'a}', 'a~'...]

Prototype JavaScript framework - ObjectRange

include

Examples

ObjectRange

Examples