doc/html/boost/heap/priority_queue.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template priority_queue</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp" title="Header &lt;boost/heap/priority_queue.hpp&gt;">
   9 <link rel="prev" href="arity.html" title="Struct template arity">
  10 <link rel="next" href="skew_heap.html" title="Class template skew_heap">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="arity.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="skew_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.heap.priority_queue"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template priority_queue</span></h2>
  29 <p>boost::heap::priority_queue &#8212; priority queue, based on stl heap functions </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp" title="Header &lt;boost/heap/priority_queue.hpp&gt;">boost/heap/priority_queue.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Options<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queuetypes">types</a></span>
  38   <span class="keyword">typedef</span> <span class="identifier">T</span>                                       <a name="boost.heap.priority_queue.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">size_type</span>       <a name="boost.heap.priority_queue.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">difference_type</span> <a name="boost.heap.priority_queue.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">value_compare</span>   <a name="boost.heap.priority_queue.value_compare"></a><span class="identifier">value_compare</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">allocator_type</span>  <a name="boost.heap.priority_queue.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">reference</span>       <a name="boost.heap.priority_queue.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_reference</span> <a name="boost.heap.priority_queue.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">pointer</span>         <a name="boost.heap.priority_queue.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_pointer</span>   <a name="boost.heap.priority_queue.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span>        <a class="link" href="priority_queue.html#boost.heap.priority_queue.iterator"><span class="identifier">iterator</span></a><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_iterator</span>  <a name="boost.heap.priority_queue.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queueconstruct-copy-destruct">construct/copy/destruct</a></span>
  51   <span class="keyword">explicit</span> <a class="link" href="priority_queue.html#idp54066528-bb"><span class="identifier">priority_queue</span></a><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  52   <a class="link" href="priority_queue.html#idp54069904-bb"><span class="identifier">priority_queue</span></a><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53   <a class="link" href="priority_queue.html#idp54072960-bb"><span class="identifier">priority_queue</span></a><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span> <a class="link" href="priority_queue.html#idp54076880-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span> <a class="link" href="priority_queue.html#idp54081376-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  56
  57   <span class="comment">// <a class="link" href="priority_queue.html#idp72305728-bb">public member functions</a></span>
  58   <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp72306288-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  59   <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#idp72309888-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  60   <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#idp72313488-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  61   <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp72317088-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  62   <span class="identifier">allocator_type</span> <a class="link" href="priority_queue.html#idp72320416-bb"><span class="identifier">get_allocator</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  63   <span class="identifier">const_reference</span> <a class="link" href="priority_queue.html#idp41410720-bb"><span class="identifier">top</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  64   <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp41414320-bb"><span class="identifier">push</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp41417616-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  66   <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp41422160-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  67   <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp41425456-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  68   <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#idp41429120-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  69   <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#idp41432720-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  70   <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp41436320-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
  71   <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="priority_queue.html#idp41440496-bb"><span class="identifier">value_comp</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  72   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp41443248-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  73   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp41448160-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  74   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp54046400-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  75   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp54051312-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  76   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp54056224-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  77   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp54061296-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  78
  79   <span class="comment">// public data members</span>
  80   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">constant_time_size</span><span class="special">;</span>
  81   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_ordered_iterators</span><span class="special">;</span>
  82   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">is_mergable</span><span class="special">;</span>
  83   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">is_stable</span><span class="special">;</span>
  84   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_reserve</span><span class="special">;</span>
  85 <span class="special">}</span><span class="special">;</span></pre></div>
  86 <div class="refsect1">
  87 <a name="idp217424752"></a><h2>Description</h2>
  88 <p>The <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> class is a wrapper for the stl heap functions.<br>
  89  The template parameter T is the type to be managed by the container. The user can specify additional options and if no options are provided default options are used.</p>
  90 <p>The container supports the following options:</p>
  91 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  92 <li class="listitem"><p><code class="computeroutput">boost::heap::compare&lt;&gt;</code>, defaults to <code class="computeroutput">compare&lt;std::less&lt;T&gt;</code> &gt;</p></li>
  93 <li class="listitem"><p><code class="computeroutput">boost::heap::stable&lt;&gt;</code>, defaults to <code class="computeroutput">stable&lt;false&gt;</code> </p></li>
  94 <li class="listitem"><p><code class="computeroutput">boost::heap::stability_counter_type&lt;&gt;</code>, defaults to <code class="computeroutput">stability_counter_type&lt;boost::uintmax_t&gt;</code> </p></li>
  95 <li class="listitem"><p><code class="computeroutput">boost::heap::allocator&lt;&gt;</code>, defaults to <code class="computeroutput">allocator&lt;std::allocator&lt;T&gt;</code> &gt; </p></li>
  96 </ul></div>
  97 <p>
  98 </p>
  99 <div class="refsect2">
 100 <a name="idp217434512"></a><h3>
 101 <a name="boost.heap.priority_queuetypes"></a><code class="computeroutput">priority_queue</code>
 102         public
 103        types</h3>
 104 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 105 <p>
 106 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span> <a name="boost.heap.priority_queue.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p>
 107 <p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p>
 108 </li></ol></div>
 109 </div>
 110 <div class="refsect2">
 111 <a name="idp217442208"></a><h3>
 112 <a name="boost.heap.priority_queueconstruct-copy-destruct"></a><code class="computeroutput">priority_queue</code>
 113         public
 114        construct/copy/destruct</h3>
 115 <div class="orderedlist"><ol class="orderedlist" type="1">
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp54066528-bb"></a><span class="identifier">priority_queue</span><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> cmp <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
 118 <p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p>
 119 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 120 </li>
 121 <li class="listitem">
 122 <pre class="literallayout"><a name="idp54069904-bb"></a><span class="identifier">priority_queue</span><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 123 <p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p>
 124 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 125 </li>
 126 <li class="listitem">
 127 <pre class="literallayout"><a name="idp54072960-bb"></a><span class="identifier">priority_queue</span><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 128 <p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p>
 129 <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p>
 130 <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p>
 131 </li>
 132 <li class="listitem">
 133 <pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span> <a name="idp54076880-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 134 <p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p>
 135 <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p>
 136 <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span> <a name="idp54081376-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 140 <p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p>
 141 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 142 </li>
 143 </ol></div>
 144 </div>
 145 <div class="refsect2">
 146 <a name="idp217489728"></a><h3>
 147 <a name="idp72305728-bb"></a><code class="computeroutput">priority_queue</code> public member functions</h3>
 148 <div class="orderedlist"><ol class="orderedlist" type="1">
 149 <li class="listitem">
 150 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp72306288-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 151 <p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p>
 152 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 153 </li>
 154 <li class="listitem">
 155 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp72309888-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 156 <p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p>
 157 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 158 </li>
 159 <li class="listitem">
 160 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp72313488-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 161 <p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p>
 162 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 163 </li>
 164 <li class="listitem">
 165 <pre class="literallayout"><span class="keyword">void</span> <a name="idp72317088-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
 166 <p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p>
 167 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 168 </li>
 169 <li class="listitem">
 170 <pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idp72320416-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 171 <p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p>
 172 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 173 </li>
 174 <li class="listitem">
 175 <pre class="literallayout"><span class="identifier">const_reference</span> <a name="idp41410720-bb"></a><span class="identifier">top</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 176 <p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p>
 177 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 178 </li>
 179 <li class="listitem">
 180 <pre class="literallayout"><span class="keyword">void</span> <a name="idp41414320-bb"></a><span class="identifier">push</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> v<span class="special">)</span><span class="special">;</span></pre>
 181 <p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue.</p>
 182 <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p>
 183 </li>
 184 <li class="listitem">
 185 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp41417616-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
 186 <p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place.</p>
 187 <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p>
 188 </li>
 189 <li class="listitem">
 190 <pre class="literallayout"><span class="keyword">void</span> <a name="idp41422160-bb"></a><span class="identifier">pop</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>
 191 <p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p>
 192 <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p>
 193 </li>
 194 <li class="listitem">
 195 <pre class="literallayout"><span class="keyword">void</span> <a name="idp41425456-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 196 <p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p>
 197 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 198 </li>
 199 <li class="listitem">
 200 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp41429120-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 201 <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p>
 202 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 203 </li>
 204 <li class="listitem">
 205 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp41432720-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 206 <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p>
 207 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 208 </li>
 209 <li class="listitem">
 210 <pre class="literallayout"><span class="keyword">void</span> <a name="idp41436320-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> element_count<span class="special">)</span><span class="special">;</span></pre>
 211 <p><span class="bold"><strong>Effects:</strong></span> Reserves memory for element_count elements</p>
 212 <p><span class="bold"><strong>Complexity:</strong></span> Linear.</p>
 213 <p><span class="bold"><strong>Node:</strong></span> Invalidates iterators </p>
 214 </li>
 215 <li class="listitem">
 216 <pre class="literallayout"><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp41440496-bb"></a><span class="identifier">value_comp</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 217 <p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p>
 218 </li>
 219 <li class="listitem">
 220 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp41443248-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 221 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 222 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 223 </li>
 224 <li class="listitem">
 225 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp41448160-bb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 226 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 227 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 228 </li>
 229 <li class="listitem">
 230 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp54046400-bb"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 231 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 232 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 233 </li>
 234 <li class="listitem">
 235 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp54051312-bb"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 236 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 237 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 238 </li>
 239 <li class="listitem">
 240 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp54056224-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are equivalent. <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 241 </li>
 242 <li class="listitem">
 243 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp54061296-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are not equivalent. <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 244 </li>
 245 </ol></div>
 246 </div>
 247 </div>
 248 </div>
 249 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 250 <td align="left"></td>
 251 <td align="right"><div class="copyright-footer">Copyright &#169; 2010, 2011 Tim Blechmann<p>
 252         Distributed under the Boost Software License, Version 1.0. (See accompanying
 253         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 254       </p>
 255 </div></td>
 256 </tr></table>
 257 <hr>
 258 <div class="spirit-nav">
 259 <a accesskey="p" href="arity.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="skew_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 260 </div>
 261 </body>
 262 </html>