boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template sgtree_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.sgtree_algorithms_hpp" title="Header <boost/intrusive/sgtree_algorithms.hpp>"> <link rel="prev" href="make_sgtree.html" title="Struct template make_sgtree"> <link rel="next" href="sgtree_algorithms/insert_commit_data.html" title="Struct insert_commit_data"> </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_sgtree.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.sgtree_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="sgtree_algorithms/insert_commit_data.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.intrusive.sgtree_algorithms"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template sgtree_algorithms</h2> boost::intrusive::sgtree_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.sgtree_algorithms_hpp" title="Header <boost/intrusive/sgtree_algorithms.hpp>">boost/intrusive/sgtree_algorithms.hpp</a>> template<typename NodeTraits> class <a class="link" href="sgtree_algorithms.html" title="Class template sgtree_algorithms">sgtree_algorithms</a> { public: // types typedef NodeTraits::node <a name="boost.intrusive.sgtree_algorithms.node"></a>node; typedef NodeTraits <a name="boost.intrusive.sgtree_algorithms.node_traits"></a>node_traits; typedef NodeTraits::node_ptr <a name="boost.intrusive.sgtree_algorithms.node_ptr"></a>node_ptr; typedef NodeTraits::const_node_ptr <a name="boost.intrusive.sgtree_algorithms.const_node_ptr"></a>const_node_ptr; // member classes/structs/unions struct <a class="link" href="sgtree_algorithms/insert_commit_data.html" title="Struct insert_commit_data">insert_commit_data</a> : public insert_commit_data { // public data members std::size_t depth; }; // <a class="link" href="sgtree_algorithms.html#idp67818256-bb">public static functions</a> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67818816-bb">get_header</a>(const const_node_ptr &); static node_ptr <a class="link" href="sgtree_algorithms.html#idp67824192-bb">begin_node</a>(const const_node_ptr &); static node_ptr <a class="link" href="sgtree_algorithms.html#idp67829600-bb">end_node</a>(const const_node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67834976-bb">swap_tree</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67841152-bb">swap_nodes</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67848608-bb">swap_nodes</a>(const node_ptr &, const node_ptr &, const node_ptr &, const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67857472-bb">replace_node</a>(const node_ptr &, const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67864768-bb">replace_node</a>(const node_ptr &, const node_ptr &, const node_ptr &); static node_ptr <a class="link" href="sgtree_algorithms.html#idp67872768-bb">unlink_leftmost_without_rebalance</a>(const node_ptr &); static bool <a class="link" href="sgtree_algorithms.html#idp67879584-bb">unique</a>(const const_node_ptr &); static std::size_t <a class="link" href="sgtree_algorithms.html#idp67885024-bb">size</a>(const const_node_ptr &); static node_ptr <a class="link" href="sgtree_algorithms.html#idp67890416-bb">next_node</a>(const node_ptr &); static node_ptr <a class="link" href="sgtree_algorithms.html#idp67895808-bb">prev_node</a>(const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67901232-bb">init</a>(const node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp67907504-bb">init_header</a>(const node_ptr &); template<typename AlphaByMaxSize> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67913808-bb">erase</a>(const node_ptr &, const node_ptr &, std::size_t, std::size_t &, AlphaByMaxSize); template<typename Cloner, typename Disposer> static void <a class="link" href="sgtree_algorithms.html#idp67922848-bb">clone</a>(const const_node_ptr &, const node_ptr &, Cloner, Disposer); template<typename Disposer> static void <a class="link" href="sgtree_algorithms.html#idp67933872-bb">clear_and_dispose</a>(const node_ptr &, Disposer); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67941504-bb">lower_bound</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67949968-bb">upper_bound</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename KeyType, typename KeyNodePtrCompare> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67958432-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="sgtree_algorithms.html#idp67966896-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="sgtree_algorithms.html#idp67975488-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="sgtree_algorithms.html#idp67988624-bb">count</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare); template<typename NodePtrCompare, typename H_Alpha> static node_ptr <a class="link" href="sgtree_algorithms.html#idp67997040-bb">insert_equal_upper_bound</a>(const node_ptr &, const node_ptr &, NodePtrCompare, std::size_t, H_Alpha, std::size_t &); template<typename NodePtrCompare, typename H_Alpha> static node_ptr <a class="link" href="sgtree_algorithms.html#idp68007552-bb">insert_equal_lower_bound</a>(const node_ptr &, const node_ptr &, NodePtrCompare, std::size_t, H_Alpha, std::size_t &); template<typename NodePtrCompare, typename H_Alpha> static node_ptr <a class="link" href="sgtree_algorithms.html#idp68018064-bb">insert_equal</a>(const node_ptr &, const node_ptr &, const node_ptr &, NodePtrCompare, std::size_t, H_Alpha, std::size_t &); template<typename H_Alpha> static node_ptr <a class="link" href="sgtree_algorithms.html#idp68029456-bb">insert_before</a>(const node_ptr &, const node_ptr &, const node_ptr &, std::size_t, H_Alpha, std::size_t &); template<typename H_Alpha> static void <a class="link" href="sgtree_algorithms.html#idp68040336-bb">push_back</a>(const node_ptr &, const node_ptr &, std::size_t, H_Alpha, std::size_t &); template<typename H_Alpha> static void <a class="link" href="sgtree_algorithms.html#idp68050400-bb">push_front</a>(const node_ptr &, const node_ptr &, std::size_t, H_Alpha, std::size_t &); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, bool > <a class="link" href="sgtree_algorithms.html#idp68060464-bb">insert_unique_check</a>(const const_node_ptr &, const KeyType &, KeyNodePtrCompare, <a class="link" href="sgtree_algorithms/insert_commit_data.html" title="Struct insert_commit_data">insert_commit_data</a> &); template<typename KeyType, typename KeyNodePtrCompare> static std::pair< node_ptr, bool > <a class="link" href="sgtree_algorithms.html#idp68073328-bb">insert_unique_check</a>(const const_node_ptr &, const node_ptr &, const KeyType &, KeyNodePtrCompare, <a class="link" href="sgtree_algorithms/insert_commit_data.html" title="Struct insert_commit_data">insert_commit_data</a> &); template<typename H_Alpha> static void <a class="link" href="sgtree_algorithms.html#idp68087184-bb">insert_unique_commit</a>(const node_ptr &, const node_ptr &, const <a class="link" href="sgtree_algorithms/insert_commit_data.html" title="Struct insert_commit_data">insert_commit_data</a> &, std::size_t, H_Alpha, std::size_t &); static bool <a class="link" href="sgtree_algorithms.html#idp68098672-bb">is_header</a>(const const_node_ptr &); static void <a class="link" href="sgtree_algorithms.html#idp68104048-bb">rebalance</a>(const node_ptr &); };</pre></div> <div class="refsect1"> <a name="idp300545088"></a><h2>Description</h2> <a class="link" href="sgtree_algorithms.html" title="Class template sgtree_algorithms">sgtree_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 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> <div class="refsect2"> <a name="idp300555264"></a><h3> <a name="idp67818256-bb"></a><code class="computeroutput">sgtree_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="idp67818816-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="idp67824192-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="idp67829600-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="idp67834976-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="idp67841152-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="idp67848608-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="idp67857472-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="idp67864768-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 node_ptr <a name="idp67872768-bb"></a>unlink_leftmost_without_rebalance(const node_ptr & header);</pre>static void unlink(const node_ptr & node); 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="idp67879584-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="idp67885024-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="idp67890416-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="idp67895808-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="idp67901232-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="idp67907504-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">template<typename AlphaByMaxSize> static node_ptr <a name="idp67913808-bb