1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class template priority_queue</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../heap/reference.html#header.boost.heap.priority_queue_hpp" title="Header <boost/heap/priority_queue.hpp>"> 10<link rel="prev" href="store_parent_pointer.html" title="Struct template store_parent_pointer"> 11<link rel="next" href="skew_heap.html" title="Class template skew_heap"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boost.heap.priority_queue"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template priority_queue</span></h2> 30<p>boost::heap::priority_queue — priority queue, based on stl heap functions </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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>> 34 35</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> 36<span class="keyword">class</span> <a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queuetypes">types</a></span> 39 <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> 40 <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> 41 <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> 42 <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> 43 <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> 44 <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> 45 <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> 46 <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> 47 <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> 48 <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> 49 <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> 50 51 <span class="comment">// <a class="link" href="priority_queue.html#boost.heap.priority_queueconstruct-copy-destruct">construct/copy/destruct</a></span> 52 <span class="keyword">explicit</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_21-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> 53 <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_22-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> 54 <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_23-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_constructible</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</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">&</span> 56 <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_24-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_assignable</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 57 <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#id-1_3_18_6_8_1_1_1_25-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> 58 59 <span class="comment">// <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20-bb">public member functions</a></span> 60 <span class="keyword">bool</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_1-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="keyword">noexcept</span><span class="special">;</span> 61 <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_2-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="keyword">noexcept</span><span class="special">;</span> 62 <span class="identifier">size_type</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_3-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="keyword">noexcept</span><span class="special">;</span> 63 <span class="keyword">void</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_4-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> 64 <span class="identifier">allocator_type</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_5-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> 65 <span class="identifier">const_reference</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_6-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> 66 <span class="keyword">void</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_7-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> 67 <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#id-1_3_18_6_8_1_1_1_20_8-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> 68 <span class="keyword">void</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_9-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 69 <span class="keyword">void</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_10-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_constructible</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">&&</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_assignable</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 70 <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_11-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="keyword">noexcept</span><span class="special">;</span> 71 <span class="identifier">iterator</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_12-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="keyword">noexcept</span><span class="special">;</span> 72 <span class="keyword">void</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_13-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> 73 <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="priority_queue.html#id-1_3_18_6_8_1_1_1_20_14-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> 74 <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#id-1_3_18_6_8_1_1_1_20_15-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> 75 <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#id-1_3_18_6_8_1_1_1_20_16-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> 76 <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#id-1_3_18_6_8_1_1_1_20_17-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> 77 <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#id-1_3_18_6_8_1_1_1_20_18-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> 78 <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#id-1_3_18_6_8_1_1_1_20_19-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> 79 <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#id-1_3_18_6_8_1_1_1_20_20-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> 80 81 <span class="comment">// public data members</span> 82 <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> 83 <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> 84 <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> 85 <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> 86 <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> 87<span class="special">}</span><span class="special">;</span></pre></div> 88<div class="refsect1"> 89<a name="id-1.3.18.6.9.3.4"></a><h2>Description</h2> 90<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> 91 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> 92<p>The container supports the following options:</p> 93<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 94<li class="listitem"><p><code class="computeroutput">boost::heap::compare<></code>, defaults to <code class="computeroutput">compare<std::less<T></code> ></p></li> 95<li class="listitem"><p><code class="computeroutput">boost::heap::stable<></code>, defaults to <code class="computeroutput">stable<false></code> </p></li> 96<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> 97<li class="listitem"><p><code class="computeroutput">boost::heap::allocator<></code>, defaults to <code class="computeroutput">allocator<std::allocator<T></code> > </p></li> 98</ul></div> 99<p> 100</p> 101<div class="refsect2"> 102<a name="id-1.3.18.6.9.3.4.4"></a><h3> 103<a name="boost.heap.priority_queuetypes"></a><code class="computeroutput">priority_queue</code> 104 public 105 types</h3> 106<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 107<p> 108<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> 109<p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p> 110</li></ol></div> 111</div> 112<div class="refsect2"> 113<a name="id-1.3.18.6.9.3.4.5"></a><h3> 114<a name="boost.heap.priority_queueconstruct-copy-destruct"></a><code class="computeroutput">priority_queue</code> 115 public 116 construct/copy/destruct</h3> 117<div class="orderedlist"><ol class="orderedlist" type="1"> 118<li class="listitem"> 119<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_18_6_8_1_1_1_21-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> 120<p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p> 121<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 122</li> 123<li class="listitem"> 124<pre class="literallayout"><a name="id-1_3_18_6_8_1_1_1_22-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> 125<p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p> 126<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 127</li> 128<li class="listitem"> 129<pre class="literallayout"><a name="id-1_3_18_6_8_1_1_1_23-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_constructible</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> 130<p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p> 131<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 132<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 133</li> 134<li class="listitem"> 135<pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&</span> 136<a name="id-1_3_18_6_8_1_1_1_24-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_assignable</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> 137<p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p> 138<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 139<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 140</li> 141<li class="listitem"> 142<pre class="literallayout"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a> <span class="special">&</span> <a name="id-1_3_18_6_8_1_1_1_25-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> 143<p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p> 144<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 145</li> 146</ol></div> 147</div> 148<div class="refsect2"> 149<a name="id-1.3.18.6.9.3.4.6"></a><h3> 150<a name="id-1_3_18_6_8_1_1_1_20-bb"></a><code class="computeroutput">priority_queue</code> public member functions</h3> 151<div class="orderedlist"><ol class="orderedlist" type="1"> 152<li class="listitem"> 153<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_18_6_8_1_1_1_20_1-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="keyword">noexcept</span><span class="special">;</span></pre> 154<p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p> 155<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 156</li> 157<li class="listitem"> 158<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_8_1_1_1_20_2-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="keyword">noexcept</span><span class="special">;</span></pre> 159<p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p> 160<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 161</li> 162<li class="listitem"> 163<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_8_1_1_1_20_3-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="keyword">noexcept</span><span class="special">;</span></pre> 164<p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p> 165<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 166</li> 167<li class="listitem"> 168<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_8_1_1_1_20_4-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> 169<p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p> 170<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 171</li> 172<li class="listitem"> 173<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="id-1_3_18_6_8_1_1_1_20_5-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> 174<p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p> 175<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 176</li> 177<li class="listitem"> 178<pre class="literallayout"><span class="identifier">const_reference</span> <a name="id-1_3_18_6_8_1_1_1_20_6-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> 179<p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p> 180<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 181</li> 182<li class="listitem"> 183<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_8_1_1_1_20_7-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> 184<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue.</p> 185<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 186</li> 187<li class="listitem"> 188<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="id-1_3_18_6_8_1_1_1_20_8-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> 189<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place.</p> 190<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 191</li> 192<li class="listitem"> 193<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_8_1_1_1_20_9-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> 194<p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p> 195<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 196</li> 197<li class="listitem"> 198<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_8_1_1_1_20_10-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="keyword">noexcept</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_constructible</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span> <span class="special">&&</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_nothrow_move_assignable</span><span class="special"><</span> <span class="identifier">super_t</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> 199<p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p> 200<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 201</li> 202<li class="listitem"> 203<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_8_1_1_1_20_11-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="keyword">noexcept</span><span class="special">;</span></pre> 204<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p> 205<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 206</li> 207<li class="listitem"> 208<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_8_1_1_1_20_12-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="keyword">noexcept</span><span class="special">;</span></pre> 209<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p> 210<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 211</li> 212<li class="listitem"> 213<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_8_1_1_1_20_13-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> 214<p><span class="bold"><strong>Effects:</strong></span> Reserves memory for element_count elements</p> 215<p><span class="bold"><strong>Complexity:</strong></span> Linear.</p> 216<p><span class="bold"><strong>Node:</strong></span> Invalidates iterators </p> 217</li> 218<li class="listitem"> 219<pre class="literallayout"><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_18_6_8_1_1_1_20_14-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> 220<p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p> 221</li> 222<li class="listitem"> 223<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="id-1_3_18_6_8_1_1_1_20_15-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> 224<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 225<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 226</li> 227<li class="listitem"> 228<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="id-1_3_18_6_8_1_1_1_20_16-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> 229<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 230<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 231</li> 232<li class="listitem"> 233<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="id-1_3_18_6_8_1_1_1_20_17-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> 234<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 235<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 236</li> 237<li class="listitem"> 238<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="id-1_3_18_6_8_1_1_1_20_18-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> 239<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 240<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"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="id-1_3_18_6_8_1_1_1_20_19-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> 244</li> 245<li class="listitem"> 246<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="id-1_3_18_6_8_1_1_1_20_20-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> 247</li> 248</ol></div> 249</div> 250</div> 251</div> 252<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 253<td align="left"></td> 254<td align="right"><div class="copyright-footer">Copyright © 2010, 2011 Tim Blechmann<p> 255 Distributed under the Boost Software License, Version 1.0. (See accompanying 256 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>) 257 </p> 258</div></td> 259</tr></table> 260<hr> 261<div class="spirit-nav"> 262<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> 263</div> 264</body> 265</html> 266
