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 binomial_heap</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.binomial_heap_hpp" title="Header <boost/heap/binomial_heap.hpp>"> 10<link rel="prev" href="../../heap/reference.html" title="Reference"> 11<link rel="next" href="d_ary_heap.html" title="Class template d_ary_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="../../heap/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.binomial_heap_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="d_ary_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.heap.binomial_heap"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template binomial_heap</span></h2> 30<p>boost::heap::binomial_heap — binomial heap </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.binomial_heap_hpp" title="Header <boost/heap/binomial_heap.hpp>">boost/heap/binomial_heap.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="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="binomial_heap.html#boost.heap.binomial_heaptypes">types</a></span> 39 <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.heap.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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.binomial_heap.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="binomial_heap.html#boost.heap.binomial_heap.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.binomial_heap.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> 50 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">ordered_iterator</span> <a name="boost.heap.binomial_heap.ordered_iterator"></a><span class="identifier">ordered_iterator</span><span class="special">;</span> 51 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">handle_type</span> <a name="boost.heap.binomial_heap.handle_type"></a><span class="identifier">handle_type</span><span class="special">;</span> 52 53 <span class="comment">// <a class="link" href="binomial_heap.html#boost.heap.binomial_heapconstruct-copy-destruct">construct/copy/destruct</a></span> 54 <span class="keyword">explicit</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_23-bb"><span class="identifier">binomial_heap</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> 55 <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_24-bb"><span class="identifier">binomial_heap</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 56 <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_26-bb"><span class="identifier">binomial_heap</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 57 <a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_25-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 58 <a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_27-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 59 <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_28-bb"><span class="special">~</span><span class="identifier">binomial_heap</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 60 61 <span class="comment">// <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22-bb">public member functions</a></span> 62 <span class="keyword">bool</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_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="special">;</span> 63 <span class="identifier">size_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_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="special">;</span> 64 <span class="identifier">size_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_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="special">;</span> 65 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_4-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 66 <span class="identifier">allocator_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_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> 67 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_6-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 68 <span class="identifier">const_reference</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_7-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> 69 <span class="identifier">handle_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_8-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> 70 <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="identifier">handle_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_9-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> 71 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_10-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 72 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_11-bb"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> 73 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_12-bb"><span class="identifier">update</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span> 74 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_13-bb"><span class="identifier">increase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> 75 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_14-bb"><span class="identifier">increase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span> 76 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_15-bb"><span class="identifier">decrease</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> 77 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_16-bb"><span class="identifier">decrease</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span> 78 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_17-bb"><span class="identifier">merge</span></a><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 79 <span class="identifier">iterator</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_18-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> 80 <span class="identifier">iterator</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_19-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> 81 <span class="identifier">ordered_iterator</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_20-bb"><span class="identifier">ordered_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> 82 <span class="identifier">ordered_iterator</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_21-bb"><span class="identifier">ordered_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> 83 <span class="keyword">void</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_22-bb"><span class="identifier">erase</span></a><span class="special">(</span><span class="identifier">handle_type</span><span class="special">)</span><span class="special">;</span> 84 <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_23-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> 85 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_24-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> 86 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_25-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> 87 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_26-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> 88 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_27-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> 89 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_28-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> 90 <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="binomial_heap.html#id-1_3_18_6_1_1_1_1_22_29-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> 91 92 <span class="comment">// <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_29-bb">public static functions</a></span> 93 <span class="keyword">static</span> <span class="identifier">handle_type</span> <a class="link" href="binomial_heap.html#id-1_3_18_6_1_1_1_1_29_1-bb"><span class="identifier">s_handle_from_iterator</span></a><span class="special">(</span><span class="identifier">iterator</span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 94 95 <span class="comment">// public data members</span> 96 <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> 97 <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> 98 <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> 99 <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> 100 <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> 101<span class="special">}</span><span class="special">;</span></pre></div> 102<div class="refsect1"> 103<a name="id-1.3.18.6.2.3.4"></a><h2>Description</h2> 104<p>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> 105<p>The container supports the following options:</p> 106<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 107<li class="listitem"><p><code class="computeroutput">boost::heap::stable<></code>, defaults to <code class="computeroutput">stable<false></code> </p></li> 108<li class="listitem"><p><code class="computeroutput">boost::heap::compare<></code>, defaults to <code class="computeroutput">compare<std::less<T></code> ></p></li> 109<li class="listitem"><p><code class="computeroutput">boost::heap::allocator<></code>, defaults to <code class="computeroutput">allocator<std::allocator<T></code> ></p></li> 110<li class="listitem"><p><code class="computeroutput">boost::heap::constant_time_size<></code>, defaults to <code class="computeroutput">constant_time_size<true></code> </p></li> 111<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> 112</ul></div> 113<p> 114</p> 115<div class="refsect2"> 116<a name="id-1.3.18.6.2.3.4.4"></a><h3> 117<a name="boost.heap.binomial_heaptypes"></a><code class="computeroutput">binomial_heap</code> 118 public 119 types</h3> 120<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 121<p> 122<span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span> <a name="boost.heap.binomial_heap.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p> 123<p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p> 124</li></ol></div> 125</div> 126<div class="refsect2"> 127<a name="id-1.3.18.6.2.3.4.5"></a><h3> 128<a name="boost.heap.binomial_heapconstruct-copy-destruct"></a><code class="computeroutput">binomial_heap</code> 129 public 130 construct/copy/destruct</h3> 131<div class="orderedlist"><ol class="orderedlist" type="1"> 132<li class="listitem"> 133<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_18_6_1_1_1_1_23-bb"></a><span class="identifier">binomial_heap</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> 134<p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p> 135<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 136</li> 137<li class="listitem"> 138<pre class="literallayout"><a name="id-1_3_18_6_1_1_1_1_24-bb"></a><span class="identifier">binomial_heap</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 139<p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p> 140<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 141</li> 142<li class="listitem"> 143<pre class="literallayout"><a name="id-1_3_18_6_1_1_1_1_26-bb"></a><span class="identifier">binomial_heap</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 144<p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p> 145<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 146<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 147</li> 148<li class="listitem"> 149<pre class="literallayout"><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> <a name="id-1_3_18_6_1_1_1_1_25-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 150<p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p> 151<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 152</li> 153<li class="listitem"> 154<pre class="literallayout"><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> <a name="id-1_3_18_6_1_1_1_1_27-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 155<p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p> 156<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 157<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 158</li> 159<li class="listitem"><pre class="literallayout"><a name="id-1_3_18_6_1_1_1_1_28-bb"></a><span class="special">~</span><span class="identifier">binomial_heap</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li> 160</ol></div> 161</div> 162<div class="refsect2"> 163<a name="id-1.3.18.6.2.3.4.6"></a><h3> 164<a name="id-1_3_18_6_1_1_1_1_22-bb"></a><code class="computeroutput">binomial_heap</code> public member functions</h3> 165<div class="orderedlist"><ol class="orderedlist" type="1"> 166<li class="listitem"> 167<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_18_6_1_1_1_1_22_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="special">;</span></pre> 168<p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p> 169<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 170</li> 171<li class="listitem"> 172<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_1_1_1_1_22_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="special">;</span></pre> 173<p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p> 174<p><span class="bold"><strong>Complexity:</strong></span> Constant, if configured with constant_time_size<true>, otherwise linear. </p> 175</li> 176<li class="listitem"> 177<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_1_1_1_1_22_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="special">;</span></pre> 178<p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p> 179<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 180</li> 181<li class="listitem"> 182<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_4-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> 183<p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p> 184<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 185</li> 186<li class="listitem"> 187<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="id-1_3_18_6_1_1_1_1_22_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> 188<p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p> 189<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 190</li> 191<li class="listitem"> 192<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_6-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 193<p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p> 194<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 195</li> 196<li class="listitem"> 197<pre class="literallayout"><span class="identifier">const_reference</span> <a name="id-1_3_18_6_1_1_1_1_22_7-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> 198<p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p> 199<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 200</li> 201<li class="listitem"> 202<pre class="literallayout"><span class="identifier">handle_type</span> <a name="id-1_3_18_6_1_1_1_1_22_8-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> 203<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. Returns handle to element</p> 204<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 205</li> 206<li class="listitem"> 207<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="identifier">handle_type</span> <a name="id-1_3_18_6_1_1_1_1_22_9-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> 208<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place. Returns handle to element.</p> 209<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 210</li> 211<li class="listitem"> 212<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_10-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> 213<p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p> 214<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 215</li> 216<li class="listitem"> 217<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_11-bb"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> 218<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue.</p> 219<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 220</li> 221<li class="listitem"> 222<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_12-bb"></a><span class="identifier">update</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre> 223<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p> 224<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 225<p><span class="bold"><strong>Note:</strong></span> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </p> 226</li> 227<li class="listitem"> 228<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_13-bb"></a><span class="identifier">increase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> 229<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue.</p> 230<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 231<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one </p> 232</li> 233<li class="listitem"> 234<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_14-bb"></a><span class="identifier">increase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre> 235<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p> 236<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 237<p><span class="bold"><strong>Note:</strong></span> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </p> 238</li> 239<li class="listitem"> 240<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_15-bb"></a><span class="identifier">decrease</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> 241<p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue.</p> 242<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 243<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one </p> 244</li> 245<li class="listitem"> 246<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_16-bb"></a><span class="identifier">decrease</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre> 247<p><span class="bold"><strong>Effects:</strong></span> Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed.</p> 248<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 249<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one. If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </p> 250</li> 251<li class="listitem"> 252<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_17-bb"></a><span class="identifier">merge</span><span class="special">(</span><a class="link" href="binomial_heap.html" title="Class template binomial_heap">binomial_heap</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 253<p><span class="bold"><strong>Effects:</strong></span> Merge with priority queue rhs.</p> 254<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 255</li> 256<li class="listitem"> 257<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_1_1_1_1_22_18-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> 258<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p> 259<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 260</li> 261<li class="listitem"> 262<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_1_1_1_1_22_19-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> 263<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p> 264<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 265</li> 266<li class="listitem"> 267<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="id-1_3_18_6_1_1_1_1_22_20-bb"></a><span class="identifier">ordered_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> 268<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the first element contained in the priority queue.</p> 269<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p> 270</li> 271<li class="listitem"> 272<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="id-1_3_18_6_1_1_1_1_22_21-bb"></a><span class="identifier">ordered_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> 273<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the end of the priority queue.</p> 274<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p> 275</li> 276<li class="listitem"> 277<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_1_1_1_1_22_22-bb"></a><span class="identifier">erase</span><span class="special">(</span><span class="identifier">handle_type</span> handle<span class="special">)</span><span class="special">;</span></pre> 278<p><span class="bold"><strong>Effects:</strong></span> Removes the element handled by <code class="computeroutput">handle</code> from the <code class="computeroutput"><a class="link" href="priority_queue.html" title="Class template priority_queue">priority_queue</a></code>.</p> 279<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic. </p> 280</li> 281<li class="listitem"> 282<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_1_1_1_1_22_23-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> 283<p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p> 284</li> 285<li class="listitem"> 286<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_1_1_1_1_22_24-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> 287<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 288<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 289</li> 290<li class="listitem"> 291<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_1_1_1_1_22_25-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> 292<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 293<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 294</li> 295<li class="listitem"> 296<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_1_1_1_1_22_26-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> 297<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 298<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 299</li> 300<li class="listitem"> 301<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_1_1_1_1_22_27-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> 302<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 303<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 304</li> 305<li class="listitem"> 306<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_1_1_1_1_22_28-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> 307</li> 308<li class="listitem"> 309<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_1_1_1_1_22_29-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> 310</li> 311</ol></div> 312</div> 313<div class="refsect2"> 314<a name="id-1.3.18.6.2.3.4.7"></a><h3> 315<a name="id-1_3_18_6_1_1_1_1_29-bb"></a><code class="computeroutput">binomial_heap</code> public static functions</h3> 316<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="identifier">handle_type</span> <a name="id-1_3_18_6_1_1_1_1_29_1-bb"></a><span class="identifier">s_handle_from_iterator</span><span class="special">(</span><span class="identifier">iterator</span> <span class="keyword">const</span> <span class="special">&</span> it<span class="special">)</span><span class="special">;</span></pre></li></ol></div> 317</div> 318</div> 319</div> 320<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 321<td align="left"></td> 322<td align="right"><div class="copyright-footer">Copyright © 2010, 2011 Tim Blechmann<p> 323 Distributed under the Boost Software License, Version 1.0. (See accompanying 324 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>) 325 </p> 326</div></td> 327</tr></table> 328<hr> 329<div class="spirit-nav"> 330<a accesskey="p" href="../../heap/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.binomial_heap_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="d_ary_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 331</div> 332</body> 333</html> 334
