The Sequence interface

(No version information available, might only be in Git)

Introduction

A Sequence describes the behaviour of values arranged in a single, linear dimension. Some languages refer to this as a "List". It’s similar to an array that uses incremental integer keys, with the exception of a few characteristics:

Values will always be indexed as [0, 1, 2, …, size - 1].
Only allowed to access values by index in the range [0, size - 1].

Use cases:

Wherever you would use an array as a list (not concerned with keys).
A more efficient alternative to SplDoublyLinkedList and SplFixedArray.

Interface synopsis

Ds\Sequence implements Ds\Collection {

/* Methods */

abstract public void allocate ( int $capacity )

abstract public void apply ( callable $callback )

abstract public int capacity ( void )

abstract public bool contains ([ mixed $...values ] )

abstract public Ds\Sequence filter ([ callable $callback ] )

abstract public mixed find ( mixed $value )

abstract public mixed first ( void )

abstract public mixed get ( int $index )

abstract public void insert ( int $index [, mixed $...values ] )

abstract public string join ([ string $glue ] )

abstract public mixed last ( void )

abstract public Ds\Sequence map ( callable $callback )

abstract public Ds\Sequence merge ( mixed $values )

abstract public mixed pop ( void )

abstract public void push ([ mixed $...values ] )

abstract public mixed reduce ( callable $callback [, mixed $initial ] )

abstract public mixed remove ( int $index )

abstract public void reverse ( void )

abstract public Ds\Sequence reversed ( void )

abstract public void rotate ( int $rotations )

abstract public void set ( int $index , mixed $value )

abstract public mixed shift ( void )

abstract public Ds\Sequence slice ( int $index [, int $length ] )

abstract public void sort ([ callable $comparator ] )

abstract public Ds\Sequence sorted ([ callable $comparator ] )

abstract public number sum ( void )

abstract public void unshift ([ mixed $values ] )

}

Ds\Sequence::allocate — Allocates enough memory for a required capacity
Ds\Sequence::apply — Updates all values by applying a callback function to each value
Ds\Sequence::capacity — Returns the current capacity
Ds\Sequence::contains — Determines if the sequence contains given values
Ds\Sequence::filter — Creates a new sequence using a callable to determine which values to include
Ds\Sequence::find — Attempts to find a value's index
Ds\Sequence::first — Returns the first value in the sequence
Ds\Sequence::get — Returns the value at a given index
Ds\Sequence::insert — Inserts values at a given index
Ds\Sequence::join — Joins all values together as a string
Ds\Sequence::last — Returns the last value
Ds\Sequence::map — Returns the result of applying a callback to each value
Ds\Sequence::merge — Returns the result of adding all given values to the sequence
Ds\Sequence::pop — Removes and returns the last value
Ds\Sequence::push — Adds values to the end of the sequence
Ds\Sequence::reduce — Reduces the sequence to a single value using a callback function
Ds\Sequence::remove — Removes and returns a value by index
Ds\Sequence::reverse — Reverses the sequence in-place
Ds\Sequence::reversed — Returns a reversed copy
Ds\Sequence::rotate — Rotates the sequence by a given number of rotations
Ds\Sequence::set — Updates a value at a given index
Ds\Sequence::shift — Removes and returns the first value
Ds\Sequence::slice — Returns a sub-sequence of a given range
Ds\Sequence::sort — Sorts the sequence in-place
Ds\Sequence::sorted — Returns a sorted copy
Ds\Sequence::sum — Returns the sum of all values in the sequence
Ds\Sequence::unshift — Adds values to the front of the sequence

The Sequence interface

Introduction

Interface synopsis

Table of Contents