boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template skew_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.skew_heap_hpp" title="Header <boost/heap/skew_heap.hpp>"> <link rel="prev" href="priority_queue.html" title="Class template priority_queue"> <link rel="next" href="skew_heap/implementation_defined.html" title="Struct implementation_defined"> </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="priority_queue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../heap/reference.html#header.boost.heap.skew_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="skew_heap/implementation_defined.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.heap.skew_heap"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template skew_heap</h2> boost::heap::skew_heap — skew heap </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.skew_heap_hpp" title="Header <boost/heap/skew_heap.hpp>">boost/heap/skew_heap.hpp</a>> template<typename T, class... Options> class <a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> { public: // <a class="link" href="skew_heap.html#boost.heap.skew_heaptypes">types</a> typedef T <a name="boost.heap.skew_heap.value_type"></a>value_type; typedef implementation_defined::size_type <a name="boost.heap.skew_heap.size_type"></a>size_type; typedef implementation_defined::difference_type <a name="boost.heap.skew_heap.difference_type"></a>difference_type; typedef implementation_defined::value_compare <a name="boost.heap.skew_heap.value_compare"></a>value_compare; typedef implementation_defined::allocator_type <a name="boost.heap.skew_heap.allocator_type"></a>allocator_type; typedef implementation_defined::reference <a name="boost.heap.skew_heap.reference"></a>reference; typedef implementation_defined::const_reference <a name="boost.heap.skew_heap.const_reference"></a>const_reference; typedef implementation_defined::pointer <a name="boost.heap.skew_heap.pointer"></a>pointer; typedef implementation_defined::const_pointer <a name="boost.heap.skew_heap.const_pointer"></a>const_pointer; typedef implementation_defined::iterator <a class="link" href="skew_heap.html#boost.heap.skew_heap.iterator">iterator</a>; typedef implementation_defined::const_iterator <a name="boost.heap.skew_heap.const_iterator"></a>const_iterator; typedef implementation_defined::ordered_iterator <a name="boost.heap.skew_heap.ordered_iterator"></a>ordered_iterator; typedef mpl::if_c< is_mutable, typename implementation_defined::handle_type, void * >::type <a name="boost.heap.skew_heap.handle_type"></a>handle_type; // member classes/structs/unions struct <a class="link" href="skew_heap/implementation_defined.html" title="Struct implementation_defined">implementation_defined</a> { // types typedef T <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.value_type">value_type</a>; typedef base_maker::compare_argument <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.value_compare">value_compare</a>; typedef base_maker::allocator_type <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.allocator_type">allocator_type</a>; typedef base_maker::node_type <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.node">node</a>; typedef allocator_type::pointer <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.node_pointer">node_pointer</a>; typedef allocator_type::const_pointer <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.const_node_pointer">const_node_pointer</a>; typedef unspecified <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.value_extractor">value_extractor</a>; typedef boost::array< node_pointer, 2 > <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.child_list_type">child_list_type</a>; typedef child_list_type::iterator <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.child_list_iterator">child_list_iterator</a>; typedef unspecified <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.iterator">iterator</a>; typedef iterator <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.const_iterator">const_iterator</a>; typedef unspecified <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.ordered_iterator">ordered_iterator</a>; typedef unspecified <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.reference">reference</a>; typedef unspecified <a class="link" href="skew_heap/implementation_defined.html#boost.heap.skew_heap.implementation_defined.handle_type">handle_type</a>; }; // <a class="link" href="skew_heap.html#boost.heap.skew_heapconstruct-copy-destruct">construct/copy/destruct</a> explicit <a class="link" href="skew_heap.html#idp107393632-bb">skew_heap</a>(value_compare const & = value_compare()); <a class="link" href="skew_heap.html#idp107397008-bb">skew_heap</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> const &); <a class="link" href="skew_heap.html#idp107403744-bb">skew_heap</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> &&); <a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> & <a class="link" href="skew_heap.html#idp107400064-bb">operator=</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> const &); <a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> & <a class="link" href="skew_heap.html#idp106744224-bb">operator=</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> &&); <a class="link" href="skew_heap.html#idp106748720-bb">~skew_heap</a>(void); // <a class="link" href="skew_heap.html#idp37373984-bb">public member functions</a> mpl::if_c< is_mutable, handle_type, void >::type <a class="link" href="skew_heap.html#idp37374544-bb">push</a>(value_type const &); template<typename... Args> mpl::if_c< is_mutable, handle_type, void >::type <a class="link" href="skew_heap.html#idp37377856-bb">emplace</a>(Args &&...); bool <a class="link" href="skew_heap.html#idp37382416-bb">empty</a>(void) const; size_type <a class="link" href="skew_heap.html#idp37386016-bb">size</a>(void) const; size_type <a class="link" href="skew_heap.html#idp37389584-bb">max_size</a>(void) const; void <a class="link" href="skew_heap.html#idp37393184-bb">clear</a>(void); allocator_type <a class="link" href="skew_heap.html#idp37396512-bb">get_allocator</a>(void) const; void <a class="link" href="skew_heap.html#idp37400144-bb">swap</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> &); const_reference <a class="link" href="skew_heap.html#idp37403808-bb">top</a>(void) const; void <a class="link" href="skew_heap.html#idp37407408-bb">pop</a>(void); iterator <a class="link" href="skew_heap.html#idp37410752-bb">begin</a>(void) const; iterator <a class="link" href="skew_heap.html#idp37414352-bb">end</a>(void) const; ordered_iterator <a class="link" href="skew_heap.html#idp42872560-bb">ordered_begin</a>(void) const; ordered_iterator <a class="link" href="skew_heap.html#idp42876128-bb">ordered_end</a>(void) const; void <a class="link" href="skew_heap.html#idp42879696-bb">merge</a>(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> &); value_compare const & <a class="link" href="skew_heap.html#idp42883376-bb">value_comp</a>(void) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42886128-bb">operator<</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42891040-bb">operator></a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42895952-bb">operator>=</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42900864-bb">operator<=</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42905776-bb">operator==</a>(HeapType const &) const; template<typename HeapType> bool <a class="link" href="skew_heap.html#idp42910848-bb">operator!=</a>(HeapType const &) const; void <a class="link" href="skew_heap.html#idp42915920-bb">erase</a>(handle_type); void <a class="link" href="skew_heap.html#idp107362608-bb">update</a>(handle_type, const_reference); void <a class="link" href="skew_heap.html#idp107367600-bb">update</a>(handle_type); void <a class="link" href="skew_heap.html#idp107372336-bb">increase</a>(handle_type, const_reference); void <a class="link" href="skew_heap.html#idp107378144-bb">increase</a>(handle_type); void <a class="link" href="skew_heap.html#idp107382880-bb">decrease</a>(handle_type, const_reference); void <a class="link" href="skew_heap.html#idp107388688-bb">decrease</a>(handle_type); // <a class="link" href="skew_heap.html#idp106749696-bb">public static functions</a> static handle_type <a class="link" href="skew_heap.html#idp106750256-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 is_stable; static const bool has_reserve; static const bool is_mutable; };</pre></div> <div class="refsect1"> <a name="idp218080608"></a><h2>Description</h2> 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::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::constant_time_size<></code>, defaults to <code class="computeroutput">constant_time_size<true></code> </li> <li class="listitem"><code class="computeroutput">boost::heap::store_parent_pointer<></code>, defaults to <code class="computeroutput">store_parent_pointer<true></code>. Maintaining a parent pointer adds some maintenance and size overhead, but iterating a heap is more efficient.</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="idp218094432"></a><h3> <a name="boost.heap.skew_heaptypes"></a><code class="computeroutput">skew_heap</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> typedef implementation_defined::iterator <a name="boost.heap.skew_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="idp218102176"></a><h3> <a name="boost.heap.skew_heapconstruct-copy-destruct"></a><code class="computeroutput">skew_heap</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">explicit <a name="idp107393632-bb"></a>skew_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="idp107397008-bb"></a>skew_heap(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> const & rhs);</pre> Effects: copy-constructs priority queue from rhs. Complexity: Linear. </li> <li class="listitem"> <pre class="literallayout"><a name="idp107403744-bb"></a>skew_heap(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_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="skew_heap.html" title="Class template skew_heap">skew_heap</a> & <a name="idp107400064-bb"></a>operator=(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> const & rhs);</pre> Effects: Assigns priority queue from rhs. Complexity: Linear. </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> & <a name="idp106744224-bb"></a>operator=(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_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 name="idp106748720-bb"></a>~skew_heap(void);</pre></li> </ol></div> </div> <div class="refsect2"> <a name="idp218154224"></a><h3> <a name="idp37373984-bb"></a><code class="computeroutput">skew_heap</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">mpl::if_c< is_mutable, handle_type, void >::type <a name="idp37374544-bb"></a>push(value_type const & v);</pre> Effects: Adds a new element to the priority queue. Complexity: Logarithmic (amortized). </li> <li class="listitem"> <pre class="literallayout">template<typename... Args> mpl::if_c< is_mutable, handle_type, void >::type <a name="idp37377856-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). </li> <li class="listitem"> <pre class="literallayout">bool <a name="idp37382416-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="idp37386016-bb"></a>size(void) const;</pre> Effects: Returns the number of elements contained in the priority queue. Complexity: Constant, if configured with constant_time_size<true>, otherwise linear. </li> <li class="listitem"> <pre class="literallayout">size_type <a name="idp37389584-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="idp37393184-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="idp37396512-bb"></a>get_allocator(void) const;</pre> Effects: Returns allocator. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp37400144-bb"></a>swap(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> & rhs);</pre> Effects: Swaps two priority queues. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">const_reference <a name="idp37403808-bb"></a>top(void) const;</pre> Effects: Returns a const_reference to the maximum element. Complexity: Constant. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp37407408-bb"></a>pop(void);</pre> Effects: Removes the top element from the priority queue. Complexity: Logarithmic (amortized). </li> <li class="listitem"> <pre class="literallayout">iterator <a name="idp37410752-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="idp37414352-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="idp42872560-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="idp42876128-bb"></a>ordered_end(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">void <a name="idp42879696-bb"></a>merge(<a class="link" href="skew_heap.html" title="Class template skew_heap">skew_heap</a> & rhs);</pre> Effects: Merge all elements from rhs into this Complexity: Logarithmic (amortized). </li> <li class="listitem"> <pre class="literallayout">value_compare const & <a name="idp42883376-bb"></a>value_comp(void) const;</pre> Effect: Returns the value_compare object used by the priority queue </li> <li class="listitem"> <pre class="literallayout">template<typename HeapType> bool <a name="idp42886128-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="idp42891040-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="idp42895952-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="idp42900864-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="idp42905776-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="idp42910848-bb"></a>operator!=(HeapType const & rhs) const<span class="special"