doc-en/reference/spl/splpriorityqueue.xml at master · php/doc-en · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?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'])"/>
   </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>
}}} -->

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &changelog.class-constants-typed;
     </tbody>
    </tgroup>
   </informaltable>
  </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
-->