<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ds.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'it',
  ),
  'this' => 
  array (
    0 => 'class.ds-priorityqueue.php',
    1 => 'Ds\\PriorityQueue',
    2 => 'The PriorityQueue class',
  ),
  'up' => 
  array (
    0 => 'book.ds.php',
    1 => 'Data Structures',
  ),
  'prev' => 
  array (
    0 => 'ds-queue.toarray.php',
    1 => 'Ds\\Queue::toArray',
  ),
  'next' => 
  array (
    0 => 'ds-priorityqueue.allocate.php',
    1 => 'Ds\\PriorityQueue::allocate',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ds/ds.priorityqueue.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.ds-priorityqueue.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.ds-priorityqueue" class="reference">

 <h1 class="title">The PriorityQueue class</h1>
 

 <div class="partintro"><p class="verinfo">(PECL ds &gt;= 1.0.0)</p>


  <div class="section" id="ds-priorityqueue.intro">
   <h2 class="title">Introduzione</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">Nota</strong>: 
        <p class="para">
            &quot;First in, first out&quot; ordering is preserved for values with the same priority.
        </p>
   </p></blockquote>
   <blockquote class="note"><p><strong class="note">Nota</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">Sommario della classe</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">Ds\PriorityQueue</strong>
     </span>

     <span class="oointerface"><span class="modifier">implements</span> 
       <a href="class.ds-collection.php" class="interfacename">Ds\Collection</a></span> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Costanti */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ds-priorityqueue.php#ds-priorityqueue.constants.min-capacity"><var class="varname">MIN_CAPACITY</var></a></var><span class="initializer"> = 8</span>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Metodi */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.allocate.php" class="methodname">allocate</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$capacity</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.capacity.php" class="methodname">capacity</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.clear.php" class="methodname">clear</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.copy.php" class="methodname">copy</a></span>(): <span class="type"><a href="class.ds-priorityqueue.php" class="type Ds\PriorityQueue">Ds\PriorityQueue</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.isempty.php" class="methodname">isEmpty</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.peek.php" class="methodname">peek</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.pop.php" class="methodname">pop</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.push.php" class="methodname">push</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$priority</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ds-priorityqueue.toarray.php" class="methodname">toArray</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

   }</div>


  </div>


  <div class="section" id="ds-priorityqueue.constants">
   <h2 class="title">Costanti predefinite</h2>
   <dl>

    
     <dt id="ds-priorityqueue.constants.min-capacity"><strong><code><a href="class.ds-priorityqueue.php#ds-priorityqueue.constants.min-capacity">Ds\PriorityQueue::MIN_CAPACITY</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

   </dl>
  </div>



 </div>

 


















































































<h2>Indice dei contenuti</h2><ul class="chunklist chunklist_reference"><li><a href="ds-priorityqueue.allocate.php">Ds\PriorityQueue::allocate</a> — Allocates enough memory for a required capacity</li><li><a href="ds-priorityqueue.capacity.php">Ds\PriorityQueue::capacity</a> — Returns the current capacity</li><li><a href="ds-priorityqueue.clear.php">Ds\PriorityQueue::clear</a> — Removes all values</li><li><a href="ds-priorityqueue.construct.php">Ds\PriorityQueue::__construct</a> — Creates a new instance</li><li><a href="ds-priorityqueue.copy.php">Ds\PriorityQueue::copy</a> — Returns a shallow copy of the queue</li><li><a href="ds-priorityqueue.count.php">Ds\PriorityQueue::count</a> — Returns the number of values in the queue</li><li><a href="ds-priorityqueue.isempty.php">Ds\PriorityQueue::isEmpty</a> — Returns whether the queue is empty</li><li><a href="ds-priorityqueue.jsonserialize.php">Ds\PriorityQueue::jsonSerialize</a> — Returns a representation that can be converted to JSON</li><li><a href="ds-priorityqueue.peek.php">Ds\PriorityQueue::peek</a> — Returns the value at the front of the queue</li><li><a href="ds-priorityqueue.pop.php">Ds\PriorityQueue::pop</a> — Removes and returns the value with the highest priority</li><li><a href="ds-priorityqueue.push.php">Ds\PriorityQueue::push</a> — Pushes values into the queue</li><li><a href="ds-priorityqueue.toarray.php">Ds\PriorityQueue::toArray</a> — Converts the queue to an array</li></ul>
</div>
<?php manual_footer($setup); ?>