<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The Sequence interface</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-hashable.hash.html">Ds\Hashable::hash</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-sequence.allocate.html">Ds\Sequence::allocate</a></div>
<div class="up"><a href="book.ds.html">Data Structures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.ds-sequence" class="reference">
<h1 class="title">The Sequence interface</h1>
<div class="partintro"><p class="verinfo">(No version information available, might only be in Git)</p>
<div class="section" id="ds-sequence.intro">
<h2 class="title">Introduction</h2>
<p class="para">
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:
<ul class="simplelist">
<li class="member">Values will always be indexed as [0, 1, 2, …, size - 1].</li>
<li class="member">Only allowed to access values by index in the range [0, size - 1].</li>
</ul>
</p>
<p class="para">
Use cases:
<ul class="simplelist">
<li class="member">Wherever you would use an array as a list (not concerned with keys).</li>
<li class="member">A more efficient alternative to
<a href="class.spldoublylinkedlist.html" class="classname">SplDoublyLinkedList</a> and
<a href="class.splfixedarray.html" class="classname">SplFixedArray</a>.
</li>
</ul>
</p>
</div>
<div class="section" id="ds-sequence.synopsis">
<h2 class="title">Interface synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass"><strong class="classname">Ds\Sequence</strong></span>
<span class="oointerface">implements <span class="interfacename"><strong class="interfacename">Ds\Collection</strong></span></span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.allocate.html" class="methodname">allocate</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$capacity</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.apply.html" class="methodname">apply</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="ds-sequence.capacity.html" class="methodname">capacity</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="ds-sequence.contains.html" class="methodname">contains</a></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...values</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.filter.html" class="methodname">filter</a></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.find.html" class="methodname">find</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.first.html" class="methodname">first</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.get.html" class="methodname">get</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.insert.html" class="methodname">insert</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...values</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="ds-sequence.join.html" class="methodname">join</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$glue</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.last.html" class="methodname">last</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.map.html" class="methodname">map</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.merge.html" class="methodname">merge</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$values</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.pop.html" class="methodname">pop</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.push.html" class="methodname">push</a></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$...values</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.reduce.html" class="methodname">reduce</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$initial</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.remove.html" class="methodname">remove</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.reverse.html" class="methodname">reverse</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.reversed.html" class="methodname">reversed</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.rotate.html" class="methodname">rotate</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$rotations</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.set.html" class="methodname">set</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="ds-sequence.shift.html" class="methodname">shift</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.slice.html" class="methodname">slice</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$length</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.sort.html" class="methodname">sort</a></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$comparator</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Ds\Sequence</span> <span class="methodname"><a href="ds-sequence.sorted.html" class="methodname">sorted</a></span>
([ <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$comparator</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">number</span> <span class="methodname"><a href="ds-sequence.sum.html" class="methodname">sum</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-sequence.unshift.html" class="methodname">unshift</a></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$values</code></span>
] )</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="ds-sequence.allocate.html">Ds\Sequence::allocate</a> — Allocates enough memory for a required capacity</li><li><a href="ds-sequence.apply.html">Ds\Sequence::apply</a> — Updates all values by applying a callback function to each value</li><li><a href="ds-sequence.capacity.html">Ds\Sequence::capacity</a> — Returns the current capacity</li><li><a href="ds-sequence.contains.html">Ds\Sequence::contains</a> — Determines if the sequence contains given values</li><li><a href="ds-sequence.filter.html">Ds\Sequence::filter</a> — Creates a new sequence using a callable to
determine which values to include</li><li><a href="ds-sequence.find.html">Ds\Sequence::find</a> — Attempts to find a value's index</li><li><a href="ds-sequence.first.html">Ds\Sequence::first</a> — Returns the first value in the sequence</li><li><a href="ds-sequence.get.html">Ds\Sequence::get</a> — Returns the value at a given index</li><li><a href="ds-sequence.insert.html">Ds\Sequence::insert</a> — Inserts values at a given index</li><li><a href="ds-sequence.join.html">Ds\Sequence::join</a> — Joins all values together as a string</li><li><a href="ds-sequence.last.html">Ds\Sequence::last</a> — Returns the last value</li><li><a href="ds-sequence.map.html">Ds\Sequence::map</a> — Returns the result of applying a callback to each value</li><li><a href="ds-sequence.merge.html">Ds\Sequence::merge</a> — Returns the result of adding all given values to the sequence</li><li><a href="ds-sequence.pop.html">Ds\Sequence::pop</a> — Removes and returns the last value</li><li><a href="ds-sequence.push.html">Ds\Sequence::push</a> — Adds values to the end of the sequence</li><li><a href="ds-sequence.reduce.html">Ds\Sequence::reduce</a> — Reduces the sequence to a single value using a callback function</li><li><a href="ds-sequence.remove.html">Ds\Sequence::remove</a> — Removes and returns a value by index</li><li><a href="ds-sequence.reverse.html">Ds\Sequence::reverse</a> — Reverses the sequence in-place</li><li><a href="ds-sequence.reversed.html">Ds\Sequence::reversed</a> — Returns a reversed copy</li><li><a href="ds-sequence.rotate.html">Ds\Sequence::rotate</a> — Rotates the sequence by a given number of rotations</li><li><a href="ds-sequence.set.html">Ds\Sequence::set</a> — Updates a value at a given index</li><li><a href="ds-sequence.shift.html">Ds\Sequence::shift</a> — Removes and returns the first value</li><li><a href="ds-sequence.slice.html">Ds\Sequence::slice</a> — Returns a sub-sequence of a given range</li><li><a href="ds-sequence.sort.html">Ds\Sequence::sort</a> — Sorts the sequence in-place</li><li><a href="ds-sequence.sorted.html">Ds\Sequence::sorted</a> — Returns a sorted copy</li><li><a href="ds-sequence.sum.html">Ds\Sequence::sum</a> — Returns the sum of all values in the sequence</li><li><a href="ds-sequence.unshift.html">Ds\Sequence::unshift</a> — Adds values to the front of the sequence</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ds-hashable.hash.html">Ds\Hashable::hash</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ds-sequence.allocate.html">Ds\Sequence::allocate</a></div>
<div class="up"><a href="book.ds.html">Data Structures</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
