<!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 PriorityQueue class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-queue.toarray.html">Ds\Queue::toArray</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-priorityqueue.allocate.html">Ds\PriorityQueue::allocate</a></div> <div class="up"><a href="book.ds.html">Data Structures</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.ds-priorityqueue" class="reference"> <h1 class="title">The PriorityQueue class</h1> <div class="partintro"><p class="verinfo">(No version information available, might only be in Git)</p> <div class="section" id="ds-priorityqueue.intro"> <h2 class="title">Introduction</h2> <p class="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. </p> <p class="para"> Implemented using a max heap. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> "First in, first out" ordering is preserved for values with the same priority. </p> </p></blockquote> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the queue is empty. </p> </p></blockquote> </div> <div class="section" id="ds-priorityqueue.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">Ds\PriorityQueue</strong> </span> <span class="oointerface">implements <span class="interfacename"><strong class="interfacename">Ds\Collection</strong></span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">int</span> <var class="fieldsynopsis_varname"><a href="class.ds-priorityqueue.html#ds-priorityqueue.constants.min-capacity"><var class="varname">MIN_CAPACITY</var></a></var> <span class="initializer"> = 8</span> ;</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="ds-priorityqueue.allocate.html" class="methodname">allocate</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$capacity</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="ds-priorityqueue.capacity.html" class="methodname">capacity</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="ds-priorityqueue.clear.html" class="methodname">clear</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">Ds\PriorityQueue</span> <span class="methodname"><a href="ds-priorityqueue.copy.html" class="methodname">copy</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="ds-priorityqueue.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="ds-priorityqueue.peek.html" class="methodname">peek</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="ds-priorityqueue.pop.html" class="methodname">pop</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="ds-priorityqueue.push.html" class="methodname">push</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">int</span> <code class="parameter">$priority</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="ds-priorityqueue.toarray.html" class="methodname">toArray</a></span> ( <span class="methodparam">void</span> )</div> }</div> </div> <div class="section" id="ds-priorityqueue.constants"> <h2 class="title">Predefined Constants</h2> <dl> <dt id="ds-priorityqueue.constants.min-capacity"><strong><code>Ds\PriorityQueue::MIN_CAPACITY</code></strong></dt> <dd> <p class="para"/> </dd> </dl> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="ds-priorityqueue.allocate.html">Ds\PriorityQueue::allocate</a> — Allocates enough memory for a required capacity</li><li><a href="ds-priorityqueue.capacity.html">Ds\PriorityQueue::capacity</a> — Returns the current capacity</li><li><a href="ds-priorityqueue.clear.html">Ds\PriorityQueue::clear</a> — Removes all values</li><li><a href="ds-priorityqueue.construct.html">Ds\PriorityQueue::__construct</a> — Creates a new instance</li><li><a href="ds-priorityqueue.copy.html">Ds\PriorityQueue::copy</a> — Returns a shallow copy of the queue</li><li><a href="ds-priorityqueue.count.html">Ds\PriorityQueue::count</a> — Returns the number of values in the queue</li><li><a href="ds-priorityqueue.isempty.html">Ds\PriorityQueue::isEmpty</a> — Returns whether the queue is empty</li><li><a href="ds-priorityqueue.jsonserialize.html">Ds\PriorityQueue::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="ds-priorityqueue.peek.html">Ds\PriorityQueue::peek</a> — Returns the value at the front of the queue</li><li><a href="ds-priorityqueue.pop.html">Ds\PriorityQueue::pop</a> — Removes and returns the value with the highest priority</li><li><a href="ds-priorityqueue.push.html">Ds\PriorityQueue::push</a> — Pushes values into the queue</li><li><a href="ds-priorityqueue.toarray.html">Ds\PriorityQueue::toArray</a> — Converts the queue to an array</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ds-queue.toarray.html">Ds\Queue::toArray</a></div> <div class="next" style="text-align: right; float: right;"><a href="ds-priorityqueue.allocate.html">Ds\PriorityQueue::allocate</a></div> <div class="up"><a href="book.ds.html">Data Structures</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>