<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/spl.datastructures.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'class.splpriorityqueue.php',
    1 => 'SplPriorityQueue',
    2 => 'The SplPriorityQueue class',
  ),
  'up' => 
  array (
    0 => 'spl.datastructures.php',
    1 => 'Datastructures',
  ),
  'prev' => 
  array (
    0 => 'splminheap.compare.php',
    1 => 'SplMinHeap::compare',
  ),
  'next' => 
  array (
    0 => 'splpriorityqueue.compare.php',
    1 => 'SplPriorityQueue::compare',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/spl/splpriorityqueue.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.splpriorityqueue.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.splpriorityqueue" class="reference">
 <h1 class="title">The SplPriorityQueue class</h1>
 
 
 <div class="partintro"><p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8)</p>
 

  <div class="section" id="splpriorityqueue.intro">
   <h2 class="title">Einführung</h2>
   <p class="para">
    The SplPriorityQueue class provides the main functionalities of a 
    prioritized queue, implemented using a max heap.
   </p>
   <blockquote class="note"><p><strong class="note">Hinweis</strong>: 
    <span class="simpara">
     The order of elements with identical priority is <em>undefined</em>.
     It may differ from the order in which they have been inserted.
    </span>
   </p></blockquote>
  </div>

 
  <div class="section" id="splpriorityqueue.synopsis">
   <h2 class="title">Klassenbeschreibung</h2>
 

   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">SplPriorityQueue</strong></strong>
    

    
     <span class="modifier">implements</span>
      <a href="class.iterator.php" class="interfacename">Iterator</a>,

     <a href="class.countable.php" class="interfacename">Countable</a> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Konstanten */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <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.splpriorityqueue.php#splpriorityqueue.constants.extr-both"><var class="varname">EXTR_BOTH</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <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.splpriorityqueue.php#splpriorityqueue.constants.extr-priority"><var class="varname">EXTR_PRIORITY</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <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.splpriorityqueue.php#splpriorityqueue.constants.extr-data"><var class="varname">EXTR_DATA</var></a></var>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methoden */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="splpriorityqueue.compare.php" class="methodname">compare</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$priority1</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$priority2</code></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="splpriorityqueue.count.php" class="methodname">count</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="splpriorityqueue.current.php" class="methodname">current</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="splpriorityqueue.extract.php" class="methodname">extract</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="splpriorityqueue.getextractflags.php" class="methodname">getExtractFlags</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="splpriorityqueue.insert.php" class="methodname">insert</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.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$priority</code></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="splpriorityqueue.iscorrupted.php" class="methodname">isCorrupted</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="splpriorityqueue.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="splpriorityqueue.key.php" class="methodname">key</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="splpriorityqueue.next.php" class="methodname">next</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="splpriorityqueue.recoverfromcorruption.php" class="methodname">recoverFromCorruption</a></span>(): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="splpriorityqueue.rewind.php" class="methodname">rewind</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="splpriorityqueue.setextractflags.php" class="methodname">setExtractFlags</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></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="splpriorityqueue.top.php" class="methodname">top</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="splpriorityqueue.valid.php" class="methodname">valid</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>
 
  </div>

  <div class="section" id="splpriorityqueue.constants">
   <h2 class="title">Vordefinierte Konstanten</h2>
   <dl>
    
     <dt id="splpriorityqueue.constants.extr-both"><strong><code><a href="class.splpriorityqueue.php#splpriorityqueue.constants.extr-both">SplPriorityQueue::EXTR_BOTH</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="splpriorityqueue.constants.extr-priority"><strong><code><a href="class.splpriorityqueue.php#splpriorityqueue.constants.extr-priority">SplPriorityQueue::EXTR_PRIORITY</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="splpriorityqueue.constants.extr-data"><strong><code><a href="class.splpriorityqueue.php#splpriorityqueue.constants.extr-data">SplPriorityQueue::EXTR_DATA</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    
   </dl>
  </div>
 

 
 </div>
 
 










































































 
<h2>Inhaltsverzeichnis</h2><ul class="chunklist chunklist_reference"><li><a href="splpriorityqueue.compare.php">SplPriorityQueue::compare</a> — Compare priorities in order to place elements correctly in the heap while sifting up</li><li><a href="splpriorityqueue.count.php">SplPriorityQueue::count</a> — Counts the number of elements in the queue</li><li><a href="splpriorityqueue.current.php">SplPriorityQueue::current</a> — Return current node pointed by the iterator</li><li><a href="splpriorityqueue.extract.php">SplPriorityQueue::extract</a> — Extracts a node from top of the heap and sift up</li><li><a href="splpriorityqueue.getextractflags.php">SplPriorityQueue::getExtractFlags</a> — Get the flags of extraction</li><li><a href="splpriorityqueue.insert.php">SplPriorityQueue::insert</a> — Inserts an element in the queue by sifting it up</li><li><a href="splpriorityqueue.iscorrupted.php">SplPriorityQueue::isCorrupted</a> — Tells if the priority queue is in a corrupted state</li><li><a href="splpriorityqueue.isempty.php">SplPriorityQueue::isEmpty</a> — Checks whether the queue is empty</li><li><a href="splpriorityqueue.key.php">SplPriorityQueue::key</a> — Return current node index</li><li><a href="splpriorityqueue.next.php">SplPriorityQueue::next</a> — Move to the next node</li><li><a href="splpriorityqueue.recoverfromcorruption.php">SplPriorityQueue::recoverFromCorruption</a> — Recover from the corrupted state and allow further actions on the queue</li><li><a href="splpriorityqueue.rewind.php">SplPriorityQueue::rewind</a> — Rewind iterator back to the start (no-op)</li><li><a href="splpriorityqueue.setextractflags.php">SplPriorityQueue::setExtractFlags</a> — Sets the mode of extraction</li><li><a href="splpriorityqueue.top.php">SplPriorityQueue::top</a> — Peeks at the node from the top of the queue</li><li><a href="splpriorityqueue.valid.php">SplPriorityQueue::valid</a> — Check whether the queue contains more nodes</li></ul>
</div>
<?php manual_footer($setup); ?>