boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template d_ary_heap</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../heap/reference.html#header.boost.heap.d_ary_heap_hpp" title="Header <boost/heap/d_ary_heap.hpp>"> <link rel="prev" href="binomial_heap.html" title="Class template binomial_heap"> <link rel="next" href="fibonacci_heap.html" title="Class template fibonacci_heap"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="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> </div> <div class="refentry"> <a name="boost.heap.d_ary_heap"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template d_ary_heap</h2> boost::heap::d_ary_heap — d-ary heap class </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// 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>> template<typename T, class... Options> class <a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> { public: // <a class="link" href="d_ary_heap.html#boost.heap.d_ary_heaptypes">types</a> typedef T <a name="boost.heap.d_ary_heap.value_type"></a>value_type; typedef implementation_defined::size_type <a name="boost.heap.d_ary_heap.size_type"></a>size_type; typedef implementation_defined::difference_type <a name="boost.heap.d_ary_heap.difference_type"></a>difference_type; typedef implementation_defined::value_compare <a name="boost.heap.d_ary_heap.value_compare"></a>value_compare; typedef implementation_defined::allocator_type <a name="boost.heap.d_ary_heap.allocator_type"></a>allocator_type; typedef implementation_defined::reference <a name="boost.heap.d_ary_heap.reference"></a>reference; typedef implementation_defined::const_reference <a name="boost.heap.d_ary_heap.const_reference"></a>const_reference; typedef implementation_defined::pointer <a name="boost.heap.d_ary_heap.pointer"></a>pointer; typedef implementation_defined::const_pointer <a name="boost.heap.d_ary_heap.const_pointer"></a>const_pointer; typedef implementation_defined::iterator <a class="link" href="d_ary_heap.html#boost.heap.d_ary_heap.iterator">iterator</a>; typedef implementation_defined::const_iterator <a name="boost.heap.d_ary_heap.const_iterator"></a>const_iterator; typedef implementation_defined::ordered_iterator <a name="boost.heap.d_ary_heap.ordered_iterator"></a>ordered_iterator; typedef implementation_defined::handle_type <a name="boost.heap.d_ary_heap.handle_type"></a>handle_type; // <a class="link" href="d_ary_heap.html#boost.heap.d_ary_heapconstruct-copy-destruct">construct/copy/destruct</a> explicit <a class="link" href="d_ary_heap.html#idp98775584-bb">d_ary_heap</a>(value_compare const & = value_compare()); <a class="link" href="d_ary_heap.html#idp98778912-bb">d_ary_heap</a>(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> const &); <a class="link" href="d_ary_heap.html#idp98781968-bb">d_ary_heap</a>(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> &&); <a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> & <a class="link" href="d_ary_heap.html#idp98785840-bb">operator=</a>(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> &&); <a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> & <a class="link" href="d_ary_heap.html#idp98790288-bb">operator=</a>(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> const &); // <a class="link" href="d_ary_heap.html#idp94291024-bb">public member functions</a> bool <a class="link" href="d_ary_heap.html#idp94291584-bb">empty</a>(void) const; size_type <a class="link" href="d_ary_heap.html#idp94295184-bb">size</a>(void) const; size_type <a class="link" href="d_ary_heap.html#idp94298784-bb">max_size</a>(void) const; void <a class="link" href="d_ary_heap.html#idp94302384-bb">clear</a>(void); allocator_type <a class="link" href="d_ary_heap.html#idp110161664-bb">get_allocator</a>(void) const; value_type const & <a class="link" href="d_ary_heap.html#idp110165296-bb">top</a>(void) const; mpl::if_c< is_mutable, handle_type, void >::type <a class="link" href="d_ary_heap.html#idp110168896-bb">push</a>(value_type const &); template<class... Args> mpl::if_c< is_mutable, handle_type, void >::type <a class="link" href="d_ary_heap.html#idp110172160-bb">emplace</a>(Args &&...); template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp110176672-bb">operator<</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp110181536-bb">operator></a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp54920848-bb">operator>=</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp54925712-bb">operator<=</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp54930576-bb">operator==</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="d_ary_heap.html#idp54935600-bb">operator!=</a>(HeapType const &) const; void <a class="link" href="d_ary_heap.html#idp54940624-bb">update</a>(handle_type, const_reference); void <a class="link" href="d_ary_heap.html#idp114533232-bb">update</a>(handle_type); void <a class="link" href="d_ary_heap.html#idp114538768-bb">increase</a>(handle_type, const_reference); void <a class="link" href="d_ary_heap.html#idp114545280-bb">increase</a>(handle_type); void <a class="link" href="d_ary_heap.html#idp114550864-bb">decrease</a>(handle_type, const_reference); void <a class="link" href="d_ary_heap.html#idp101042720-bb">decrease</a>(handle_type); void <a class="link" href="d_ary_heap.html#idp101048304-bb">erase</a>(handle_type); void <a class="link" href="d_ary_heap.html#idp101053584-bb">pop</a>(void); void <a class="link" href="d_ary_heap.html#idp101056880-bb">swap</a>(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> &); const_iterator <a class="link" href="d_ary_heap.html#idp101060496-bb">begin</a>(void) const; iterator <a class="link" href="d_ary_heap.html#idp110728784-bb">begin</a>(void); iterator <a class="link" href="d_ary_heap.html#idp110732112-bb">end</a>(void); const_iterator <a class="link" href="d_ary_heap.html#idp110735440-bb">end</a>(void) const; ordered_iterator <a class="link" href="d_ary_heap.html#idp110739040-bb">ordered_begin</a>(void) const; ordered_iterator <a class="link" href="d_ary_heap.html#idp110742608-bb">ordered_end</a>(void) const; void <a class="link" href="d_ary_heap.html#idp110746176-bb">reserve</a>(size_type); value_compare const & <a class="link" href="d_ary_heap.html#idp110750352-bb">value_comp</a>(void) const; // <a class="link" href="d_ary_heap.html#idp98793920-bb">public static functions</a> static handle_type <a class="link" href="d_ary_heap.html#idp98794480-bb">s_handle_from_iterator</a>(iterator const &); // public data members static const bool constant_time_size; static const bool has_ordered_iterators; static const bool is_mergable; static const bool has_reserve; static const bool is_stable; };</pre></div> <div class="refsect1"> <a name="idp215052464"></a><h2>Description</h2> 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. 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. The container supports the following options: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><code class="computeroutput">boost::heap::arity<></code>, required</li> <li class="listitem"><code class="computeroutput">boost::heap::compare<></code>, defaults to <code class="computeroutput">compare<std::less<T></code> ></li> <li class="listitem"><code class="computeroutput">boost::heap::stable<></code>, defaults to <code class="computeroutput">stable<false></code> </li> <li class="listitem"><code class="computeroutput">boost::heap::stability_counter_type<></code>, defaults to <code class="computeroutput">stability_counter_type<boost::uintmax_t></code> </li> <li class="listitem"><code class="computeroutput">boost::heap::allocator<></code>, defaults to <code class="computeroutput">allocator<std::allocator<T></code> ></li> <li class="listitem"><code class="computeroutput">boost::heap::mutable_<></code>, defaults to <code class="computeroutput">mutable_<false></code> </li> </ul></div> <div class="refsect2"> <a name="idp215064112"></a><h3> <a name="boost.heap.d_ary_heaptypes"></a><code class="computeroutput">d_ary_heap</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> typedef implementation_defined::iterator <a name="boost.heap.d_ary_heap.iterator"></a>iterator; Note: The iterator does not traverse the priority queue in order of the priorities. </li></ol></div> </div> <div class="refsect2"> <a name="idp215071856"></a><h3> <a name="boost.heap.d_ary_heapconstruct-copy-destruct"></a><code class="computeroutput">d_ary_heap</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">explicit <a name="idp98775584-bb"></a>d_ary_heap(value_compare const & cmp = value_compare());</pre> Effects: constructs an empty priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout"><a name="idp98778912-bb"></a>d_ary_heap(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> const & rhs);</pre> Effects: copy-constructs priority queue from rhs. Complexity: Linear. </li> <li class="listitem"> <pre class="literallayout"><a name="idp98781968-bb"></a>d_ary_heap(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> && rhs);</pre> Effects: C++11-style move constructor. Complexity: Constant. Note: Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> & <a name="idp98785840-bb"></a>operator=(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> && rhs);</pre> Effects: C++11-style move assignment. Complexity: Constant. Note: Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> & <a name="idp98790288-bb"></a>operator=(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> const & rhs);</pre> Effects: Assigns priority queue from rhs. Complexity: Linear. </li> </ol></div> </div> <div class="refsect2"> <a name="idp215119184"></a><h3> <a name="idp94291024-bb"></a><code class="computeroutput">d_ary_heap</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">bool <a name="idp94291584-bb"></a>empty(void) const;</pre> Effects: Returns true, if the priority queue contains no elements. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">size_type <a name="idp94295184-bb"></a>size(void) const;</pre> Effects: Returns the number of elements contained in the priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">size_type <a name="idp94298784-bb"></a>max_size(void) const;</pre> Effects: Returns the maximum number of elements the priority queue can contain. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp94302384-bb"></a>clear(void);</pre> Effects: Removes all elements from the priority queue. Complexity: Linear. </li> <li class="listitem"> <pre class="literallayout">allocator_type <a name="idp110161664-bb"></a>get_allocator(void) const;</pre> Effects: Returns allocator. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">value_type const & <a name="idp110165296-bb"></a>top(void) const;</pre> Effects: Returns a const_reference to the maximum element. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">mpl::if_c< is_mutable, handle_type, void >::type <a name="idp110168896-bb"></a>push(value_type const & v);</pre> Effects: Adds a new element to the priority queue. Complexity: Logarithmic (amortized). Linear (worst case). </li> <li class="listitem"> <pre class="literallayout">template<class... Args> mpl::if_c< is_mutable, handle_type, void >::type <a name="idp110172160-bb"></a>emplace(Args &&... args);</pre> Effects: Adds a new element to the priority queue. The element is directly constructed in-place. Complexity: Logarithmic (amortized). Linear (worst case). </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp110176672-bb"></a>operator<(HeapType const & rhs) const;</pre> Returns: Element-wise comparison of heap data structures Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp110181536-bb"></a>operator>(HeapType const & rhs) const;</pre> Returns: Element-wise comparison of heap data structures Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp54920848-bb"></a>operator>=(HeapType const & rhs) const;</pre> Returns: Element-wise comparison of heap data structures Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp54925712-bb"></a>operator<=(HeapType const & rhs) const;</pre> Returns: Element-wise comparison of heap data structures Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp54930576-bb"></a>operator==(HeapType const & rhs) const;</pre>Equivalent comparison Returns: True, if both heap data structures are equivalent. Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp54935600-bb"></a>operator!=(HeapType const & rhs) const;</pre>Equivalent comparison Returns: True, if both heap data structures are not equivalent. Requirement: the <code class="computeroutput">value_compare</code> object of both heaps must match. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp54940624-bb"></a>update(handle_type handle, const_reference v);</pre> Effects: Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue. Complexity: Logarithmic. Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp114533232-bb"></a>update(handle_type handle);</pre> Effects: Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed. Complexity: Logarithmic. Note: If this is not called, after a handle has been updated, the behavior of the data structure is undefined! Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp114538768-bb"></a>increase(handle_type handle, const_reference v);</pre> Effects: Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue. Complexity: Logarithmic. Note: The new value is expected to be greater than the current one Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp114545280-bb"></a>increase(handle_type handle);</pre> Effects: Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed. Complexity: Logarithmic. Note: 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! Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp114550864-bb"></a>decrease(handle_type handle, const_reference v);</pre> Effects: Assigns <code class="computeroutput">v</code> to the element handled by <code class="computeroutput">handle</code> & updates the priority queue. Complexity: Logarithmic. Note: The new value is expected to be less than the current one Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp101042720-bb"></a>decrease(handle_type handle);</pre> Effects: Updates the heap after the element handled by <code class="computeroutput">handle</code> has been changed. Complexity: Logarithmic. Note: 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! Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp101048304-bb"></a>erase(handle_type handle);</pre> Effects: 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>. Complexity: Logarithmic. Requirement: data structure must be configured as mutable </li> <li class="listitem"> <pre class="literallayout">void <a name="idp101053584-bb"></a>pop(void);</pre> Effects: Removes the top element from the priority queue. Complexity: Logarithmic (amortized). Linear (worst case). </li> <li class="listitem"> <pre class="literallayout">void <a name="idp101056880-bb"></a>swap(<a class="link" href="d_ary_heap.html" title="Class template d_ary_heap">d_ary_heap</a> & rhs);</pre> Effects: Swaps two priority queues. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp101060496-bb"></a>begin(void) const;</pre> Effects: Returns an iterator to the first element contained in the priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">iterator <a name="idp110728784-bb"></a>begin(void);</pre> Effects: Returns an iterator to the first element contained in the priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">iterator <a name="idp110732112-bb"></a>end(void);</pre> Effects: Returns an iterator to the end of the priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_iterator <a name="idp110735440-bb"></a>end(void) const;</pre> Effects: Returns an iterator to the end of the priority queue. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">ordered_iterator <a name="idp110739040-bb"></a>ordered_begin(void) const;</pre> Effects: Returns an ordered iterator to the first element contained in the priority queue. Note: Ordered iterators traverse the priority queue in heap order. </li> <li class="listitem"> <pre class="literallayout">ordered_iterator <a name="idp110742608-bb"></a>ordered_end(void) const;</pre> Effects: Returns an ordered iterator to the end of the priority queue. Note: Ordered iterators traverse the priority queue in heap order. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp110746176-bb"></a>reserve(size_type element_count);</pre> Effects: Reserves memory for element_count elements Complexity: Linear. Node: Invalidates iterators </li> <li class="listitem"> <pre class="lite