Iterator::Base (Class)

In: iterator.rb
Parent: Object

Base class which all iterators should derive from. It includes Ruby’s Enumerable module.

All iterators are able to move forward. However not all iterators are capable of moving backward. For instance Iterator::Continuation are forward-only.

Methods

<=>   close   current   current=   current_prev   current_prev=   each   first   has_next?   has_prev?   last   next   next1   position   prev   prev1   reverse   reverse_each  

Included Modules

Enumerable Comparable

Public Instance methods

<=>(other)

compare positions

close()

remember to close the door after us.

current()

return that element we are currently pointing at

current=(value)

overwrite that element we are currently pointing at

current_prev()

return that element we are currently pointing at - 1

current_prev=(value)

overwrite that element we are currently pointing at - 1

each() {|current| ...}

reset iterator at first element, and move forward until last-element has been reached.

first()

Reset iterator, so that it points to the first element This method are suppose to return self.

has_next?()

can we move one step forward

has_prev?()

can we move one step forward

last()

Reset iterator, so that it points to the last element This method are suppose to return self.

next(n=1)

Move n steps forward. This method are suppose to return self.

next1()

move one step forward

position()

return the current position

prev(n=1)

Move n steps backwards. This method are suppose to return self.

prev1()

move one step backwards

reverse()

create an iterator which moves the opposite direction.

remember to invoke close when you are done.

reverse_each() {|current| ...}

reset iterator at last element, and move backwards until first-element has been reached.

[Validate]