| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template priority_queue</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> |
| <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> |
| <link rel="up" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp" title="Header <boost/heap/priority_queue.hpp>"> |
| <link rel="prev" href="store_parent_pointer.html" title="Struct template store_parent_pointer"> |
| <link rel="next" href="skew_heap.html" title="Class template skew_heap"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="store_parent_pointer.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> |
| </div> |
| <div class="refentry"> |
| <a name="boost.heap.priority_queue"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template priority_queue</span></h2> |
| <p>boost::heap::priority_queue — priority queue, based on stl heap functions </p> |
| </div> |
| <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
| <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp" title="Header <boost/heap/priority_queue.hpp>">boost/heap/priority_queue.hpp</a>> |
| |
| </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Options<span class="special">></span> |
| <span class="keyword">class</span> <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">{</span> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queuetypes">types</a></span> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| |
| <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queueconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <span class="keyword">explicit</span> <a class="link" href="priority_queue.html#idp37043232-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">&</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> |
| <a class="link" href="priority_queue.html#idp37046608-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">&</span><span class="special">)</span><span class="special">;</span> |
| <a class="link" href="priority_queue.html#idp37049664-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">&&</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">&</span> <a class="link" href="priority_queue.html#idp37053584-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">&&</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">&</span> <a class="link" href="priority_queue.html#idp37058080-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">&</span><span class="special">)</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="priority_queue.html#idp107803488-bb">public member functions</a></span> |
| <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp107804048-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> |
| <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#idp107807648-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> |
| <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#idp107811248-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> |
| <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp46866864-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> |
| <span class="identifier">allocator_type</span> <a class="link" href="priority_queue.html#idp46870192-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> |
| <span class="identifier">const_reference</span> <a class="link" href="priority_queue.html#idp46873824-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> |
| <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp46877424-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">&</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp46880720-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp46885264-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp46888560-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">&</span><span class="special">)</span><span class="special">;</span> |
| <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#idp46892224-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> |
| <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#idp46895824-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> |
| <span class="keyword">void</span> <a class="link" href="priority_queue.html#idp33445888-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> |
| <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="priority_queue.html#idp33450064-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> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp33452816-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp33457728-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp33462640-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp33467552-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp33472464-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="priority_queue.html#idp37038000-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> |
| |
| <span class="comment">// public data members</span> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <span class="special">}</span><span class="special">;</span></pre></div> |
| <div class="refsect1"> |
| <a name="idp210576688"></a><h2>Description</h2> |
| <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> |
| 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> |
| <p>The container supports the following options:</p> |
| <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| <li class="listitem"><p><code class="computeroutput">boost::heap::compare<></code>, defaults to <code class="computeroutput">compare<std::less<T></code> ></p></li> |
| <li class="listitem"><p><code class="computeroutput">boost::heap::stable<></code>, defaults to <code class="computeroutput">stable<false></code> </p></li> |
| <li class="listitem"><p><code class="computeroutput">boost::heap::stability_counter_type<></code>, defaults to <code class="computeroutput">stability_counter_type<boost::uintmax_t></code> </p></li> |
| <li class="listitem"><p><code class="computeroutput">boost::heap::allocator<></code>, defaults to <code class="computeroutput">allocator<std::allocator<T></code> > </p></li> |
| </ul></div> |
| <p> |
| </p> |
| <div class="refsect2"> |
| <a name="idp210585216"></a><h3> |
| <a name="boost.heap.priority_queuetypes"></a><code class="computeroutput">priority_queue</code> |
| public |
| types</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> |
| <p> |
| <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> |
| <p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p> |
| </li></ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="idp210591904"></a><h3> |
| <a name="boost.heap.priority_queueconstruct-copy-destruct"></a><code class="computeroutput">priority_queue</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp37043232-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">&</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> |
| <p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="idp37046608-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">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="idp37049664-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">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> |
| <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&</span> <a name="idp37053584-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">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> |
| <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&</span> <a name="idp37058080-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">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> |
| </li> |
| </ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="idp210633360"></a><h3> |
| <a name="idp107803488-bb"></a><code class="computeroutput">priority_queue</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">bool</span> <a name="idp107804048-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp107807648-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp107811248-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp46866864-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idp46870192-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">const_reference</span> <a name="idp46873824-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp46877424-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">&</span> v<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> <span class="keyword">void</span> <a name="idp46880720-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&&</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp46885264-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp46888560-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">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp46892224-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp46895824-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="idp33445888-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> |
| <p><span class="bold"><strong>Effects:</strong></span> Reserves memory for element_count elements</p> |
| <p><span class="bold"><strong>Complexity:</strong></span> Linear.</p> |
| <p><span class="bold"><strong>Node:</strong></span> Invalidates iterators </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a name="idp33450064-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> |
| <p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp33452816-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> |
| <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp33457728-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> |
| <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp33462640-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> |
| <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp33467552-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">&</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> |
| <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> |
| <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp33472464-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">&</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> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="idp37038000-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">&</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> |
| </li> |
| </ol></div> |
| </div> |
| </div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2010, 2011 Tim Blechmann<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| 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>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="store_parent_pointer.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> |
| </div> |
| </body> |
| </html> |