boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template avltree_algorithms</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../intrusive/reference.html#header.boost.intrusive.avltree_algorithms_hpp" title="Header <boost/intrusive/avltree_algorithms.hpp>"> <link rel="prev" href="make_avltree.html" title="Struct template make_avltree"> <link rel="next" href="bs_set.html" title="Class template bs_set"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <a accesskey="p" href="make_avltree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.avltree_algorithms_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="bs_set.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.intrusive.avltree_algorithms"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template avltree_algorithms</h2> boost::intrusive::avltree_algorithms </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// In header: <<a class="link" href="../../intrusive/reference.html#header.boost.intrusive.avltree_algorithms_hpp" title="Header <boost/intrusive/avltree_algorithms.hpp>">boost/intrusive/avltree_algorithms.hpp</a>> template<typename NodeTraits> class <a class="link" href="avltree_algorithms.html" title="Class template avltree_algorithms">avltree_algorithms</a> { public: // <a class="link" href="avltree_algorithms.html#boost.intrusive.avltree_algorithmstypes">types</a> typedef NodeTraits::node <a name="boost.intrusive.avltree_algorithms.node"></a>node; typedef NodeTraits <a name="boost.intrusive.avltree_algorithms.node_traits"></a>node_traits; typedef NodeTraits::node_ptr <a name="boost.intrusive.avltree_algorithms.node_ptr"></a>node_ptr; typedef NodeTraits::const_node_ptr <a name="boost.intrusive.avltree_algorithms.const_node_ptr"></a>const_node_ptr; typedef NodeTraits::balance <a name="boost.intrusive.avltree_algorithms.balance"></a>balance; typedef bstree_algo::insert_commit_data <a class="link" href="avltree_algorithms.html#boost.intrusive.avltree_algorithms.insert_commit_data">insert_commit_data</a>; // <a class="link" href="avltree_algorithms.html#idp60069840-bb">public static functions</a> static node_ptr <a class="link" href="avltree_algorithms.html#idp60070400-bb">get_header</a>(const const_node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60075776-bb">begin_node</a>(const const_node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60081184-bb">end_node</a>(const const_node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60086560-bb">swap_tree</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60092736-bb">swap_nodes</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60100192-bb">swap_nodes</a>(const node_ptr &, const node_ptr &, const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60109056-bb">replace_node</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60116352-bb">replace_node</a>(const node_ptr &, const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60124352-bb">unlink</a>(const node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60129760-bb">unlink_leftmost_without_rebalance</a>(const node_ptr &); static bool <a class="link" href="avltree_algorithms.html#idp60136256-bb">unique</a>(const const_node_ptr &); static std::size_t <a class="link" href="avltree_algorithms.html#idp60141696-bb">size</a>(const const_node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60147088-bb">next_node</a>(const node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60152480-bb">prev_node</a>(const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60157904-bb">init</a>(const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60164176-bb">init_header</a>(const node_ptr &); static node_ptr <a class="link" href="avltree_algorithms.html#idp60170480-bb">erase</a>(const node_ptr &, const node_ptr &); template<typename Cloner, typename Disposer> static void <a class="link" href="avltree_algorithms.html#idp60176608-bb">clone</a>(const const_node_ptr &, const node_ptr &, Cloner, Disposer); template<typename Disposer> static void <a class="link" href="avltree_algorithms.html#idp60187632-bb">clear_and_dispose</a>(const node_ptr &, Disposer); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60195264-bb">lower_bound</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60203728-bb">upper_bound</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60212192-bb">find</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, node_ptr > <a class="link" href="avltree_algorithms.html#idp60220656-bb">equal_range</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, node_ptr > <a class="link" href="avltree_algorithms.html#idp60229248-bb">bounded_range</a>(const const_node_ptr &, const KeyType &, const KeyType &, KeyNodePtrCompare, bool, bool); template<typename KeyType, typename KeyNodePtrCompare> static std::size_t <a class="link" href="avltree_algorithms.html#idp60242384-bb">count</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename NodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60250800-bb">insert_equal_upper_bound</a>(const node_ptr &, const node_ptr &, NodePtrCompare); template<typename NodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60258688-bb">insert_equal_lower_bound</a>(const node_ptr &, const node_ptr &, NodePtrCompare); template<typename NodePtrCompare> static node_ptr <a class="link" href="avltree_algorithms.html#idp60266576-bb">insert_equal</a>(const node_ptr &, const node_ptr &, const node_ptr &, NodePtrCompare); static node_ptr <a class="link" href="avltree_algorithms.html#idp60275344-bb">insert_before</a>(const node_ptr &, const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60283312-bb">push_back</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="avltree_algorithms.html#idp60290464-bb">push_front</a>(const node_ptr &, const node_ptr &); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, bool > <a class="link" href="avltree_algorithms.html#idp60297616-bb">insert_unique_check</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare, insert_commit_data &); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, bool > <a class="link" href="avltree_algorithms.html#idp60310192-bb">insert_unique_check</a>(const const_node_ptr &, const node_ptr &, const KeyType &, KeyNodePtrCompare, insert_commit_data &); static void <a class="link" href="avltree_algorithms.html#idp60323760-bb">insert_unique_commit</a>(const node_ptr &, const node_ptr &, const insert_commit_data &); static bool <a class="link" href="avltree_algorithms.html#idp60331904-bb">is_header</a>(const const_node_ptr &); };</pre></div> <div class="refsect1"> <a name="idp273660768"></a><h2>Description</h2> <a class="link" href="avltree_algorithms.html" title="Class template avltree_algorithms">avltree_algorithms</a> is configured with a NodeTraits class, which encapsulates the information about the node to be manipulated. NodeTraits must support the following interface: Typedefs: <code class="computeroutput">node</code>: The type of the node that forms the binary search tree <code class="computeroutput">node_ptr</code>: A pointer to a node <code class="computeroutput">const_node_ptr</code>: A pointer to a const node <code class="computeroutput">balance</code>: The type of the balance factor Static functions: <code class="computeroutput">static node_ptr get_parent(const_node_ptr n);</code> <code class="computeroutput">static void set_parent(node_ptr n, node_ptr parent);</code> <code class="computeroutput">static node_ptr get_left(const_node_ptr n);</code> <code class="computeroutput">static void set_left(node_ptr n, node_ptr left);</code> <code class="computeroutput">static node_ptr get_right(const_node_ptr n);</code> <code class="computeroutput">static void set_right(node_ptr n, node_ptr right);</code> <code class="computeroutput">static balance get_balance(const_node_ptr n);</code> <code class="computeroutput">static void set_balance(node_ptr n, balance b);</code> <code class="computeroutput">static balance negative();</code> <code class="computeroutput">static balance zero();</code> <code class="computeroutput">static balance positive();</code> <div class="refsect2"> <a name="idp273675408"></a><h3> <a name="boost.intrusive.avltree_algorithmstypes"></a><code class="computeroutput">avltree_algorithms</code> public types</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> typedef bstree_algo::insert_commit_data <a name="boost.intrusive.avltree_algorithms.insert_commit_data"></a>insert_commit_data; This type is the information that will be filled by insert_unique_check </li></ol></div> </div> <div class="refsect2"> <a name="idp273682576"></a><h3> <a name="idp60069840-bb"></a><code class="computeroutput">avltree_algorithms</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60070400-bb"></a>get_header(const const_node_ptr & n);</pre> Requires: 'node' is a node of the tree or a header node. Effects: Returns the header of the tree. Complexity: Logarithmic. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60075776-bb"></a>begin_node(const const_node_ptr & header);</pre> Requires: 'header' is the header node of a tree. Effects: Returns the first node of the tree, the header if the tree is empty. Complexity: Constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60081184-bb"></a>end_node(const const_node_ptr & header);</pre> Requires: 'header' is the header node of a tree. Effects: Returns the header of the tree. Complexity: Constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60086560-bb"></a>swap_tree(const node_ptr & header1, const node_ptr & header2);</pre> Requires: header1 and header2 must be the header nodes of two trees. Effects: Swaps two trees. After the function header1 will contain links to the second tree and header2 will have links to the first tree. Complexity: Constant. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60092736-bb"></a>swap_nodes(const node_ptr & node1, const node_ptr & node2);</pre> Requires: node1 and node2 can't be header nodes of two trees. Effects: Swaps two nodes. After the function node1 will be inserted in the position node2 before the function. node2 will be inserted in the position node1 had before the function. Complexity: Logarithmic. Throws: Nothing. Note: This function will break container ordering invariants if node1 and node2 are not equivalent according to the ordering rules. Experimental function </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60100192-bb"></a>swap_nodes(const node_ptr & node1, const node_ptr & header1, const node_ptr & node2, const node_ptr & header2);</pre> Requires: node1 and node2 can't be header nodes of two trees with header header1 and header2. Effects: Swaps two nodes. After the function node1 will be inserted in the position node2 before the function. node2 will be inserted in the position node1 had before the function. Complexity: Constant. Throws: Nothing. Note: This function will break container ordering invariants if node1 and node2 are not equivalent according to the ordering rules. Experimental function </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60109056-bb"></a>replace_node(const node_ptr & node_to_be_replaced, const node_ptr & new_node);</pre> Requires: node_to_be_replaced must be inserted in a tree and new_node must not be inserted in a tree. Effects: Replaces node_to_be_replaced in its position in the tree with new_node. The tree does not need to be rebalanced Complexity: Logarithmic. Throws: Nothing. Note: This function will break container ordering invariants if new_node is not equivalent to node_to_be_replaced according to the ordering rules. This function is faster than erasing and inserting the node, since no rebalancing and comparison is needed. Experimental function </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60116352-bb"></a>replace_node(const node_ptr & node_to_be_replaced, const node_ptr & header, const node_ptr & new_node);</pre> Requires: node_to_be_replaced must be inserted in a tree with header "header" and new_node must not be inserted in a tree. Effects: Replaces node_to_be_replaced in its position in the tree with new_node. The tree does not need to be rebalanced Complexity: Constant. Throws: Nothing. Note: This function will break container ordering invariants if new_node is not equivalent to node_to_be_replaced according to the ordering rules. This function is faster than erasing and inserting the node, since no rebalancing or comparison is needed. Experimental function </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60124352-bb"></a>unlink(const node_ptr & node);</pre> Requires: node is a tree node but not the header. Effects: Unlinks the node and rebalances the tree. Complexity: Average complexity is constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60129760-bb"></a>unlink_leftmost_without_rebalance(const node_ptr & header);</pre> Requires: header is the header of a tree. Effects: Unlinks the leftmost node from the tree, and updates the header link to the new leftmost node. Complexity: Average complexity is constant time. Throws: Nothing. Notes: This function breaks the tree and the tree can only be used for more unlink_leftmost_without_rebalance calls. This function is normally used to achieve a step by step controlled destruction of the tree. </li> <li class="listitem"> <pre class="literallayout">static bool <a name="idp60136256-bb"></a>unique(const const_node_ptr & node);</pre> Requires: 'node' is a node of the tree or a node initialized by init(...) or init_node. Effects: Returns true if the node is initialized by init() or init_node(). Complexity: Constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static std::size_t <a name="idp60141696-bb"></a>size(const const_node_ptr & header);</pre> Requires: node is a node of the tree but it's not the header. Effects: Returns the number of nodes of the subtree. Complexity: Linear time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60147088-bb"></a>next_node(const node_ptr & node);</pre> Requires: 'node' is a node from the tree except the header. Effects: Returns the next node of the tree. Complexity: Average constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60152480-bb"></a>prev_node(const node_ptr & node);</pre> Requires: 'node' is a node from the tree except the leftmost node. Effects: Returns the previous node of the tree. Complexity: Average constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60157904-bb"></a>init(const node_ptr & node);</pre> Requires: 'node' must not be part of any tree. Effects: After the function unique(node) == true. Complexity: Constant. Throws: Nothing. Nodes: If node is inserted in a tree, this function corrupts the tree. </li> <li class="listitem"> <pre class="literallayout">static void <a name="idp60164176-bb"></a>init_header(const node_ptr & header);</pre> Requires: node must not be part of any tree. Effects: Initializes the header to represent an empty tree. unique(header) == true. Complexity: Constant. Throws: Nothing. Nodes: If node is inserted in a tree, this function corrupts the tree. </li> <li class="listitem"> <pre class="literallayout">static node_ptr <a name="idp60170480-bb"></a>erase(const node_ptr & header, const node_ptr & z);</pre> Requires: header must be the header of a tree, z a node of that tree and z != header. Effects: Erases node "z" from the tree with header "header". Complexity: Amortized constant time. Throws: Nothing. </li> <li class="listitem"> <pre class="literallayout">template<typename Cloner, typename Disposer> static void <a name="idp60176608-bb"></a>clone(const const_node_ptr & source_header, const node_ptr & target_header, Cloner cloner, Disposer disposer);</pre> Requires: "cloner" must be a function object taking a node_ptr and returning a new cloned node of it. "disposer" must take a node_ptr and shouldn't throw. Effects: First empties target tree calling <code class="computeroutput">void disposer::operator()(const node_ptr &)</code> for every node of the tree except the header. Then, duplicates the entire tree pointed by "source_header" cloning each source node with <code class="computeroutput">node_ptr Cloner::operator()(const node_ptr &)</code> to obtain the nodes of the target tree. If "cloner" throws, the cloned target nodes are disposed using <code class="computeroutput">void disposer(const node_ptr &)</code>.