typedef bstree_algo::insert_commit_data insert_commit_data;

This type is the information that will be filled by insert_unique_check

static node_ptr get_header(const_node_ptr n) noexcept;

Requires: 'n' is a node of the tree or a header node.

Effects: Returns the header of the tree.

Complexity: Logarithmic.

Throws: Nothing.

static node_ptr begin_node(const_node_ptr header) noexcept;

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.

static node_ptr end_node(const_node_ptr header) noexcept;

Requires: 'header' is the header node of a tree.

Effects: Returns the header of the tree.

Complexity: Constant time.

Throws: Nothing.

static void swap_tree(node_ptr header1, node_ptr header2) noexcept;

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.

static void swap_nodes(node_ptr node1, node_ptr node2) noexcept;

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

static void swap_nodes(node_ptr node1, node_ptr header1, node_ptr node2, 
                       node_ptr header2) noexcept;

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

static void replace_node(node_ptr node_to_be_replaced, node_ptr new_node) noexcept;

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

static void replace_node(node_ptr node_to_be_replaced, node_ptr header, 
                         node_ptr new_node) noexcept;

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

static void unlink(node_ptr n) noexcept;

Requires: 'n' is a tree node but not the header.

Effects: Unlinks the node and rebalances the tree.

Complexity: Average complexity is constant time.

Throws: Nothing.

static node_ptr unlink_leftmost_without_rebalance(node_ptr header) noexcept;

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.

static bool unique(const_node_ptr n) noexcept;

Requires: 'n' 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.

static std::size_t size(const_node_ptr header) noexcept;

Requires: 'header' the header of the tree.

Effects: Returns the number of nodes of the tree.

Complexity: Linear time.

Throws: Nothing.

static node_ptr next_node(node_ptr n) noexcept;

Requires: 'n' is a node from the tree except the header.

Effects: Returns the next node of the tree.

Complexity: Average constant time.

Throws: Nothing.

static node_ptr prev_node(node_ptr n) noexcept;

Requires: 'n' is a node from the tree except the leftmost node.

Effects: Returns the previous node of the tree.

Complexity: Average constant time.

Throws: Nothing.

static void init(node_ptr n) noexcept;

Requires: 'n' 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.

static void init_header(node_ptr header) noexcept;

Requires: header 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 header is inserted in a tree, this function corrupts the tree.

static node_ptr erase(node_ptr header, node_ptr z) noexcept;

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.

template<typename NodePtrCompare> 
  static bool transfer_unique(node_ptr header1, NodePtrCompare comp, 
                              node_ptr header2, node_ptr z);

Requires: header1 and header2 must be the headers of trees tree1 and tree2 respectively, z a non-header node of tree1. NodePtrCompare is the comparison function of tree1..

Effects: Transfers node "z" from tree1 to tree2 if tree1 does not contain a node that is equivalent to z.

Returns: True if the node was trasferred, false otherwise.

Complexity: Logarithmic.

Throws: If the comparison throws.

template<typename NodePtrCompare> 
  static void transfer_equal(node_ptr header1, NodePtrCompare comp, 
                             node_ptr header2, node_ptr z);

Requires: header1 and header2 must be the headers of trees tree1 and tree2 respectively, z a non-header node of tree1. NodePtrCompare is the comparison function of tree1..

Effects: Transfers node "z" from tree1 to tree2.

Complexity: Logarithmic.

Throws: If the comparison throws.

template<typename Cloner, typename Disposer> 
  static void clone(const_node_ptr source_header, node_ptr target_header, 
                    Cloner cloner, Disposer disposer);

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 void disposer::operator()(node_ptr) for every node of the tree except the header.

Then, duplicates the entire tree pointed by "source_header" cloning each source node with node_ptr Cloner::operator()(node_ptr) to obtain the nodes of the target tree. If "cloner" throws, the cloned target nodes are disposed using void disposer(node_ptr ).

Complexity: Linear to the number of element of the source tree plus the number of elements of tree target tree when calling this function.

Throws: If cloner functor throws. If this happens target nodes are disposed.

template<typename Disposer> 
  static void clear_and_dispose(node_ptr header, Disposer disposer) noexcept;

Requires: "disposer" must be an object function taking a node_ptr parameter and shouldn't throw.

Effects: Empties the target tree calling void disposer::operator()(node_ptr) for every node of the tree except the header.

Complexity: Linear to the number of element of the source tree plus the. number of elements of tree target tree when calling this function.

Throws: Nothing.

template<typename KeyType, typename KeyNodePtrCompare> 
  static node_ptr 
  lower_bound(const_node_ptr header, const KeyType & key, 
              KeyNodePtrCompare comp);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs.

Effects: Returns a node_ptr to the first element that is not less than "key" according to "comp" or "header" if that element does not exist.

Complexity: Logarithmic.

Throws: If "comp" throws.

template<typename KeyType, typename KeyNodePtrCompare> 
  static node_ptr 
  upper_bound(const_node_ptr header, const KeyType & key, 
              KeyNodePtrCompare comp);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs.

Effects: Returns a node_ptr to the first element that is greater than "key" according to "comp" or "header" if that element does not exist.

Complexity: Logarithmic.

Throws: If "comp" throws.

template<typename KeyType, typename KeyNodePtrCompare> 
  static node_ptr 
  find(const_node_ptr header, const KeyType & key, KeyNodePtrCompare comp);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs.

Effects: Returns a node_ptr to the first element that is equivalent to "key" according to "comp" or "header" if that element does not exist.

Complexity: Logarithmic.

Throws: If "comp" throws.

template<typename KeyType, typename KeyNodePtrCompare> 
  static std::pair< node_ptr, node_ptr > 
  equal_range(const_node_ptr header, const KeyType & key, 
              KeyNodePtrCompare comp);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs.

Effects: Returns an a pair of node_ptr delimiting a range containing all elements that are equivalent to "key" according to "comp" or an empty range that indicates the position where those elements would be if there are no equivalent elements.

Complexity: Logarithmic.

Throws: If "comp" throws.

template<typename KeyType, typename KeyNodePtrCompare> 
  static std::pair< node_ptr, node_ptr > 
  bounded_range(const_node_ptr header, const KeyType & lower_key, 
                const KeyType & upper_key, KeyNodePtrCompare comp, 
                bool left_closed, bool right_closed);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs. 'lower_key' must not be greater than 'upper_key' according to 'comp'. If 'lower_key' == 'upper_key', ('left_closed' || 'right_closed') must be true.

Effects: Returns an a pair with the following criteria:

first = lower_bound(lower_key) if left_closed, upper_bound(lower_key) otherwise

second = upper_bound(upper_key) if right_closed, lower_bound(upper_key) otherwise

Complexity: Logarithmic.

Throws: If "comp" throws.

Note: This function can be more efficient than calling upper_bound and lower_bound for lower_key and upper_key.

Note: Experimental function, the interface might change.

template<typename KeyType, typename KeyNodePtrCompare> 
  static std::size_t 
  count(const_node_ptr header, const KeyType & key, KeyNodePtrCompare comp);

Requires: "header" must be the header node of a tree. KeyNodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. KeyNodePtrCompare can compare KeyType with tree's node_ptrs.

Effects: Returns the number of elements with a key equivalent to "key" according to "comp".

Complexity: Logarithmic.

Throws: If "comp" throws.

template<typename NodePtrCompare> 
  static node_ptr 
  insert_equal_upper_bound(node_ptr h, node_ptr new_node, NodePtrCompare comp);

Requires: "h" must be the header node of a tree. NodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. NodePtrCompare compares two node_ptrs.

Effects: Inserts new_node into the tree before the upper bound according to "comp".

Complexity: Average complexity for insert element is at most logarithmic.

Throws: If "comp" throws.

template<typename NodePtrCompare> 
  static node_ptr 
  insert_equal_lower_bound(node_ptr h, node_ptr new_node, NodePtrCompare comp);

Requires: "h" must be the header node of a tree. NodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. NodePtrCompare compares two node_ptrs.

Effects: Inserts new_node into the tree before the lower bound according to "comp".

Complexity: Average complexity for insert element is at most logarithmic.

Throws: If "comp" throws.

template<typename NodePtrCompare> 
  static node_ptr 
  insert_equal(node_ptr header, node_ptr hint, node_ptr new_node, 
               NodePtrCompare comp);

Requires: "header" must be the header node of a tree. NodePtrCompare is a function object that induces a strict weak ordering compatible with the strict weak ordering used to create the the tree. NodePtrCompare compares two node_ptrs. "hint" is node from the "header"'s tree.

Effects: Inserts new_node into the tree, using "hint" as a hint to where it will be inserted. If "hint" is the upper_bound the insertion takes constant time (two comparisons in the worst case).

Complexity: Logarithmic in general, but it is amortized constant time if new_node is inserted immediately before "hint".

Throws: If "comp" throws.

static node_ptr 
insert_before(node_ptr header, node_ptr pos, node_ptr new_node) noexcept;

Requires: "header" must be the header node of a tree. "pos" must be a valid iterator or header (end) node. "pos" must be an iterator pointing to the successor to "new_node" once inserted according to the order of already inserted nodes. This function does not check "pos" and this precondition must be guaranteed by the caller.

Effects: Inserts new_node into the tree before "pos".

Complexity: Constant-time.

Throws: Nothing.

Note: If "pos" is not the successor of the newly inserted "new_node" tree invariants might be broken.

static void push_back(node_ptr header, node_ptr new_node) noexcept;

Requires: "header" must be the header node of a tree. "new_node" must be, according to the used ordering no less than the greatest inserted key.

Effects: Inserts new_node into the tree before "pos".

Complexity: Constant-time.

Throws: Nothing.

Note: If "new_node" is less than the greatest inserted key tree invariants are broken. This function is slightly faster than using "insert_before".

static void push_front(node_ptr header, node_ptr new_node) noexcept;

Requires: "header" must be the header node of a tree. "new_node" must be, according to the used ordering, no greater than the lowest inserted key.

Effects: Inserts new_node into the tree before "pos".

Complexity: Constant-time.

Throws: Nothing.

Note: If "new_node" is greater than the lowest inserted key tree invariants are broken. This function is slightly faster than using "insert_before".

template<typename KeyType, typename KeyNodePtrCompare> 
  static std::pair< node_ptr, bool > 
  insert_unique_check(const_node_ptr header, const KeyType & key, 
                      KeyNodePtrCompare comp, 
                      insert_commit_data & commit_data);

template<typename KeyType, typename KeyNodePtrCompare> 
  static std::pair< node_ptr, bool > 
  insert_unique_check(const_node_ptr header, node_ptr hint, 
                      const KeyType & key, KeyNodePtrCompare comp, 
                      insert_commit_data & commit_data);

static void insert_unique_commit(node_ptr header, node_ptr new_value, 
                                 const insert_commit_data & commit_data) noexcept;

static bool is_header(const_node_ptr p) noexcept;

Requires: p is a node of a tree.

Effects: Returns true if p is the header of the tree.

Complexity: Constant.

Throws: Nothing.