list

class List < Object

The List class is a linked list. It is not addressable by index, but has the property of fast insertions and deletions.

Public Methods

self.[](*array)

Create a list

initialize(*array)

Create a list

push(elem)

Add a new element to the end of the list.

elem	The element to push.

Returns: self.

pop

Remove an element from the end of the list.

Returns: the element that was removed, or nil if the list was empty.

shift

Remove an element from the beginning of the list.

Returns: the element that was removed, or nil if the list was empty.

unshift(elem)

Insert a new element at the end of the list.

element	the element to insert.

Returns: self.

dup

Create a shallow copy of the list.

Returns: the new list.

each

Iterate through all the elements of the list.

Returns: the last return value fromt the block given.

reverse_each

Iterate through all the elements of the list in reverse order.

Returns: the last return value fromt the block given.

reverse

Create a shallow copy of the list, with its elements in reverse order.

Returns: the new list.

first

Retrieve the first element from the list.

Returns: the first element of the list.

last

Retrieve the last element of the list.

Returns: the last element of the list.

to_s

Convert the list to a string.

Returns: a string representation of this list.

to_a

Convert the list to an array.

Returns: a new array holding references to the elements of the list.

clear()

Clear the list.

Returns: self.

<=>(other)

Compare this array to another container. The other container must have the "each" method defined.

Returns: -1 if the list compares less than the other container, 1 if the list compares greater than the other container, or 0 if the containers compare equal.

Mixins

Enumerable
EnumerableContainer
SingleEnumerableContainer
SingleUpdatableContainer

Requires