673 lines
119 KiB
XML
673 lines
119 KiB
XML
<?xml version="1.0" standalone="yes"?>
|
|
<library-reference><header name="boost/heap/binomial_heap.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="binomial_heap"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>binomial heap </purpose><description><para>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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::constant_time_size<></computeroutput>, defaults to <computeroutput>constant_time_size<true></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type>implementation_defined::ordered_iterator</type></typedef>
|
|
<typedef name="handle_type"><type>implementation_defined::handle_type</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="empty" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant, if configured with constant_time_size<true>, otherwise linear. </para></description></method>
|
|
<method name="max_size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="swap"><type>void</type><parameter name="rhs"><paramtype><classname>binomial_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>const_reference</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="push"><type>handle_type</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. Returns handle to element</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="emplace"><type>handle_type</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place. Returns handle to element.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be greater than the current one </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be less than the current one </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> 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! </para></description></method>
|
|
<method name="merge"><type>void</type><parameter name="rhs"><paramtype><classname>binomial_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Merge with priority queue rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="begin" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="ordered_begin" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="ordered_end" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the end of the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="erase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the element handled by <computeroutput>handle</computeroutput> from the <classname alt="boost::heap::priority_queue">priority_queue</classname>.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>binomial_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<copy-assignment><type><classname>binomial_heap</classname> &</type><parameter name="rhs"><paramtype><classname>binomial_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
<constructor><parameter name="rhs"><paramtype><classname>binomial_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment><type><classname>binomial_heap</classname> &</type><parameter name="rhs"><paramtype><classname>binomial_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<destructor><parameter name=""><paramtype>void</paramtype></parameter></destructor>
|
|
<method-group name="public static functions">
|
|
<method name="s_handle_from_iterator" specifiers="static"><type>handle_type</type><parameter name="it"><paramtype>iterator const &</paramtype></parameter></method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/d_ary_heap.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="d_ary_heap"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>d-ary heap class </purpose><description><para>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.</para><para>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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::arity<></computeroutput>, required</para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::mutable_<></computeroutput>, defaults to <computeroutput>mutable_<false></computeroutput> </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type>implementation_defined::ordered_iterator</type></typedef>
|
|
<typedef name="handle_type"><type>implementation_defined::handle_type</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="empty" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="max_size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>value_type const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="push"><type>boost::conditional< is_mutable, handle_type, void >::type</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="emplace"><type>boost::conditional< is_mutable, handle_type, void >::type</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined!</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be greater than the current one</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> 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!</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be less than the current one</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> 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!</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="erase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the element handled by <computeroutput>handle</computeroutput> from the <classname alt="boost::heap::priority_queue">priority_queue</classname>.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="swap"><type>void</type><parameter name="rhs"><paramtype><classname>d_ary_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="begin" cv="const"><type>const_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="begin"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const"><type>const_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="ordered_begin" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="ordered_end" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the end of the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="reserve"><type>void</type><parameter name="element_count"><paramtype>size_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Reserves memory for element_count elements</para><para><emphasis role="bold">Complexity:</emphasis> Linear.</para><para><emphasis role="bold">Node:</emphasis> Invalidates iterators </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>d_ary_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>d_ary_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment><type><classname>d_ary_heap</classname> &</type><parameter name="rhs"><paramtype><classname>d_ary_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<copy-assignment><type><classname>d_ary_heap</classname> &</type><parameter name="rhs"><paramtype><classname>d_ary_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
<method-group name="public static functions">
|
|
<method name="s_handle_from_iterator" specifiers="static"><type>handle_type</type><parameter name="it"><paramtype>iterator const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Casts an iterator to a node handle.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/fibonacci_heap.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="fibonacci_heap"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>fibonacci heap </purpose><description><para>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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::constant_time_size<></computeroutput>, defaults to <computeroutput>constant_time_size<true></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type>implementation_defined::ordered_iterator</type></typedef>
|
|
<typedef name="handle_type"><type>implementation_defined::handle_type</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="empty" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="max_size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="swap"><type>void</type><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>value_type const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="push"><type>handle_type</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. Returns handle to element</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Does not invalidate iterators. </para></description></method>
|
|
<method name="emplace"><type>handle_type</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place. Returns handle to element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Does not invalidate iterators. </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic if current value < v, Constant otherwise. </para></description></method>
|
|
<method name="update_lazy"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic if current value < v, Constant otherwise.</para><para><emphasis role="bold">Rationale:</emphasis> The lazy update function is a modification of the traditional update, that just invalidates the iterator to the object referred to by the handle. </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="update_lazy"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><purpose>(handle_type handle) </purpose><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic if current value < v, Constant otherwise. (handle_type handle)</para><para><emphasis role="bold">Rationale:</emphasis> The lazy update function is a modification of the traditional update, that just invalidates the iterator to the object referred to by the handle. </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be greater than the current one </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be less than the current one </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic.</para><para><emphasis role="bold">Note:</emphasis> 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! </para></description></method>
|
|
<method name="erase"><type>void</type><parameter name="handle"><paramtype>handle_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the element handled by <computeroutput>handle</computeroutput> from the <classname alt="boost::heap::priority_queue">priority_queue</classname>.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic. </para></description></method>
|
|
<method name="begin" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="ordered_begin" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="ordered_end" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the end of the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="merge"><type>void</type><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Merge with priority queue rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment><type><classname>fibonacci_heap</classname> &</type><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<copy-assignment><type><classname>fibonacci_heap</classname> &</type><parameter name="rhs"><paramtype><classname>fibonacci_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
<destructor><parameter name=""><paramtype>void</paramtype></parameter></destructor>
|
|
<method-group name="public static functions">
|
|
<method name="s_handle_from_iterator" specifiers="static"><type>handle_type</type><parameter name="it"><paramtype>iterator const &</paramtype></parameter></method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/heap_concepts.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<struct name="MergablePriorityQueue"><template>
|
|
<template-type-parameter name="C"/>
|
|
</template><inherit access="public">boost::heap::PriorityQueue< C ></inherit><method-group name="public member functions">
|
|
<method name="BOOST_CONCEPT_USAGE"><type/><parameter name=""><paramtype>MergablePriorityQueue</paramtype></parameter></method>
|
|
<method name="BOOST_CONCEPT_USAGE"><type/><parameter name=""><paramtype>PriorityQueue</paramtype></parameter></method>
|
|
</method-group>
|
|
<typedef name="iterator"><type>C::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>C::const_iterator</type></typedef>
|
|
<typedef name="allocator_type"><type>C::allocator_type</type></typedef>
|
|
<typedef name="value_compare"><type>C::value_compare</type></typedef>
|
|
<typedef name="value_type"><type>C::value_type</type></typedef>
|
|
<typedef name="const_reference"><type>C::const_reference</type></typedef>
|
|
</struct><struct name="MutablePriorityQueue"><template>
|
|
<template-type-parameter name="C"/>
|
|
</template><inherit access="public">boost::heap::PriorityQueue< C ></inherit><typedef name="handle_type"><type>C::handle_type</type></typedef>
|
|
<typedef name="iterator"><type>C::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>C::const_iterator</type></typedef>
|
|
<typedef name="allocator_type"><type>C::allocator_type</type></typedef>
|
|
<typedef name="value_compare"><type>C::value_compare</type></typedef>
|
|
<typedef name="value_type"><type>C::value_type</type></typedef>
|
|
<typedef name="const_reference"><type>C::const_reference</type></typedef>
|
|
<data-member name="c"><type>C</type></data-member>
|
|
<data-member name="equal"><type>bool</type></data-member>
|
|
<data-member name="not_equal"><type>bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="BOOST_CONCEPT_USAGE"><type/><parameter name=""><paramtype>MutablePriorityQueue</paramtype></parameter></method>
|
|
<method name="BOOST_CONCEPT_USAGE"><type/><parameter name=""><paramtype>PriorityQueue</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct><struct name="PriorityQueue"><template>
|
|
<template-type-parameter name="C"/>
|
|
</template><inherit access="public">boost::ForwardContainer< C ></inherit><typedef name="iterator"><type>C::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>C::const_iterator</type></typedef>
|
|
<typedef name="allocator_type"><type>C::allocator_type</type></typedef>
|
|
<typedef name="value_compare"><type>C::value_compare</type></typedef>
|
|
<typedef name="value_type"><type>C::value_type</type></typedef>
|
|
<typedef name="const_reference"><type>C::const_reference</type></typedef>
|
|
<method-group name="public member functions">
|
|
<method name="BOOST_CONCEPT_USAGE"><type/><parameter name=""><paramtype>PriorityQueue</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/heap_merge.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<function name="heap_merge"><type>void</type><template>
|
|
<template-type-parameter name="Heap1"/>
|
|
<template-type-parameter name="Heap2"/>
|
|
</template><parameter name="lhs"><paramtype>Heap1 &</paramtype></parameter><parameter name="rhs"><paramtype>Heap2 &</paramtype></parameter><description><para>merge rhs into lhs</para><para><emphasis role="bold">Effect:</emphasis> lhs contains all elements that have been part of rhs, rhs is empty. </para></description></function>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/pairing_heap.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="pairing_heap"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>pairing heap </purpose><description><para>Pairing heaps are self-adjusting binary heaps. Although design and implementation are rather simple, the complexity analysis is yet unsolved. For details, consult:</para><para>Pettie, Seth (2005), "Towards a final analysis of pairing heaps", Proc. 46th Annual IEEE Symposium on Foundations of Computer Science, pp. 174-183</para><para>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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::constant_time_size<></computeroutput>, defaults to <computeroutput>constant_time_size<true></computeroutput> </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type>implementation_defined::ordered_iterator</type></typedef>
|
|
<typedef name="handle_type"><type>implementation_defined::handle_type</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="empty" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant, if configured with constant_time_size<true>, otherwise linear. </para></description></method>
|
|
<method name="max_size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="swap"><type>void</type><parameter name="rhs"><paramtype><classname>pairing_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>const_reference</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="push"><type>handle_type</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. Returns handle to element<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized). </para></description></method>
|
|
<method name="emplace"><type>handle_type</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place. Returns handle to element.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized). </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized). </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized).</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized).</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be greater than the current one </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized).</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized).</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be less than the current one </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized).</para><para><emphasis role="bold">Note:</emphasis> 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! </para></description></method>
|
|
<method name="erase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the element handled by <computeroutput>handle</computeroutput> from the <classname alt="boost::heap::priority_queue">priority_queue</classname>.<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized). </para></description></method>
|
|
<method name="begin" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="ordered_begin" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="ordered_end" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="merge"><type>void</type><parameter name="rhs"><paramtype><classname>pairing_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Merge all elements from rhs into this<emphasis role="bold">Complexity:</emphasis> 2**2*log(log(N)) (amortized). </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>pairing_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>pairing_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment><type><classname>pairing_heap</classname> &</type><parameter name="rhs"><paramtype><classname>pairing_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<copy-assignment><type><classname>pairing_heap</classname> &</type><parameter name="rhs"><paramtype><classname>pairing_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
<destructor><parameter name=""><paramtype>void</paramtype></parameter></destructor>
|
|
<method-group name="public static functions">
|
|
<method name="s_handle_from_iterator" specifiers="static"><type>handle_type</type><parameter name="it"><paramtype>iterator const &</paramtype></parameter></method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/policies.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<struct name="allocator"><template>
|
|
<template-type-parameter name="T"/>
|
|
</template><purpose>Specifies allocator for the internal memory management. </purpose></struct><struct name="arity"><template>
|
|
<template-nontype-parameter name="T"><type>unsigned int</type></template-nontype-parameter>
|
|
</template><purpose>Specify arity. </purpose><description><para>Specifies the arity of a D-ary heap </para></description></struct><struct name="compare"><template>
|
|
<template-type-parameter name="T"/>
|
|
</template><purpose>Specifies the predicate for the heap order. </purpose></struct><struct name="constant_time_size"><template>
|
|
<template-nontype-parameter name="T"><type>bool</type></template-nontype-parameter>
|
|
</template><purpose>Configures complexity of <computeroutput> size() </computeroutput> </purpose><description><para>Specifies, whether size() should have linear or constant complexity. </para></description></struct><struct name="mutable_"><template>
|
|
<template-nontype-parameter name="T"><type>bool</type></template-nontype-parameter>
|
|
</template><purpose>Configure heap as mutable. </purpose><description><para>Certain heaps need to be configured specifically do be mutable. </para></description></struct><struct name="stability_counter_type"><template>
|
|
<template-type-parameter name="IntType"/>
|
|
</template><purpose>Specifies the type for stability counter. </purpose></struct><struct name="stable"><template>
|
|
<template-nontype-parameter name="T"><type>bool</type></template-nontype-parameter>
|
|
</template><purpose>Configure a heap as <emphasis role="bold">stable</emphasis>. </purpose><description><para>A priority queue is stable, if elements with the same priority are popped from the heap, in the same order as they are inserted. </para></description></struct><struct name="store_parent_pointer"><template>
|
|
<template-nontype-parameter name="T"><type>bool</type></template-nontype-parameter>
|
|
</template><purpose>Store parent pointer in heap node. </purpose><description><para>Maintaining a parent pointer adds some maintenance and size overhead, but iterating a heap is more efficient. </para></description></struct>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/priority_queue.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="priority_queue"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>priority queue, based on stl heap functions </purpose><description><para>The <classname alt="boost::heap::priority_queue">priority_queue</classname> class is a wrapper for the stl heap functions.<sbr/>
|
|
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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> > </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="empty" cv="const noexcept"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const noexcept"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="max_size" cv="const noexcept"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear" cv="noexcept"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>const_reference</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="push"><type>void</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="emplace"><type>void</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). Linear (worst case). </para></description></method>
|
|
<method name="swap" cv="noexcept(boost::is_nothrow_move_constructible< super_t >::value &&boost::is_nothrow_move_assignable< super_t >::value))"><type>void</type><parameter name="rhs"><paramtype><classname>priority_queue</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="begin" cv="const noexcept"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const noexcept"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="reserve"><type>void</type><parameter name="element_count"><paramtype>size_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Reserves memory for element_count elements</para><para><emphasis role="bold">Complexity:</emphasis> Linear.</para><para><emphasis role="bold">Node:</emphasis> Invalidates iterators </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>priority_queue</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<constructor cv="noexcept(boost::is_nothrow_move_constructible< super_t >::value))"><parameter name="rhs"><paramtype><classname>priority_queue</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment cv="noexcept(boost::is_nothrow_move_assignable< super_t >::value))"><type><classname>priority_queue</classname> &</type><parameter name="rhs"><paramtype><classname>priority_queue</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<copy-assignment><type><classname>priority_queue</classname> &</type><parameter name="rhs"><paramtype><classname>priority_queue</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
<header name="boost/heap/skew_heap.hpp">
|
|
<namespace name="boost">
|
|
<namespace name="heap">
|
|
<class name="skew_heap"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-nontype-parameter name="Options"><type>class ...</type></template-nontype-parameter>
|
|
</template><purpose>skew heap </purpose><description><para>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.</para><para>The container supports the following options:<itemizedlist>
|
|
<listitem><para><computeroutput>boost::heap::compare<></computeroutput>, defaults to <computeroutput>compare<std::less<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stable<></computeroutput>, defaults to <computeroutput>stable<false></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::stability_counter_type<></computeroutput>, defaults to <computeroutput>stability_counter_type<boost::uintmax_t></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::allocator<></computeroutput>, defaults to <computeroutput>allocator<std::allocator<T></computeroutput> ></para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::constant_time_size<></computeroutput>, defaults to <computeroutput>constant_time_size<true></computeroutput> </para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::store_parent_pointer<></computeroutput>, defaults to <computeroutput>store_parent_pointer<true></computeroutput>. Maintaining a parent pointer adds some maintenance and size overhead, but iterating a heap is more efficient.</para>
|
|
</listitem><listitem><para><computeroutput>boost::heap::mutable<></computeroutput>, defaults to <computeroutput>mutable<false></computeroutput>. </para>
|
|
</listitem></itemizedlist>
|
|
</para></description><struct name="implementation_defined"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-type-parameter name="A0"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A1"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A2"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A3"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A4"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A5"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A6"><default>boost::parameter::void_</default></template-type-parameter>
|
|
</template><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="value_compare"><type>base_maker::compare_argument</type></typedef>
|
|
<typedef name="allocator_type"><type>base_maker::allocator_type</type></typedef>
|
|
<typedef name="node"><type>base_maker::node_type</type></typedef>
|
|
<typedef name="node_pointer"><type>boost::allocator_pointer< allocator_type >::type</type></typedef>
|
|
<typedef name="const_node_pointer"><type>boost::allocator_const_pointer< allocator_type >::type</type></typedef>
|
|
<typedef name="value_extractor"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<typedef name="child_list_type"><type>boost::array< node_pointer, 2 ></type></typedef>
|
|
<typedef name="child_list_iterator"><type>child_list_type::iterator</type></typedef>
|
|
<typedef name="iterator"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<typedef name="const_iterator"><type>iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
<typedef name="handle_type"><type><emphasis>unspecified</emphasis></type></typedef>
|
|
</struct><struct name="push_handle"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-type-parameter name="A0"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A1"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A2"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A3"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A4"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A5"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A6"><default>boost::parameter::void_</default></template-type-parameter>
|
|
</template><method-group name="public static functions">
|
|
<method name="push" specifiers="static"><type>handle_type</type><parameter name="self"><paramtype><classname>skew_heap</classname> *</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter></method>
|
|
<method name="emplace" specifiers="static"><type>handle_type</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="self"><paramtype><classname>skew_heap</classname> *</paramtype></parameter><parameter name="args"><paramtype>Args &&...</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct><struct name="push_void"><template>
|
|
<template-type-parameter name="T"/>
|
|
<template-type-parameter name="A0"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A1"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A2"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A3"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A4"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A5"><default>boost::parameter::void_</default></template-type-parameter>
|
|
<template-type-parameter name="A6"><default>boost::parameter::void_</default></template-type-parameter>
|
|
</template><method-group name="public static functions">
|
|
<method name="push" specifiers="static"><type>void</type><parameter name="self"><paramtype><classname>skew_heap</classname> *</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter></method>
|
|
<method name="emplace" specifiers="static"><type>void</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="self"><paramtype><classname>skew_heap</classname> *</paramtype></parameter><parameter name="args"><paramtype>Args &&...</paramtype></parameter></method>
|
|
</method-group>
|
|
</struct><typedef name="value_type"><type>T</type></typedef>
|
|
<typedef name="size_type"><type>implementation_defined::size_type</type></typedef>
|
|
<typedef name="difference_type"><type>implementation_defined::difference_type</type></typedef>
|
|
<typedef name="value_compare"><type>implementation_defined::value_compare</type></typedef>
|
|
<typedef name="allocator_type"><type>implementation_defined::allocator_type</type></typedef>
|
|
<typedef name="reference"><type>implementation_defined::reference</type></typedef>
|
|
<typedef name="const_reference"><type>implementation_defined::const_reference</type></typedef>
|
|
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
|
|
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
|
|
<typedef name="iterator"><description><para><emphasis role="bold">Note:</emphasis> The iterator does not traverse the priority queue in order of the priorities. </para></description><type>implementation_defined::iterator</type></typedef>
|
|
<typedef name="const_iterator"><type>implementation_defined::const_iterator</type></typedef>
|
|
<typedef name="ordered_iterator"><type>implementation_defined::ordered_iterator</type></typedef>
|
|
<typedef name="handle_type"><type>boost::conditional< is_mutable, typename implementation_defined::handle_type, void * >::type</type></typedef>
|
|
<data-member name="constant_time_size" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_ordered_iterators" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mergable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_stable" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="has_reserve" specifiers="static"><type>const bool</type></data-member>
|
|
<data-member name="is_mutable" specifiers="static"><type>const bool</type></data-member>
|
|
<method-group name="public member functions">
|
|
<method name="push"><type>boost::conditional< is_mutable, handle_type, void >::type</type><parameter name="v"><paramtype>value_type const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="emplace"><type>boost::conditional< is_mutable, handle_type, void >::type</type><template>
|
|
<template-nontype-parameter name="Args"><type>typename...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Adds a new element to the priority queue. The element is directly constructed in-place.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="empty" cv="const"><type>bool</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns true, if the priority queue contains no elements.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the number of elements contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant, if configured with constant_time_size<true>, otherwise linear. </para></description></method>
|
|
<method name="max_size" cv="const"><type>size_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns the maximum number of elements the priority queue can contain.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="clear"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes all elements from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></method>
|
|
<method name="get_allocator" cv="const"><type>allocator_type</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns allocator.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="swap"><type>void</type><parameter name="rhs"><paramtype><classname>skew_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Swaps two priority queues.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="top" cv="const"><type>const_reference</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns a const_reference to the maximum element.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="pop"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the top element from the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="begin" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="end" cv="const"><type>iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an iterator to the end of the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></method>
|
|
<method name="ordered_begin" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="ordered_end" cv="const"><type>ordered_iterator</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Returns an ordered iterator to the first element contained in the priority queue.</para><para><emphasis role="bold">Note:</emphasis> Ordered iterators traverse the priority queue in heap order. </para></description></method>
|
|
<method name="merge"><type>void</type><parameter name="rhs"><paramtype><classname>skew_heap</classname> &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Merge all elements from rhs into this</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="value_comp" cv="const"><type>value_compare const &</type><parameter name=""><paramtype>void</paramtype></parameter><description><para><emphasis role="bold">Effect:</emphasis> Returns the value_compare object used by the priority queue </para></description></method>
|
|
<method name="operator<" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator>=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator<=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><description><para><emphasis role="bold">Returns:</emphasis> Element-wise comparison of heap data structures</para><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator==" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="operator!=" cv="const"><type>bool</type><template>
|
|
<template-type-parameter name="HeapType"/>
|
|
</template><parameter name="rhs"><paramtype>HeapType const &</paramtype></parameter><purpose>Equivalent comparison <emphasis role="bold">Returns:</emphasis> True, if both heap data structures are not equivalent. </purpose><description><para><emphasis role="bold">Requirement:</emphasis> the <computeroutput>value_compare</computeroutput> object of both heaps must match. </para></description></method>
|
|
<method name="erase"><type>void</type><parameter name="object"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Removes the element handled by <computeroutput>handle</computeroutput> from the <classname alt="boost::heap::priority_queue">priority_queue</classname>.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized). </para></description></method>
|
|
<method name="update"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized).</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized).</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be greater than the current one </para></description></method>
|
|
<method name="increase"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized).</para><para><emphasis role="bold">Note:</emphasis> If this is not called, after a handle has been updated, the behavior of the data structure is undefined! </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns <computeroutput>v</computeroutput> to the element handled by <computeroutput>handle</computeroutput> & updates the priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized).</para><para><emphasis role="bold">Note:</emphasis> The new value is expected to be less than the current one </para></description></method>
|
|
<method name="decrease"><type>void</type><parameter name="handle"><paramtype>handle_type</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Updates the heap after the element handled by <computeroutput>handle</computeroutput> has been changed.</para><para><emphasis role="bold">Complexity:</emphasis> Logarithmic (amortized).</para><para><emphasis role="bold">Note:</emphasis> 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! </para></description></method>
|
|
</method-group>
|
|
<constructor specifiers="explicit"><parameter name="cmp"><paramtype>value_compare const &</paramtype><default>value_compare()</default></parameter><description><para><emphasis role="bold">Effects:</emphasis> constructs an empty priority queue.</para><para><emphasis role="bold">Complexity:</emphasis> Constant. </para></description></constructor>
|
|
<constructor><parameter name="rhs"><paramtype><classname>skew_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> copy-constructs priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></constructor>
|
|
<copy-assignment><type><classname>skew_heap</classname> &</type><parameter name="rhs"><paramtype><classname>skew_heap</classname> const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Assigns priority queue from rhs.</para><para><emphasis role="bold">Complexity:</emphasis> Linear. </para></description></copy-assignment>
|
|
<constructor><parameter name="rhs"><paramtype><classname>skew_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move constructor.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></constructor>
|
|
<copy-assignment><type><classname>skew_heap</classname> &</type><parameter name="rhs"><paramtype><classname>skew_heap</classname> &&</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> C++11-style move assignment.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Note:</emphasis> Only available, if BOOST_NO_CXX11_RVALUE_REFERENCES is not defined </para></description></copy-assignment>
|
|
<destructor><parameter name=""><paramtype>void</paramtype></parameter></destructor>
|
|
<method-group name="public static functions">
|
|
<method name="s_handle_from_iterator" specifiers="static"><type>handle_type</type><parameter name="it"><paramtype>iterator const &</paramtype></parameter><description><para><emphasis role="bold">Effects:</emphasis> Casts an iterator to a node handle.</para><para><emphasis role="bold">Complexity:</emphasis> Constant.</para><para><emphasis role="bold">Requirement:</emphasis> data structure must be configured as mutable </para></description></method>
|
|
</method-group>
|
|
<method-group name="private member functions">
|
|
<method name="push_internal"><type>node_pointer</type><parameter name="v"><paramtype>const_reference</paramtype></parameter></method>
|
|
<method name="emplace_internal"><type>node_pointer</type><template>
|
|
<template-nontype-parameter name="Args"><type>class...</type></template-nontype-parameter>
|
|
</template><parameter name="args"><paramtype>Args &&...</paramtype></parameter></method>
|
|
<method name="unlink_node"><type>void</type><parameter name="node"><paramtype>node_pointer</paramtype></parameter></method>
|
|
<method name="clone_tree"><type>void</type><parameter name="rhs"><paramtype><classname>skew_heap</classname> const &</paramtype></parameter></method>
|
|
<method name="merge_node"><type>void</type><parameter name="other"><paramtype>node_pointer</paramtype></parameter></method>
|
|
<method name="merge_nodes"><type>node_pointer</type><parameter name="node1"><paramtype>node_pointer</paramtype></parameter><parameter name="node2"><paramtype>node_pointer</paramtype></parameter><parameter name="new_parent"><paramtype>node_pointer</paramtype></parameter></method>
|
|
<method name="merge_children"><type>node_pointer</type><parameter name="node"><paramtype>node_pointer</paramtype></parameter></method>
|
|
<method name="merge_nodes_recursive"><type>node_pointer</type><parameter name="node1"><paramtype>node_pointer</paramtype></parameter><parameter name="node2"><paramtype>node_pointer</paramtype></parameter><parameter name="new_parent"><paramtype>node_pointer</paramtype></parameter></method>
|
|
<method name="sanity_check"><type>void</type><parameter name=""><paramtype>void</paramtype></parameter></method>
|
|
</method-group>
|
|
</class>
|
|
</namespace>
|
|
</namespace>
|
|
</header>
|
|
</library-reference> |