Класс Map

(Информация о версии неизвестна, возможно, только в SVN)

Введение

Коллекция пар - это последовательная коллекция, содержащая пары ключ/значение, практически идентичная массиву и используется для тех же целей. Ключи могут быть любого типа, но должны быть уникальными. Если добавить пару с уже существующим ключем, то она будет заменена.

Сильный стороны

Ключи и значения могут быть любого типа, включая объекты.
Поддерживает синтаксис массива (квадратные скобки).
Сохраняется порядок вставки.
Скорость и потребление памяти сравнимо с использованием массива.
Автоматически высвобождает память, когда количество элементов уменхается.

Слабые стороны

Не может быть сконвертирована в массив, если в качестве ключей используются объекты.

Обзор классов

Ds\Map implements Ds\Collection {

/* Константы */

const int MIN_CAPACITY = 16 ;

/* Методы */

public void allocate ( int $capacity )

public void apply ( callable $callback )

public int capacity ( void )

public void clear ( void )

public Ds\Map copy ( void )

public Ds\Map diff ( Ds\Map $map )

public Ds\Map filter ([ callable $callback ] )

public Ds\Pair first ( void )

public mixed get ( mixed $key [, mixed $default ] )

public bool hasKey ( mixed $key )

public bool hasValue ( mixed $value )

public Ds\Map intersect ( Ds\Map $map )

public bool isEmpty ( void )

public Ds\Set keys ( void )

public void ksort ([ callable $comparator ] )

public Ds\Map ksorted ([ callable $comparator ] )

public Ds\Pair last ( void )

public Ds\Map map ( callable $callback )

public Ds\Map merge ( mixed $values )

public Ds\Sequence pairs ( void )

public void put ( mixed $key , mixed $value )

public void putAll ( mixed $pairs )

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

public mixed remove ( mixed $key [, mixed $default ] )

public void reverse ( void )

public Ds\Map reversed ( void )

public Ds\Pair skip ( int $position )

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

public void sort ([ callable $comparator ] )

public Ds\Map sorted ([ callable $comparator ] )

public number sum ( void )

public array toArray ( void )

public Ds\Map union ( Ds\Map $map )

public Ds\Sequence values ( void )

public Ds\Map xor ( Ds\Map $map )

}

Предопределенные константы

Ds\Map::MIN_CAPACITY

Содержание

Ds\Map::allocate — Выделяет необходимое количество памяти, под требуюмую вместимость
Ds\Map::apply — Обновление всех значений применением к ним переданной callback-функции
Ds\Map::capacity — Возвращает текущую вместимость
Ds\Map::clear — Удаляет все значения из коллекции
Ds\Map::__construct — Создает новый экземпляр класса
Ds\Map::copy — Возвращает поверхностную копию коллекции
Ds\Map::count — Возвращает количество элементов коллекции
Ds\Map::diff — Создает новую коллекцию пар с элементами, ключей которых нет в другой коллекции пар
Ds\Map::filter — Создает новую коллекцию пар из элементов, выбранных с помощью заданной callback-функции
Ds\Map::first — Возвращает первый элемент коллекции
Ds\Map::get — Возвращает значение по ключу
Ds\Map::hasKey — Проверяет, содержит ли коллекция заданный ключ
Ds\Map::hasValue — Проверяет, содержит ли коллекция заданное значение
Ds\Map::intersect — Создает новую коллекцию пар, созданную пересечением с другой коллекцией пар
Ds\Map::isEmpty — Проверяет, пуста ли коллекция
Ds\Map::jsonSerialize — Возвращает коллекцию в JSON представлении
Ds\Map::keys — Возвращает набор ключей коллекции
Ds\Map::ksort — Сортирует текущую коллекцию по ключам
Ds\Map::ksorted — Возвращает копию коллекции, отсортированной по ключам
Ds\Map::last — Возвращает последнюю пару коллекции
Ds\Map::map — Возвращает результат применения callback-функции ко всем значениям коллекции
Ds\Map::merge — Возвращает результат добавления всех заданных элементов в коллекцию
Ds\Map::pairs — Возвращает последовательность, содержащую все пары коллекции пар
Ds\Map::put — Установка значения по заданному ключу
Ds\Map::putAll — Вносит в коллекцию все пары ключ/значение из объекта класса traversable или массива
Ds\Map::reduce — Схлопывает коллекцию до одного значения используя callback-функцию
Ds\Map::remove — Удаляет и возвращает значение по ключу
Ds\Map::reverse — Переворачивает текущую коллекцию
Ds\Map::reversed — Возвращает перевернутую копию коллекции
Ds\Map::skip — Возвращает пару по индексу позиции
Ds\Map::slice — Возвращает под-коллекцию из заданного диапазона
Ds\Map::sort — Сортирует коллекцию по значениям
Ds\Map::sorted — Возвращает отсортированную по значению копию коллекции
Ds\Map::sum — Возвращает сумму всех значений коллекции
Ds\Map::toArray — Преобразует коллекцию в array
Ds\Map::union — Создает новую коллекцию пар из элементов двух коллекций
Ds\Map::values — Возвращает последовательность значений коллекции пар
Ds\Map::xor — Создает новую коллекцию пар из элементов, которые есть в одной из коллекций, но не в обеих одновременно