Интерфейс Sequence

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

Введение

Последовательность описывает поведение, при котором значения распределены в одном, линейном порядке. В некоторых языках данное поведение описывается как "List". Это похоже на массив, в котором используются целочисленные ключи, за исключением нескольких моментов:

Значения всегда проиндексированы по порядку [0, 1, 2, …, size - 1].
Можно обращаться только к значениям индексированным в диапазоне [0, size - 1].

В каких случаях используется:

Если вы хотите использовать массив, как список (не обращая внимания на ключи).
Более эффективная альтернатива для SplDoublyLinkedList и SplFixedArray.

Обзор интерфейсов

Ds\Sequence implements Ds\Collection , ArrayAccess {

/* Методы */

abstract public allocate ( int $capacity ) : void

abstract public apply ( callable $callback ) : void

abstract public capacity ( ) : int

abstract public contains ( mixed ...$values ) : bool

abstract public filter ( callable $callback = ? ) : Ds\Sequence

abstract public find ( mixed $value ) : mixed

abstract public first ( ) : mixed

abstract public get ( int $index ) : mixed

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

abstract public join ( string $glue = ? ) : string

abstract public last ( ) : mixed

abstract public map ( callable $callback ) : Ds\Sequence

abstract public merge ( mixed $values ) : Ds\Sequence

abstract public pop ( ) : mixed

abstract public push ( mixed ...$values ) : void

abstract public reduce ( callable $callback , mixed $initial = ? ) : mixed

abstract public remove ( int $index ) : mixed

abstract public reverse ( ) : void

abstract public reversed ( ) : Ds\Sequence

abstract public rotate ( int $rotations ) : void

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

abstract public shift ( ) : mixed

abstract public slice ( int $index , int $length = ? ) : Ds\Sequence

abstract public sort ( callable $comparator = ? ) : void

abstract public sorted ( callable $comparator = ? ) : Ds\Sequence

abstract public sum ( ) : int|float

abstract public unshift ( mixed $values = ? ) : void

}

Список изменений

Версия	Описание
PECL ds 1.3.0	Теперь класс реализует ArrayAccess.

Содержание

Ds\Sequence::allocate — Выделение памяти под указанную вместимость
Ds\Sequence::apply — Обновление всех значений применением к ним переданной callback-функции
Ds\Sequence::capacity — Возвращает текущую вместимость
Ds\Sequence::contains — Проверяет, содержатся ли в коллекции заданные значения
Ds\Sequence::filter — Создает новую последовательность из элементов, выбранных с помощью заданной callback-функции
Ds\Sequence::find — Поиск индекса по значению
Ds\Sequence::first — Возвращает первый элемент коллекции
Ds\Sequence::get — Возвращает значение по индексу
Ds\Sequence::insert — Вставляет значения по указанному индексу
Ds\Sequence::join — Склеивает все значения в строку
Ds\Sequence::last — Возвращает последнее значение коллекции
Ds\Sequence::map — Возвращает результат применения callback-функции ко всем значениям коллекции
Ds\Sequence::merge — Возвращает результат добавления всех заданных значений в коллекцию
Ds\Sequence::pop — Удаляет и возвращает последнее значение
Ds\Sequence::push — Добавляет значения в конец последовательности
Ds\Sequence::reduce — Схлопывает коллекцию до одного значения используя callback-функцию
Ds\Sequence::remove — Удаляет и возвращает значение по индексу
Ds\Sequence::reverse — Переворачивает текущую коллекцию
Ds\Sequence::reversed — Возвращает перевернутую копию коллекции
Ds\Sequence::rotate — Перематывает последовательность на заданное число значений
Ds\Sequence::set — Заменяет значение по указанному индексу
Ds\Sequence::shift — Удаляет и возвращает первое значение
Ds\Sequence::slice — Возвращает под-коллекцию из заданного диапазона
Ds\Sequence::sort — Сортирует коллекцию
Ds\Sequence::sorted — Возвращает отсортированную по значению копию коллекции
Ds\Sequence::sum — Возвращает сумму всех значений коллекции
Ds\Sequence::unshift — Добавляет значения в начало последовательности