<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>The SplPriorityQueue class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="splminheap.compare.html">SplMinHeap::compare</a></div> <div class="next" style="text-align: right; float: right;"><a href="splpriorityqueue.compare.html">SplPriorityQueue::compare</a></div> <div class="up"><a href="spl.datastructures.html">Datastructures</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.splpriorityqueue" class="reference"> <h1 class="title">The SplPriorityQueue class</h1> <div class="partintro"><p class="verinfo">(PHP 5 >= 5.3.0)</p> <div class="section" id="splpriorityqueue.intro"> <h2 class="title">Introduction</h2> <p class="para"> The SplPriorityQueue class provides the main functionalities of an prioritized queue, implemented using a max heap. </p> </div> <div class="section" id="splpriorityqueue.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">SplPriorityQueue</strong> </span> <span class="oointerface">implements <span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</a></span> </span> <span class="oointerface">, <span class="interfacename"><a href="class.countable.html" class="interfacename">Countable</a></span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="constructorsynopsis dc-description"> <span class="modifier">public</span> <span class="methodname"><a href="splpriorityqueue.construct.html" class="methodname">__construct</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splpriorityqueue.compare.html" class="methodname">compare</a></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$priority1</code></span> , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$priority2</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="splpriorityqueue.count.html" class="methodname">count</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splpriorityqueue.current.html" class="methodname">current</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splpriorityqueue.extract.html" class="methodname">extract</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splpriorityqueue.insert.html" class="methodname">insert</a></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span> , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$priority</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splpriorityqueue.isempty.html" class="methodname">isEmpty</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splpriorityqueue.key.html" class="methodname">key</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splpriorityqueue.next.html" class="methodname">next</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splpriorityqueue.recoverfromcorruption.html" class="methodname">recoverFromCorruption</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splpriorityqueue.rewind.html" class="methodname">rewind</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="splpriorityqueue.setextractflags.html" class="methodname">setExtractFlags</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="splpriorityqueue.top.html" class="methodname">top</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="splpriorityqueue.valid.html" class="methodname">valid</a></span> ( <span class="methodparam">void</span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="splpriorityqueue.compare.html">SplPriorityQueue::compare</a> — Compare priorities in order to place elements correctly in the heap while sifting up.</li><li><a href="splpriorityqueue.construct.html">SplPriorityQueue::__construct</a> — Constructs a new empty queue</li><li><a href="splpriorityqueue.count.html">SplPriorityQueue::count</a> — Counts the number of elements in the queue.</li><li><a href="splpriorityqueue.current.html">SplPriorityQueue::current</a> — Return current node pointed by the iterator</li><li><a href="splpriorityqueue.extract.html">SplPriorityQueue::extract</a> — Extracts a node from top of the heap and sift up.</li><li><a href="splpriorityqueue.insert.html">SplPriorityQueue::insert</a> — Inserts an element in the queue by sifting it up.</li><li><a href="splpriorityqueue.isempty.html">SplPriorityQueue::isEmpty</a> — Checks whether the queue is empty.</li><li><a href="splpriorityqueue.key.html">SplPriorityQueue::key</a> — Return current node index</li><li><a href="splpriorityqueue.next.html">SplPriorityQueue::next</a> — Move to the next node</li><li><a href="splpriorityqueue.recoverfromcorruption.html">SplPriorityQueue::recoverFromCorruption</a> — Recover from the corrupted state and allow further actions on the queue.</li><li><a href="splpriorityqueue.rewind.html">SplPriorityQueue::rewind</a> — Rewind iterator back to the start (no-op)</li><li><a href="splpriorityqueue.setextractflags.html">SplPriorityQueue::setExtractFlags</a> — Sets the mode of extraction</li><li><a href="splpriorityqueue.top.html">SplPriorityQueue::top</a> — Peeks at the node from the top of the queue</li><li><a href="splpriorityqueue.valid.html">SplPriorityQueue::valid</a> — Check whether the queue contains more nodes</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="splminheap.compare.html">SplMinHeap::compare</a></div> <div class="next" style="text-align: right; float: right;"><a href="splpriorityqueue.compare.html">SplPriorityQueue::compare</a></div> <div class="up"><a href="spl.datastructures.html">Datastructures</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>