splpriorityqueue.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.splpriorityqueue" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The SplPriorityQueue class</title>
 <titleabbrev>SplPriorityQueue</titleabbrev>
 
 <partintro>
 
<!-- {{{ splpriorityqueue intro -->
  <section xml:id="splpriorityqueue.intro">
   &reftitle.intro;
   <para>
    The SplPriorityQueue class provides the main functionalities of a 
    prioritized queue, implemented using a max heap.
   </para>
   <note>
    <simpara>
     The order of elements with identical priority is <emphasis>undefined</emphasis>.
     It may differ from the order in which they have been inserted.
    </simpara>
   </note>
  </section>
<!-- }}} -->
 
  <section xml:id="splpriorityqueue.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>SplPriorityQueue</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>Iterator</interfacename>
    </oointerface>

    <oointerface>
     <interfacename>Countable</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="splpriorityqueue.constants.extr-both">SplPriorityQueue::EXTR_BOTH</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="splpriorityqueue.constants.extr-priority">SplPriorityQueue::EXTR_PRIORITY</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="splpriorityqueue.constants.extr-data">SplPriorityQueue::EXTR_DATA</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splpriorityqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SplPriorityQueue'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 
  </section>

  <section xml:id="splpriorityqueue.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="splpriorityqueue.constants.extr-both">
     <term><constant>SplPriorityQueue::EXTR_BOTH</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="splpriorityqueue.constants.extr-priority">
     <term><constant>SplPriorityQueue::EXTR_PRIORITY</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="splpriorityqueue.constants.extr-data">
     <term><constant>SplPriorityQueue::EXTR_DATA</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
 
<!-- {{{ splpriorityqueue properties
  <section xml:id="splpriorityqueue.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="splpriorityqueue.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Prop description</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
}}} -->
 
 </partintro>
 
 &reference.spl.entities.splpriorityqueue;
 
</reference>
<!-- 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
-->