2016-07-30 10:05:36 +00:00
|
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
|
|
<!-- $Revision$ -->
|
|
|
|
|
|
|
|
|
|
|
|
<phpdoc:classref xml:id="class.ds-sequence" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
|
|
|
2016-08-01 08:15:21 +00:00
|
|
|
|
<title>The Sequence interface</title>
|
|
|
|
|
|
<titleabbrev>Sequence</titleabbrev>
|
2016-07-30 10:05:36 +00:00
|
|
|
|
|
|
|
|
|
|
<partintro>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- {{{ Ds\Sequence intro -->
|
|
|
|
|
|
<section xml:id="ds-sequence.intro">
|
|
|
|
|
|
&reftitle.intro;
|
|
|
|
|
|
<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:
|
|
|
|
|
|
<simplelist>
|
|
|
|
|
|
<member>Values will always be indexed as [0, 1, 2, …, size - 1].</member>
|
|
|
|
|
|
<member>Only allowed to access values by index in the range [0, size - 1].</member>
|
|
|
|
|
|
</simplelist>
|
|
|
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
|
|
|
Use cases:
|
|
|
|
|
|
<simplelist>
|
|
|
|
|
|
<member>Wherever you would use an array as a list (not concerned with keys).</member>
|
|
|
|
|
|
<member>A more efficient alternative to
|
|
|
|
|
|
<classname>SplDoublyLinkedList</classname> and
|
|
|
|
|
|
<classname>SplFixedArray</classname>.
|
|
|
|
|
|
</member>
|
|
|
|
|
|
</simplelist>
|
|
|
|
|
|
</para>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<!-- }}} -->
|
|
|
|
|
|
|
|
|
|
|
|
<section xml:id="ds-sequence.synopsis">
|
2016-08-01 08:15:21 +00:00
|
|
|
|
&reftitle.interfacesynopsis;
|
2016-07-30 10:05:36 +00:00
|
|
|
|
|
|
|
|
|
|
<!-- {{{ Synopsis -->
|
|
|
|
|
|
<classsynopsis>
|
|
|
|
|
|
<ooclass><classname>Ds\Sequence</classname></ooclass>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- {{{ Class synopsis -->
|
|
|
|
|
|
<classsynopsisinfo>
|
|
|
|
|
|
|
2016-08-01 08:15:21 +00:00
|
|
|
|
<ooclass><classname>Ds\Sequence</classname></ooclass>
|
|
|
|
|
|
<oointerface><interfacename>Ds\Collection</interfacename></oointerface>
|
|
|
|
|
|
|
2016-07-30 10:05:36 +00:00
|
|
|
|
</classsynopsisinfo>
|
|
|
|
|
|
<!-- }}} -->
|
|
|
|
|
|
|
|
|
|
|
|
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
|
|
|
|
|
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-sequence')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
|
|
|
|
|
|
</classsynopsis>
|
|
|
|
|
|
<!-- }}} -->
|
|
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</partintro>
|
|
|
|
|
|
|
|
|
|
|
|
&reference.ds.ds.entities.sequence;
|
|
|
|
|
|
|
|
|
|
|
|
</phpdoc:classref>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
|
|
|
|
Local variables:
|
|
|
|
|
|
mode: sgml
|
|
|
|
|
|
sgml-omittag:t
|
|
|
|
|
|
sgml-shorttag:t
|
|
|
|
|
|
sgml-minimize-attributes:nil
|
|
|
|
|
|
sgml-always-quote-attributes:t
|
|
|
|
|
|
sgml-indent-step:1
|
|
|
|
|
|
sgml-indent-data:t
|
|
|
|
|
|
indent-tabs-mode:nil
|
|
|
|
|
|
sgml-parent-document:nil
|
|
|
|
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
|
|
|
|
sgml-exposed-tags:nil
|
|
|
|
|
|
sgml-local-catalogs:nil
|
|
|
|
|
|
sgml-local-ecat-files:nil
|
|
|
|
|
|
End:
|
|
|
|
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
|
|
|
|
vim: et tw=78 syn=sgml
|
|
|
|
|
|
vi: ts=1 sw=1
|
|
|
|
|
|
-->
|
