doc/html/boost/heap/pairing_heap.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template pairing_heap</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../heap/reference.html#header.boost.heap.pairing_heap_hpp" title="Header &lt;boost/heap/pairing_heap.hpp&gt;">
   9 <link rel="prev" href="heap_merge.html" title="Function template heap_merge">
  10 <link rel="next" href="compare.html" title="Struct template compare">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="heap_merge.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.pairing_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="compare.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.heap.pairing_heap"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template pairing_heap</span></h2>
  29 <p>boost::heap::pairing_heap &#8212; pairing heap </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../heap/reference.html#header.boost.heap.pairing_heap_hpp" title="Header &lt;boost/heap/pairing_heap.hpp&gt;">boost/heap/pairing_heap.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">class</span><span class="special">...</span> Options<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// <a class="link" href="pairing_heap.html#boost.heap.pairing_heaptypes">types</a></span>
  38   <span class="keyword">typedef</span> <span class="identifier">T</span>                                        <a name="boost.heap.pairing_heap.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">size_type</span>        <a name="boost.heap.pairing_heap.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">difference_type</span>  <a name="boost.heap.pairing_heap.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">value_compare</span>    <a name="boost.heap.pairing_heap.value_compare"></a><span class="identifier">value_compare</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">allocator_type</span>   <a name="boost.heap.pairing_heap.allocator_type"></a><span class="identifier">allocator_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">reference</span>        <a name="boost.heap.pairing_heap.reference"></a><span class="identifier">reference</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_reference</span>  <a name="boost.heap.pairing_heap.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">pointer</span>          <a name="boost.heap.pairing_heap.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  46   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_pointer</span>    <a name="boost.heap.pairing_heap.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  47   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span>         <a class="link" href="pairing_heap.html#boost.heap.pairing_heap.iterator"><span class="identifier">iterator</span></a><span class="special">;</span>
  48   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_iterator</span>   <a name="boost.heap.pairing_heap.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span>
  49   <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.pairing_heap.ordered_iterator"></a><span class="identifier">ordered_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">handle_type</span>      <a name="boost.heap.pairing_heap.handle_type"></a><span class="identifier">handle_type</span><span class="special">;</span>
  51
  52   <span class="comment">// <a class="link" href="pairing_heap.html#boost.heap.pairing_heapconstruct-copy-destruct">construct/copy/destruct</a></span>
  53   <span class="keyword">explicit</span> <a class="link" href="pairing_heap.html#idp76333216-bb"><span class="identifier">pairing_heap</span></a><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span>
  54   <a class="link" href="pairing_heap.html#idp76336544-bb"><span class="identifier">pairing_heap</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <a class="link" href="pairing_heap.html#idp76339600-bb"><span class="identifier">pairing_heap</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  56   <a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> <a class="link" href="pairing_heap.html#idp76343520-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  57   <a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> <a class="link" href="pairing_heap.html#idp76348016-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <a class="link" href="pairing_heap.html#idp76351696-bb"><span class="special">~</span><span class="identifier">pairing_heap</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  59
  60   <span class="comment">// <a class="link" href="pairing_heap.html#idp72853024-bb">public member functions</a></span>
  61   <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp72853584-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="pairing_heap.html#idp72857184-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="pairing_heap.html#idp102342304-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="pairing_heap.html#idp102345904-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="pairing_heap.html#idp102349232-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="keyword">void</span> <a class="link" href="pairing_heap.html#idp102352864-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  67   <span class="identifier">const_reference</span> <a class="link" href="pairing_heap.html#idp102356528-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>
  68   <span class="identifier">handle_type</span> <a class="link" href="pairing_heap.html#idp102360128-bb"><span class="identifier">push</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  69   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="identifier">handle_type</span> <a class="link" href="pairing_heap.html#idp102363472-bb"><span class="identifier">emplace</span></a><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span><span class="special">)</span><span class="special">;</span>
  70   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp102368080-bb"><span class="identifier">pop</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp102371424-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>
  72   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110265824-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>
  73   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110270560-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>
  74   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110276368-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>
  75   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110281104-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>
  76   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110286912-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>
  77   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110291696-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>
  78   <span class="identifier">iterator</span> <a class="link" href="pairing_heap.html#idp110296272-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>
  79   <span class="identifier">iterator</span> <a class="link" href="pairing_heap.html#idp110299872-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>
  80   <span class="identifier">ordered_iterator</span> <a class="link" href="pairing_heap.html#idp110303472-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>
  81   <span class="identifier">ordered_iterator</span> <a class="link" href="pairing_heap.html#idp110043712-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>
  82   <span class="keyword">void</span> <a class="link" href="pairing_heap.html#idp110047280-bb"><span class="identifier">merge</span></a><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  83   <span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a class="link" href="pairing_heap.html#idp110050960-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>
  84   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110053712-bb"><span class="keyword">operator</span><span class="special">&lt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  85   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110058624-bb"><span class="keyword">operator</span><span class="special">&gt;</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  86   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110063536-bb"><span class="keyword">operator</span><span class="special">&gt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  87   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110068448-bb"><span class="keyword">operator</span><span class="special">&lt;=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  88   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110073360-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  89   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="pairing_heap.html#idp110078432-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  90
  91   <span class="comment">// <a class="link" href="pairing_heap.html#idp76352672-bb">public static functions</a></span>
  92   <span class="keyword">static</span> <span class="identifier">handle_type</span> <a class="link" href="pairing_heap.html#idp76353232-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  93
  94   <span class="comment">// public data members</span>
  95   <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>
  96   <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>
  97   <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>
  98   <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>
  99   <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>
 100 <span class="special">}</span><span class="special">;</span></pre></div>
 101 <div class="refsect1">
 102 <a name="idp216698800"></a><h2>Description</h2>
 103 <p>Pairing heaps are self-adjusting binary heaps. Although design and implementation are rather simple, the complexity analysis is yet unsolved. For details, consult:</p>
 104 <p>Pettie, Seth (2005), "Towards a final analysis of pairing heaps", Proc. 46th Annual IEEE Symposium on Foundations of Computer Science, pp. 174-183</p>
 105 <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>
 106 <p>The container supports the following options:</p>
 107 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 108 <li class="listitem"><p><code class="computeroutput">boost::heap::compare&lt;&gt;</code>, defaults to <code class="computeroutput">compare&lt;std::less&lt;T&gt;</code> &gt;</p></li>
 109 <li class="listitem"><p><code class="computeroutput">boost::heap::stable&lt;&gt;</code>, defaults to <code class="computeroutput">stable&lt;false&gt;</code> </p></li>
 110 <li class="listitem"><p><code class="computeroutput">boost::heap::stability_counter_type&lt;&gt;</code>, defaults to <code class="computeroutput">stability_counter_type&lt;boost::uintmax_t&gt;</code> </p></li>
 111 <li class="listitem"><p><code class="computeroutput">boost::heap::allocator&lt;&gt;</code>, defaults to <code class="computeroutput">allocator&lt;std::allocator&lt;T&gt;</code> &gt;</p></li>
 112 <li class="listitem"><p><code class="computeroutput">boost::heap::constant_time_size&lt;&gt;</code>, defaults to <code class="computeroutput">constant_time_size&lt;true&gt;</code> </p></li>
 113 </ul></div>
 114 <p>
 115 </p>
 116 <div class="refsect2">
 117 <a name="idp216709904"></a><h3>
 118 <a name="boost.heap.pairing_heaptypes"></a><code class="computeroutput">pairing_heap</code>
 119         public
 120        types</h3>
 121 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 122 <p>
 123 <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">iterator</span> <a name="boost.heap.pairing_heap.iterator"></a><span class="identifier">iterator</span><span class="special">;</span></p>
 124 <p><span class="bold"><strong>Note:</strong></span> The iterator does not traverse the priority queue in order of the priorities. </p>
 125 </li></ol></div>
 126 </div>
 127 <div class="refsect2">
 128 <a name="idp216717648"></a><h3>
 129 <a name="boost.heap.pairing_heapconstruct-copy-destruct"></a><code class="computeroutput">pairing_heap</code>
 130         public
 131        construct/copy/destruct</h3>
 132 <div class="orderedlist"><ol class="orderedlist" type="1">
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp76333216-bb"></a><span class="identifier">pairing_heap</span><span class="special">(</span><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> cmp <span class="special">=</span> <span class="identifier">value_compare</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre>
 135 <p><span class="bold"><strong>Effects:</strong></span> constructs an empty priority queue.</p>
 136 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 137 </li>
 138 <li class="listitem">
 139 <pre class="literallayout"><a name="idp76336544-bb"></a><span class="identifier">pairing_heap</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 140 <p><span class="bold"><strong>Effects:</strong></span> copy-constructs priority queue from rhs.</p>
 141 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 142 </li>
 143 <li class="listitem">
 144 <pre class="literallayout"><a name="idp76339600-bb"></a><span class="identifier">pairing_heap</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 145 <p><span class="bold"><strong>Effects:</strong></span> C++11-style move constructor.</p>
 146 <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p>
 147 <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p>
 148 </li>
 149 <li class="listitem">
 150 <pre class="literallayout"><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> <a name="idp76343520-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 151 <p><span class="bold"><strong>Effects:</strong></span> C++11-style move assignment.</p>
 152 <p><span class="bold"><strong>Complexity:</strong></span> Constant.</p>
 153 <p><span class="bold"><strong>Note:</strong></span> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </p>
 154 </li>
 155 <li class="listitem">
 156 <pre class="literallayout"><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> <a name="idp76348016-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 157 <p><span class="bold"><strong>Effects:</strong></span> Assigns priority queue from rhs.</p>
 158 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 159 </li>
 160 <li class="listitem"><pre class="literallayout"><a name="idp76351696-bb"></a><span class="special">~</span><span class="identifier">pairing_heap</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre></li>
 161 </ol></div>
 162 </div>
 163 <div class="refsect2">
 164 <a name="idp216769696"></a><h3>
 165 <a name="idp72853024-bb"></a><code class="computeroutput">pairing_heap</code> public member functions</h3>
 166 <div class="orderedlist"><ol class="orderedlist" type="1">
 167 <li class="listitem">
 168 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp72853584-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>
 169 <p><span class="bold"><strong>Effects:</strong></span> Returns true, if the priority queue contains no elements.</p>
 170 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 171 </li>
 172 <li class="listitem">
 173 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp72857184-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>
 174 <p><span class="bold"><strong>Effects:</strong></span> Returns the number of elements contained in the priority queue.</p>
 175 <p><span class="bold"><strong>Complexity:</strong></span> Constant, if configured with constant_time_size&lt;true&gt;, otherwise linear. </p>
 176 </li>
 177 <li class="listitem">
 178 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp102342304-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>
 179 <p><span class="bold"><strong>Effects:</strong></span> Returns the maximum number of elements the priority queue can contain.</p>
 180 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 181 </li>
 182 <li class="listitem">
 183 <pre class="literallayout"><span class="keyword">void</span> <a name="idp102345904-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>
 184 <p><span class="bold"><strong>Effects:</strong></span> Removes all elements from the priority queue.</p>
 185 <p><span class="bold"><strong>Complexity:</strong></span> Linear. </p>
 186 </li>
 187 <li class="listitem">
 188 <pre class="literallayout"><span class="identifier">allocator_type</span> <a name="idp102349232-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>
 189 <p><span class="bold"><strong>Effects:</strong></span> Returns allocator.</p>
 190 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 191 </li>
 192 <li class="listitem">
 193 <pre class="literallayout"><span class="keyword">void</span> <a name="idp102352864-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 194 <p><span class="bold"><strong>Effects:</strong></span> Swaps two priority queues.</p>
 195 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 196 </li>
 197 <li class="listitem">
 198 <pre class="literallayout"><span class="identifier">const_reference</span> <a name="idp102356528-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>
 199 <p><span class="bold"><strong>Effects:</strong></span> Returns a const_reference to the maximum element.</p>
 200 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 201 </li>
 202 <li class="listitem">
 203 <pre class="literallayout"><span class="identifier">handle_type</span> <a name="idp102360128-bb"></a><span class="identifier">push</span><span class="special">(</span><span class="identifier">value_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> v<span class="special">)</span><span class="special">;</span></pre>
 204 <p><span class="bold"><strong>Effects:</strong></span> Adds a new element to the priority queue. Returns handle to element</p>
 205 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized). </p>
 206 </li>
 207 <li class="listitem">
 208 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span class="special">...</span> Args<span class="special">&gt;</span> <span class="identifier">handle_type</span> <a name="idp102363472-bb"></a><span class="identifier">emplace</span><span class="special">(</span><span class="identifier">Args</span> <span class="special">&amp;&amp;</span><span class="special">...</span> args<span class="special">)</span><span class="special">;</span></pre>
 209 <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>
 210 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized). </p>
 211 </li>
 212 <li class="listitem">
 213 <pre class="literallayout"><span class="keyword">void</span> <a name="idp102368080-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>
 214 <p><span class="bold"><strong>Effects:</strong></span> Removes the top element from the priority queue.</p>
 215 <p><span class="bold"><strong>Complexity:</strong></span> Logarithmic (amortized). </p>
 216 </li>
 217 <li class="listitem">
 218 <pre class="literallayout"><span class="keyword">void</span> <a name="idp102371424-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>
 219 <p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> &amp; updates the priority queue.</p>
 220 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized). </p>
 221 </li>
 222 <li class="listitem">
 223 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110265824-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>
 224 <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>
 225 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized).</p>
 226 <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>
 227 </li>
 228 <li class="listitem">
 229 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110270560-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>
 230 <p><span class="bold"><strong>Effects:</strong></span> Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> &amp; updates the priority queue.</p>
 231 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized).</p>
 232 <p><span class="bold"><strong>Note:</strong></span> The new value is expected to be greater than the current one </p>
 233 </li>
 234 <li class="listitem">
 235 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110276368-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>
 236 <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>
 237 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized).</p>
 238 <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>
 239 </li>
 240 <li class="listitem">
 241 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110281104-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>
 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> &amp; updates the priority queue.</p>
 243 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized).</p>
 244 <p><span class="bold"><strong>Note:</strong></span> The new value is expected to be less than the current one </p>
 245 </li>
 246 <li class="listitem">
 247 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110286912-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>
 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> 2**2*log(log(N)) (amortized).</p>
 250 <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>
 251 </li>
 252 <li class="listitem">
 253 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110291696-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>
 254 <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>
 255 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized). </p>
 256 </li>
 257 <li class="listitem">
 258 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp110296272-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>
 259 <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the first element contained in the priority queue.</p>
 260 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 261 </li>
 262 <li class="listitem">
 263 <pre class="literallayout"><span class="identifier">iterator</span> <a name="idp110299872-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>
 264 <p><span class="bold"><strong>Effects:</strong></span> Returns an iterator to the end of the priority queue.</p>
 265 <p><span class="bold"><strong>Complexity:</strong></span> Constant. </p>
 266 </li>
 267 <li class="listitem">
 268 <pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="idp110303472-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>
 269 <p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the first element contained in the priority queue.</p>
 270 <p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p>
 271 </li>
 272 <li class="listitem">
 273 <pre class="literallayout"><span class="identifier">ordered_iterator</span> <a name="idp110043712-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>
 274 <p><span class="bold"><strong>Effects:</strong></span> Returns an ordered iterator to the first element contained in the priority queue.</p>
 275 <p><span class="bold"><strong>Note:</strong></span> Ordered iterators traverse the priority queue in heap order. </p>
 276 </li>
 277 <li class="listitem">
 278 <pre class="literallayout"><span class="keyword">void</span> <a name="idp110047280-bb"></a><span class="identifier">merge</span><span class="special">(</span><a class="link" href="pairing_heap.html" title="Class template pairing_heap">pairing_heap</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 279 <p><span class="bold"><strong>Effects:</strong></span> Merge all elements from rhs into this</p>
 280 <p><span class="bold"><strong>Complexity:</strong></span> 2**2*log(log(N)) (amortized). </p>
 281 </li>
 282 <li class="listitem">
 283 <pre class="literallayout"><span class="identifier">value_compare</span> <span class="keyword">const</span> <span class="special">&amp;</span> <a name="idp110050960-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>
 284 <p><span class="bold"><strong>Effect:</strong></span> Returns the value_compare object used by the priority queue </p>
 285 </li>
 286 <li class="listitem">
 287 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110053712-bb"></a><span class="keyword">operator</span><span class="special">&lt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 288 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 289 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 290 </li>
 291 <li class="listitem">
 292 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110058624-bb"></a><span class="keyword">operator</span><span class="special">&gt;</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 293 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 294 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 295 </li>
 296 <li class="listitem">
 297 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110063536-bb"></a><span class="keyword">operator</span><span class="special">&gt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 298 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 299 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 300 </li>
 301 <li class="listitem">
 302 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110068448-bb"></a><span class="keyword">operator</span><span class="special">&lt;=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 303 <p><span class="bold"><strong>Returns:</strong></span> Element-wise comparison of heap data structures</p>
 304 <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 305 </li>
 306 <li class="listitem">
 307 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110073360-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are equivalent. <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 308 </li>
 309 <li class="listitem">
 310 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> HeapType<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idp110078432-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="identifier">HeapType</span> <span class="keyword">const</span> <span class="special">&amp;</span> rhs<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Equivalent comparison <span class="bold"><strong>Returns:</strong></span> True, if both heap data structures are not equivalent. <p><span class="bold"><strong>Requirement:</strong></span> the <code class="computeroutput">value_compare</code> object of both heaps must match. </p>
 311 </li>
 312 </ol></div>
 313 </div>
 314 <div class="refsect2">
 315 <a name="idp217033664"></a><h3>
 316 <a name="idp76352672-bb"></a><code class="computeroutput">pairing_heap</code> public static functions</h3>
 317 <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="idp76353232-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">&amp;</span> it<span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 318 </div>
 319 </div>
 320 </div>
 321 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 322 <td align="left"></td>
 323 <td align="right"><div class="copyright-footer">Copyright &#169; 2010, 2011 Tim Blechmann<p>
 324         Distributed under the Boost Software License, Version 1.0. (See accompanying
 325         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>)
 326       </p>
 327 </div></td>
 328 </tr></table>
 329 <hr>
 330 <div class="spirit-nav">
 331 <a accesskey="p" href="heap_merge.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.pairing_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="compare.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 332 </div>
 333 </body>
 334 </html>