php-doc-en/reference/ds/ds.set.xml
Rudi Theunissen da1b2b494a Update class name of ds extension members
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339758 c90b9560-bf6c-de11-be94-00142212c4b1
2016-08-01 08:15:21 +00:00

134 lines
3.8 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.ds-set" 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">
<title>The Set class</title>
<titleabbrev>Set</titleabbrev>
<partintro>
<!-- {{{ Ds\Set intro -->
<section xml:id="ds-set.intro">
&reftitle.intro;
<para>
A Set is a sequence of unique values. This implementation uses the same hash
table as <classname>Ds\Map</classname>, where values are used as keys and the
mapped value is ignored.
</para>
</section>
<!-- }}} -->
<section xml:id="ds-set.strengths">
<title xmlns="http://docbook.org/ns/docbook">Strengths</title>
<para>
<simplelist>
<member>Values can be any type, including objects.</member>
<member>Supports array syntax (square brackets).</member>
<member>Insertion order is preserved.</member>
<member>Automatically frees allocated memory when its size drops low enough.</member>
<member>
<function>add</function>,
<function>remove</function> and
<function>contains</function> are all O(1).
</member>
</simplelist>
</para>
</section>
<section xml:id="ds-set.weaknesses">
<title xmlns="http://docbook.org/ns/docbook">Weaknesses</title>
<para>
<simplelist>
<member>Doesnt support
<function>push</function>,
<function>pop</function>,
<function>insert</function>,
<function>shift</function>, or
<function>unshift</function>.
</member>
<member>
<function>get</function> is O(n) if there are deleted values
in the buffer before the accessed index, O(1) otherwise.
</member>
</simplelist>
</para>
</section>
<section xml:id="ds-set.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>Ds\Set</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>Ds\Set</classname>
</ooclass>
<oointerface>
<interfacename>Ds\Collection</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>int</type>
<varname linkend="ds-set.constants.min-capacity">Ds\Set::MIN_CAPACITY</varname>
<initializer>16</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-set')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ Ds\Set constants -->
<section xml:id="ds-set.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ds-set.constants.min-capacity">
<term><constant>Ds\Set::MIN_CAPACITY</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.ds.ds.entities.set;
</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
-->