Class: Interval

[]( *args )

new(first, last, exclude_first=false, exclude_last=false )

+@()

Unary shorthands. These return a new interval exclusive of first, last or both sentinels, repectively.

-@()

===(x)

Alias for include?

begin()

Alias for first

closed()

Returns a new interval inclusive of of both sentinels.

degenerate?()

Returns true if the start and end sentinels are equal and the interval is closed; otherwise false.

direction()

Returns the direction of the interval indicated by +1, 0 or -1.

  (1..5).direction  #=> 1
  (5..1).direction  #=> -1
  (1..1).direction  #=> 0

distance()

Returns the length of the interval as the difference between the first and last elements. Returns nil if the sentinal objects do not support distance comparison (distance). TODO: Add n parameter to count segmentations like those produced by each.

each(n=1, d=nil) {|| ...}

Iterates over the interval, passing each _n_th element to the block. If n is not given then n defaults to 1. Each _n_th step is determined by invoking +++ or +\-+ n, depending on the direction of the interval. If n is negative the iteration is preformed in reverse form end sentinal to front sentinal. A second parameter, d, can be given in which case the applied step is calculated as a fraction of the interval’s length times n / d. This allows iteration over the whole interval in equal sized segments.

  1..5.each { |e| ... }        #=> 1 2 3 4 5
  1..5.each(2) { |e| ... }     #=> 1 3 5
  1..5.each(1,2) { |e| ... }   #=> 1.0 1.5 2.0 2.5 3.0 3.5 4.0 4.5 5.0

end()

Alias for last

eql?(other)

Compares two intervals to see if they are equal

exclude_begin?()

Alias for exclude_first?

exclude_end?()

Alias for exclude_last?

exclude_first?()

exclude_last?()

first()

Returns the first or last sentinal of the interval.

first_closed()

Returns a new interval with one of the two sentinels opened or closed

first_opened()

half_closed(e=false)

Returns a new interval with either the first or the last sentinel exclusive. If the parameter is false, the deafult, then the first sentinel is excluded; if the parameter is true, the last sentinel is excluded.

include?(x)

Returns true or false if the element is part of the interval.

last()

last_closed()

last_opened()

length()

Alias for distance

max()

Returns the greater of the first and last sentinals.

member?(x)

Alias for include?

min()