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 d_ary_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.d_ary_heap_hpp" title="Header <boost/heap/d_ary_heap.hpp>"> 10<link rel="prev" href="binomial_heap.html" title="Class template binomial_heap"> 11<link rel="next" href="fibonacci_heap.html" title="Class template fibonacci_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="binomial_heap.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.d_ary_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="fibonacci_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.heap.d_ary_heap"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template d_ary_heap</span></h2> 30<p>boost::heap::d_ary_heap — d-ary heap class </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.d_ary_heap_hpp" title="Header <boost/heap/d_ary_heap.hpp>">boost/heap/d_ary_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="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// <a class="link" href="d_ary_heap.html#boost.heap.d_ary_heaptypes">types</a></span> 39 <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.heap.d_ary_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.d_ary_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.d_ary_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.d_ary_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.d_ary_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.d_ary_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.d_ary_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.d_ary_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.d_ary_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="d_ary_heap.html#boost.heap.d_ary_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.d_ary_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.d_ary_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.d_ary_heap.handle_type"></a><span class="identifier">handle_type</span><span class="special">;</span> 52 53 <span class="comment">// <a class="link" href="d_ary_heap.html#boost.heap.d_ary_heapconstruct-copy-destruct">construct/copy/destruct</a></span> 54 <span class="keyword">explicit</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_23-bb"><span class="identifier">d_ary_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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_24-bb"><span class="identifier">d_ary_heap</span></a><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 56 <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_25-bb"><span class="identifier">d_ary_heap</span></a><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 57 <a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_26-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> 58 <a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_27-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 59 60 <span class="comment">// <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22-bb">public member functions</a></span> 61 <span class="keyword">bool</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_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> 62 <span class="identifier">size_type</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_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> 63 <span class="identifier">size_type</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_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> 64 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_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> 65 <span class="identifier">allocator_type</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_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> 66 <span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_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> 67 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">conditional</span><span class="special"><</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> 68 <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_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> 69 <span class="keyword">template</span><span class="special"><</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">></span> 70 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">conditional</span><span class="special"><</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> 71 <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_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> 72 <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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_9-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> 73 <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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_10-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> 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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_11-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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_12-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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_13-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="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_14-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">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_15-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> 79 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_16-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> 80 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_17-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> 81 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_18-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> 82 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_19-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> 83 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_20-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> 84 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_21-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> 85 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_22-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 86 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_23-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 87 <span class="identifier">const_iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_24-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> 88 <span class="identifier">iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_25-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 89 <span class="identifier">iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_26-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span> 90 <span class="identifier">const_iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_27-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> 91 <span class="identifier">ordered_iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_28-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> 92 <span class="identifier">ordered_iterator</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_29-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> 93 <span class="keyword">void</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_30-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> 94 <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_22_31-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> 95 96 <span class="comment">// <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_28-bb">public static functions</a></span> 97 <span class="keyword">static</span> <span class="identifier">handle_type</span> <a class="link" href="d_ary_heap.html#id-1_3_18_6_2_1_1_1_28_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> 98 99 <span class="comment">// public data members</span> 100 <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> 101 <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> 102 <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> 103 <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> 104 <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> 105<span class="special">}</span><span class="special">;</span></pre></div> 106<div class="refsect1"> 107<a name="id-1.3.18.6.3.3.4"></a><h2>Description</h2> 108<p>This class implements an immutable priority queue. Internally, the d-ary heap is represented as dynamically sized array (std::vector), that directly stores the values.</p> 109<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> 110<p>The container supports the following options:</p> 111<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 112<li class="listitem"><p><code class="computeroutput">boost::heap::arity<></code>, required</p></li> 113<li class="listitem"><p><code class="computeroutput">boost::heap::compare<></code>, defaults to <code class="computeroutput">compare<std::less<T></code> ></p></li> 114<li class="listitem"><p><code class="computeroutput">boost::heap::stable<></code>, defaults to <code class="computeroutput">stable<false></code> </p></li> 115<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> 116<li class="listitem"><p><code class="computeroutput">boost::heap::allocator<></code>, defaults to <code class="computeroutput">allocator<std::allocator<T></code> ></p></li> 117<li class="listitem"><p><code class="computeroutput">boost::heap::mutable_<></code>, defaults to <code class="computeroutput">mutable_<false></code> </p></li> 118</ul></div> 119<p> 120</p> 121<div class="refsect2"> 122<a name="id-1.3.18.6.3.3.4.5"></a><h3> 123<a name="boost.heap.d_ary_heaptypes"></a><code class="computeroutput">d_ary_heap</code> 124 public 125 types</h3> 126<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 127<p> 128<span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span> <a name="boost.heap.d_ary_heap.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p> 129<p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p> 130</li></ol></div> 131</div> 132<div class="refsect2"> 133<a name="id-1.3.18.6.3.3.4.6"></a><h3> 134<a name="boost.heap.d_ary_heapconstruct-copy-destruct"></a><code class="computeroutput">d_ary_heap</code> 135 public 136 construct/copy/destruct</h3> 137<div class="orderedlist"><ol class="orderedlist" type="1"> 138<li class="listitem"> 139<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_18_6_2_1_1_1_23-bb"></a><span class="identifier">d_ary_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> 140<p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p> 141<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 142</li> 143<li class="listitem"> 144<pre class="literallayout"><a name="id-1_3_18_6_2_1_1_1_24-bb"></a><span class="identifier">d_ary_heap</span><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 145<p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p> 146<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 147</li> 148<li class="listitem"> 149<pre class="literallayout"><a name="id-1_3_18_6_2_1_1_1_25-bb"></a><span class="identifier">d_ary_heap</span><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 150<p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p> 151<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 152<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 153</li> 154<li class="listitem"> 155<pre class="literallayout"><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span> <a name="id-1_3_18_6_2_1_1_1_26-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 156<p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p> 157<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 158<p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p> 159</li> 160<li class="listitem"> 161<pre class="literallayout"><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span> <a name="id-1_3_18_6_2_1_1_1_27-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 162<p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p> 163<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 164</li> 165</ol></div> 166</div> 167<div class="refsect2"> 168<a name="id-1.3.18.6.3.3.4.7"></a><h3> 169<a name="id-1_3_18_6_2_1_1_1_22-bb"></a><code class="computeroutput">d_ary_heap</code> public member functions</h3> 170<div class="orderedlist"><ol class="orderedlist" type="1"> 171<li class="listitem"> 172<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_18_6_2_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> 173<p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p> 174<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 175</li> 176<li class="listitem"> 177<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_2_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> 178<p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p> 179<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 180</li> 181<li class="listitem"> 182<pre class="literallayout"><span class="identifier">size_type</span> <a name="id-1_3_18_6_2_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> 183<p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p> 184<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 185</li> 186<li class="listitem"> 187<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_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> 188<p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p> 189<p><span class="bold"><strong>Complexity:</strong></span> Linear. </p> 190</li> 191<li class="listitem"> 192<pre class="literallayout"><span class="identifier">allocator_type</span> <a name="id-1_3_18_6_2_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> 193<p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</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">value_type</span> <span class="keyword">const</span> <span class="special">&</span> <a name="id-1_3_18_6_2_1_1_1_22_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> 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">boost</span><span class="special">::</span><span class="identifier">conditional</span><span class="special"><</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> 203<a name="id-1_3_18_6_2_1_1_1_22_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> 204<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue.</p> 205<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 206</li> 207<li class="listitem"> 208<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> 209 <span class="identifier">boost</span><span class="special">::</span><span class="identifier">conditional</span><span class="special"><</span> <span class="identifier">is_mutable</span><span class="special">,</span> <span class="identifier">handle_type</span><span class="special">,</span> <span class="keyword">void</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> 210 <a name="id-1_3_18_6_2_1_1_1_22_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> 211<p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. The element is directly constructed in-place.</p> 212<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 213</li> 214<li class="listitem"> 215<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_2_1_1_1_22_9-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> 216<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 217<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 218</li> 219<li class="listitem"> 220<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_2_1_1_1_22_10-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> 221<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 222<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 223</li> 224<li class="listitem"> 225<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="id-1_3_18_6_2_1_1_1_22_11-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> 226<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 227<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 228</li> 229<li class="listitem"> 230<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="id-1_3_18_6_2_1_1_1_22_12-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> 231<p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p> 232<p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p> 233</li> 234<li class="listitem"> 235<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> HeapType<span class="special">></span> <span class="keyword">bool</span> <a name="id-1_3_18_6_2_1_1_1_22_13-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> 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_2_1_1_1_22_14-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> 239</li> 240<li class="listitem"> 241<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_15-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> 242<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> 243<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 244<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 245</li> 246<li class="listitem"> 247<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_16-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> 248<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> 249<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 250<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> 251<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 252</li> 253<li class="listitem"> 254<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_17-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> 255<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> 256<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 257<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one</p> 258<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 259</li> 260<li class="listitem"> 261<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_18-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> 262<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> 263<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 264<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one. If this is not called, after a handle has been updated, the behavior of the data structure is undefined!</p> 265<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 266</li> 267<li class="listitem"> 268<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_19-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> 269<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> 270<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 271<p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one</p> 272<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 273</li> 274<li class="listitem"> 275<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_20-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> 276<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> 277<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 278<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> 279<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 280</li> 281<li class="listitem"> 282<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_21-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> 283<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> 284<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic.</p> 285<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 286</li> 287<li class="listitem"> 288<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_22-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> 289<p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p> 290<p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). Linear (worst case). </p> 291</li> 292<li class="listitem"> 293<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_23-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 294<p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p> 295<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 296</li> 297<li class="listitem"> 298<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_24-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> 299<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p> 300<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 301</li> 302<li class="listitem"> 303<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_25-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre> 304<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p> 305<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 306</li> 307<li class="listitem"> 308<pre class="literallayout"><span class="identifier">iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_26-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre> 309<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p> 310<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 311</li> 312<li class="listitem"> 313<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_27-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> 314<p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p> 315<p><span class="bold"><strong>Complexity:</strong></span> Constant. </p> 316</li> 317<li class="listitem"> 318<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_28-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> 319<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the first element contained in the priority queue.</p> 320<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p> 321</li> 322<li class="listitem"> 323<pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="id-1_3_18_6_2_1_1_1_22_29-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> 324<p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the end of the priority queue.</p> 325<p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p> 326</li> 327<li class="listitem"> 328<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_18_6_2_1_1_1_22_30-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> 329<p><span class="bold"><strong>Effects:</strong></span> Reserves memory for element_count elements</p> 330<p><span class="bold"><strong>Complexity:</strong></span> Linear.</p> 331<p><span class="bold"><strong>Node:</strong></span> Invalidates iterators </p> 332</li> 333<li class="listitem"> 334<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_2_1_1_1_22_31-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> 335<p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p> 336</li> 337</ol></div> 338</div> 339<div class="refsect2"> 340<a name="id-1.3.18.6.3.3.4.8"></a><h3> 341<a name="id-1_3_18_6_2_1_1_1_28-bb"></a><code class="computeroutput">d_ary_heap</code> public static functions</h3> 342<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 343<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">handle_type</span> <a name="id-1_3_18_6_2_1_1_1_28_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> 344<p><span class="bold"><strong>Effects:</strong></span> Casts an iterator to a node handle.</p> 345<p><span class="bold"><strong>Complexity:</strong></span> Constant.</p> 346<p><span class="bold"><strong>Requirement:</strong></span> data structure must be configured as mutable </p> 347</li></ol></div> 348</div> 349</div> 350</div> 351<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 352<td align="left"></td> 353<td align="right"><div class="copyright-footer">Copyright © 2010, 2011 Tim Blechmann<p> 354 Distributed under the Boost Software License, Version 1.0. (See accompanying 355 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>) 356 </p> 357</div></td> 358</tr></table> 359<hr> 360<div class="spirit-nav"> 361<a accesskey="p" href="binomial_heap.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.d_ary_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="fibonacci_heap.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 362</div> 363</body> 364</html> 365
