ds.priorityqueue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.ds-priorityqueue" 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 PriorityQueue class</title>
 <titleabbrev>Ds\PriorityQueue</titleabbrev>

 <partintro>

<!-- {{{ Ds\PriorityQueue intro -->
  <section xml:id="ds-priorityqueue.intro">
   &reftitle.intro;
   <para>
    A PriorityQueue is very similar to a Queue. Values are pushed into the queue
    with an assigned priority, and the value with the highest priority will
    always be at the front of the queue.
   </para>
   <para>
        Implemented using a max heap.
   </para>
   <note>
        <para>
            "First in, first out" ordering is preserved for values with the same priority.
        </para>
   </note>
   <note>
        <para>
            Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the queue is empty.
        </para>
   </note>
  </section>
<!-- }}} -->

  <section xml:id="ds-priorityqueue.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Ds\PriorityQueue</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>Ds\PriorityQueue</classname>
     </ooclass>

     <oointerface>
      <interfacename>Ds\Collection</interfacename>
     </oointerface>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ds-priorityqueue.constants.min-capacity">Ds\PriorityQueue::MIN_CAPACITY</varname>
     <initializer>8</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ds-priorityqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ Ds\PriorityQueue constants -->
  <section xml:id="ds-priorityqueue.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="ds-priorityqueue.constants.min-capacity">
     <term><constant>Ds\PriorityQueue::MIN_CAPACITY</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.ds.ds.entities.priorityqueue;

</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
-->