# L'interface Sequence

(PECL ds >= 1.0.0)

## Introduction

Une Sequence décrit le comportement des valeurs disposées dans une seule dimension linéaire. Certains langages se réfèrent à cela comme une "Liste". C'est similaire à un tableau qui utilise des clés entières incrémentales, à l'exception de quelques caractéristiques :

- Les valeurs seront toujours indexées comme [0, 1, 2, …, size - 1].
- Seuls les valeurs par index dans la plage [0, size - 1] sont autorisées.

Cas d'utilisation :

- Partout où vous utiliseriez un tableau en tant que liste (sans se soucier des clés).
- Une alternative plus efficace à SplDoublyLinkedList et SplFixedArray.

## Sommaire de l'Interface

interface Ds\Sequence extends Ds\Collection, ArrayAccess {
/* Méthodes */
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
/* Méthodes héritées */
public Ds\Collection::clear(): void
public Ds\Collection::copy(): Ds\Collection
public Ds\Collection::isEmpty(): bool
public Ds\Collection::toArray(): array
public Countable::count(): int
public IteratorAggregate::getIterator(): Traversable
public JsonSerializable::jsonSerialize(): mixed
public ArrayAccess::offsetExists(mixed `$offset`): bool
public ArrayAccess::offsetGet(mixed `$offset`): mixed
public ArrayAccess::offsetSet(mixed `$offset`, mixed `$value`): void
public ArrayAccess::offsetUnset(mixed `$offset`): void
}

## Historique

Version | Description
--- | ---
PECL ds 1.3.0 | Cette interface étend maintenant ArrayAccess.

## Sommaire

- Ds\Sequence::allocate — Alloue suffisamment de mémoire pour une capacité requise
- Ds\Sequence::apply — Met à jour toutes les valeurs en appliquant une fonction de rappel à chaque valeur
- Ds\Sequence::capacity — Renvoie la capacité actuelle
- Ds\Sequence::contains — Détermine si la séquence contient des valeurs données
- Ds\Sequence::filter — Créer une nouvelle séquence en utilisant un callable pour déterminer quelles valeurs inclure
- Ds\Sequence::find — Essaye de trouver l'index d'une valeur
- Ds\Sequence::first — Renvoie la première valeur de la séquence
- Ds\Sequence::get — Renvoie la valeur à un index donné
- Ds\Sequence::insert — Insère des valeurs à un index donné
- Ds\Sequence::join — Rassemble toutes les valeurs en une chaîne
- Ds\Sequence::last — Renvoie la dernière valeur
- Ds\Sequence::map — Renvoie le résultat de l'application d'une fonction de rappel à chaque valeur
- Ds\Sequence::merge — Renvoie le résultat de l'ajout de toutes les valeurs de la séquence
- Ds\Sequence::pop — Supprime et renvoie la dernière valeur
- Ds\Sequence::push — Ajoute des valeurs à la fin de la séquence
- Ds\Sequence::reduce — Reduit la séquence à une seule valeur en utilisant une fonction de rappel
- Ds\Sequence::remove — Supprime et renvoie une valeur par index
- Ds\Sequence::reverse — Renverse la séquence en place
- Ds\Sequence::reversed — Renvoie une copie renversée
- Ds\Sequence::rotate — Tourne la séquence d'un nombre donné de rotations
- Ds\Sequence::set — Met à jour une valeur à un index donné
- Ds\Sequence::shift — Supprime et renvoie la première valeur
- Ds\Sequence::slice — Renvoie une sous-séquence d'une plage donnée
- Ds\Sequence::sort — Trie la séquence en place
- Ds\Sequence::sorted — Renvoie une copie triée
- Ds\Sequence::sum — Renvoie la somme de toutes les valeurs de la séquence
- Ds\Sequence::unshift — Ajoute des valeurs au début de la séquence