...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
boost::intrusive::set
// In header: <boost/intrusive/set.hpp> template<typename T, class... Options> class set { public: // types typedef implementation_defined::value_type value_type; typedef implementation_defined::value_traits value_traits; typedef implementation_defined::pointer pointer; typedef implementation_defined::const_pointer const_pointer; typedef implementation_defined::reference reference; typedef implementation_defined::const_reference const_reference; typedef implementation_defined::difference_type difference_type; typedef implementation_defined::size_type size_type; typedef implementation_defined::value_compare value_compare; typedef implementation_defined::key_compare key_compare; typedef implementation_defined::iterator iterator; typedef implementation_defined::const_iterator const_iterator; typedef implementation_defined::reverse_iterator reverse_iterator; typedef implementation_defined::const_reverse_iterator const_reverse_iterator; typedef implementation_defined::insert_commit_data insert_commit_data; typedef implementation_defined::node_traits node_traits; typedef implementation_defined::node node; typedef implementation_defined::node_ptr node_ptr; typedef implementation_defined::const_node_ptr const_node_ptr; typedef implementation_defined::node_algorithms node_algorithms; // construct/copy/destruct set(const set &); set(const value_compare & = value_compare(), const value_traits & = value_traits()); template<typename Iterator> set(Iterator, Iterator, const value_compare & = value_compare(), const value_traits & = value_traits()); set& operator=(const set &); ~set(); // protected member functions node & prot_header_node(); node const & prot_header_node() const; void prot_set_size(size_type); value_compare & prot_comp(); // public member functions iterator begin(); const_iterator begin() const; const_iterator cbegin() const; iterator end(); const_iterator end() const; const_iterator cend() const; reverse_iterator rbegin(); const_reverse_iterator rbegin() const; const_reverse_iterator crbegin() const; reverse_iterator rend(); const_reverse_iterator rend() const; const_reverse_iterator crend() const; key_compare key_comp() const; value_compare value_comp() const; bool empty() const; size_type size() const; void swap(set &); template<typename Cloner, typename Disposer> void clone_from(const set &, Cloner, Disposer); std::pair< iterator, bool > insert(reference); iterator insert(const_iterator, reference); template<typename KeyType, typename KeyValueCompare> std::pair< iterator, bool > insert_check(const KeyType &, KeyValueCompare, insert_commit_data &); template<typename KeyType, typename KeyValueCompare> std::pair< iterator, bool > insert_check(const_iterator, const KeyType &, KeyValueCompare, insert_commit_data &); iterator insert_commit(reference, const insert_commit_data &); template<typename Iterator> void insert(Iterator, Iterator); iterator insert_before(const_iterator, reference); void push_back(reference); void push_front(reference); iterator erase(const_iterator); iterator erase(const_iterator, const_iterator); size_type erase(const_reference); template<typename KeyType, typename KeyValueCompare> size_type erase(const KeyType &, KeyValueCompare); template<typename Disposer> iterator erase_and_dispose(const_iterator, Disposer); template<typename Disposer> iterator erase_and_dispose(const_iterator, const_iterator, Disposer); template<typename Disposer> size_type erase_and_dispose(const_reference, Disposer); template<typename KeyType, typename KeyValueCompare, typename Disposer> size_type erase_and_dispose(const KeyType &, KeyValueCompare, Disposer); void clear(); template<typename Disposer> void clear_and_dispose(Disposer); size_type count(const_reference) const; template<typename KeyType, typename KeyValueCompare> size_type count(const KeyType &, KeyValueCompare) const; iterator lower_bound(const_reference); template<typename KeyType, typename KeyValueCompare> iterator lower_bound(const KeyType &, KeyValueCompare); const_iterator lower_bound(const_reference) const; template<typename KeyType, typename KeyValueCompare> const_iterator lower_bound(const KeyType &, KeyValueCompare) const; iterator upper_bound(const_reference); template<typename KeyType, typename KeyValueCompare> iterator upper_bound(const KeyType &, KeyValueCompare); const_iterator upper_bound(const_reference) const; template<typename KeyType, typename KeyValueCompare> const_iterator upper_bound(const KeyType &, KeyValueCompare) const; iterator find(const_reference); template<typename KeyType, typename KeyValueCompare> iterator find(const KeyType &, KeyValueCompare); const_iterator find(const_reference) const; template<typename KeyType, typename KeyValueCompare> const_iterator find(const KeyType &, KeyValueCompare) const; std::pair< iterator, iterator > equal_range(const_reference); template<typename KeyType, typename KeyValueCompare> std::pair< iterator, iterator > equal_range(const KeyType &, KeyValueCompare); std::pair< const_iterator, const_iterator > equal_range(const_reference) const; template<typename KeyType, typename KeyValueCompare> std::pair< const_iterator, const_iterator > equal_range(const KeyType &, KeyValueCompare) const; iterator iterator_to(reference); const_iterator iterator_to(const_reference) const; pointer unlink_leftmost_without_rebalance(); void replace_node(iterator, reference); // public static functions static set & container_from_end_iterator(iterator); static const set & container_from_end_iterator(const_iterator); static set & container_from_iterator(iterator); static const set & container_from_iterator(const_iterator); static iterator s_iterator_to(reference); static const_iterator s_iterator_to(const_reference); static void init_node(reference); static const bool constant_time_size; tree_type tree_; // @ private: };
The class template set is an intrusive container, that mimics most of the interface of std::set as described in the C++ standard.
The template parameter T
is the type to be managed by the container. The user can specify additional options and if no options are provided default options are used.
The container supports the following options: base_hook<>/member_hook<>/value_traits<>
, constant_time_size<>
, size_type<>
and compare<>
.
set
public
construct/copy/destructset(const set &);
@ typedef rbtree_impl<Config> tree_type; This class is non-copyable
set(const value_compare & cmp = value_compare(), const value_traits & v_traits = value_traits());
Effects: Constructs an empty set.
Complexity: Constant.
Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks) or the copy constructor of the value_compare object throws.
template<typename Iterator> set(Iterator b, Iterator e, const value_compare & cmp = value_compare(), const value_traits & v_traits = value_traits());
Requires: Dereferencing iterator must yield an lvalue of type value_type. cmp must be a comparison function that induces a strict weak ordering.
Effects: Constructs an empty set and inserts elements from [b, e).
Complexity: Linear in N if [b, e) is already sorted using comp and otherwise N * log N, where N is std::distance(last, first).
Throws: If value_traits::node_traits::node constructor throws (this does not happen with predefined Boost.Intrusive hooks) or the copy constructor/operator() of the value_compare object throws.
set& operator=(const set &);
This class is non-assignable
~set();
Effects: Detaches all elements from this. The objects in the set are not deleted (i.e. no destructors are called).
Complexity: Linear to the number of elements on the container. if it's a safe-mode or auto-unlink value_type. Constant time otherwise.
Throws: Nothing.
set
public member functionsiterator begin();
Effects: Returns an iterator pointing to the beginning of the set.
Complexity: Constant.
Throws: Nothing.
const_iterator begin() const;
Effects: Returns a const_iterator pointing to the beginning of the set.
Complexity: Constant.
Throws: Nothing.
const_iterator cbegin() const;
Effects: Returns a const_iterator pointing to the beginning of the set.
Complexity: Constant.
Throws: Nothing.
iterator end();
Effects: Returns an iterator pointing to the end of the set.
Complexity: Constant.
Throws: Nothing.
const_iterator end() const;
Effects: Returns a const_iterator pointing to the end of the set.
Complexity: Constant.
Throws: Nothing.
const_iterator cend() const;
Effects: Returns a const_iterator pointing to the end of the set.
Complexity: Constant.
Throws: Nothing.
reverse_iterator rbegin();
Effects: Returns a reverse_iterator pointing to the beginning of the reversed set.
Complexity: Constant.
Throws: Nothing.
const_reverse_iterator rbegin() const;
Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed set.
Complexity: Constant.
Throws: Nothing.
const_reverse_iterator crbegin() const;
Effects: Returns a const_reverse_iterator pointing to the beginning of the reversed set.
Complexity: Constant.
Throws: Nothing.
reverse_iterator rend();
Effects: Returns a reverse_iterator pointing to the end of the reversed set.
Complexity: Constant.
Throws: Nothing.
const_reverse_iterator rend() const;
Effects: Returns a const_reverse_iterator pointing to the end of the reversed set.
Complexity: Constant.
Throws: Nothing.
const_reverse_iterator crend() const;
Effects: Returns a const_reverse_iterator pointing to the end of the reversed set.
Complexity: Constant.
Throws: Nothing.
key_compare key_comp() const;
Effects: Returns the key_compare object used by the set.
Complexity: Constant.
Throws: If key_compare copy-constructor throws.
value_compare value_comp() const;
Effects: Returns the value_compare object used by the set.
Complexity: Constant.
Throws: If value_compare copy-constructor throws.
bool empty() const;
Effects: Returns true if the container is empty.
Complexity: Constant.
Throws: Nothing.
size_type size() const;
Effects: Returns the number of elements stored in the set.
Complexity: Linear to elements contained in *this if, constant-time size option is enabled. Constant-time otherwise.
Throws: Nothing.
void swap(set & other);
Effects: Swaps the contents of two sets.
Complexity: Constant.
Throws: If the swap() call for the comparison functor found using ADL throws. Strong guarantee.
template<typename Cloner, typename Disposer> void clone_from(const set & src, Cloner cloner, Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw. Cloner should yield to nodes equivalent to the original nodes.
Effects: Erases all the elements from *this calling Disposer::operator()(pointer), clones all the elements from src calling Cloner::operator()(const_reference ) and inserts them on *this. Copies the predicate from the source container.
If cloner throws, all cloned elements are unlinked and disposed calling Disposer::operator()(pointer).
Complexity: Linear to erased plus inserted elements.
Throws: If cloner throws or predicate copy assignment throws. Basic guarantee.
std::pair< iterator, bool > insert(reference value);
Requires: value must be an lvalue
Effects: Tries to inserts value into the set.
Returns: If the value is not already present inserts it and returns a pair containing the iterator to the new value and true. If there is an equivalent value returns a pair containing an iterator to the already present value and false.
Complexity: Average complexity for insert element is at most logarithmic.
Throws: If the internal value_compare ordering function throws. Strong guarantee.
Note: Does not affect the validity of iterators and references. No copy-constructors are called.
iterator insert(const_iterator hint, reference value);
Requires: value must be an lvalue
Effects: Tries to to insert x into the set, using "hint" as a hint to where it will be inserted.
Returns: An iterator that points to the position where the new element was inserted into the set.
Complexity: Logarithmic in general, but it's amortized constant time if t is inserted immediately before hint.
Throws: If the internal value_compare ordering function throws. Strong guarantee.
Note: Does not affect the validity of iterators and references. No copy-constructors are called.
template<typename KeyType, typename KeyValueCompare> std::pair< iterator, bool > insert_check(const KeyType & key, KeyValueCompare key_value_comp, insert_commit_data & commit_data);
Requires: key_value_comp must be a comparison function that induces the same strict weak ordering as value_compare. The difference is that key_value_comp compares an arbitrary key with the contained values.
Effects: Checks if a value can be inserted in the set, using a user provided key instead of the value itself.
Returns: If there is an equivalent value returns a pair containing an iterator to the already present value and false. If the value can be inserted returns true in the returned pair boolean and fills "commit_data" that is meant to be used with the "insert_commit" function.
Complexity: Average complexity is at most logarithmic.
Throws: If the key_value_comp ordering function throws. Strong guarantee.
Notes: This function is used to improve performance when constructing a value_type is expensive: if there is an equivalent value the constructed object must be discarded. Many times, the part of the node that is used to impose the order is much cheaper to construct than the value_type and this function offers the possibility to use that part to check if the insertion will be successful.
If the check is successful, the user can construct the value_type and use "insert_commit" to insert the object in constant-time. This gives a total logarithmic complexity to the insertion: check(O(log(N)) + commit(O(1)).
"commit_data" remains valid for a subsequent "insert_commit" only if no more objects are inserted or erased from the set.
template<typename KeyType, typename KeyValueCompare> std::pair< iterator, bool > insert_check(const_iterator hint, const KeyType & key, KeyValueCompare key_value_comp, insert_commit_data & commit_data);
Requires: key_value_comp must be a comparison function that induces the same strict weak ordering as value_compare. The difference is that key_value_comp compares an arbitrary key with the contained values.
Effects: Checks if a value can be inserted in the set, using a user provided key instead of the value itself, using "hint" as a hint to where it will be inserted.
Returns: If there is an equivalent value returns a pair containing an iterator to the already present value and false. If the value can be inserted returns true in the returned pair boolean and fills "commit_data" that is meant to be used with the "insert_commit" function.
Complexity: Logarithmic in general, but it's amortized constant time if t is inserted immediately before hint.
Throws: If the key_value_comp ordering function throws. Strong guarantee.
Notes: This function is used to improve performance when constructing a value_type is expensive: if there is an equivalent value the constructed object must be discarded. Many times, the part of the constructing that is used to impose the order is much cheaper to construct than the value_type and this function offers the possibility to use that key to check if the insertion will be successful.
If the check is successful, the user can construct the value_type and use "insert_commit" to insert the object in constant-time. This can give a total constant-time complexity to the insertion: check(O(1)) + commit(O(1)).
"commit_data" remains valid for a subsequent "insert_commit" only if no more objects are inserted or erased from the set.
iterator insert_commit(reference value, const insert_commit_data & commit_data);
Requires: value must be an lvalue of type value_type. commit_data must have been obtained from a previous call to "insert_check". No objects should have been inserted or erased from the set between the "insert_check" that filled "commit_data" and the call to "insert_commit".
Effects: Inserts the value in the set using the information obtained from the "commit_data" that a previous "insert_check" filled.
Returns: An iterator to the newly inserted object.
Complexity: Constant time.
Throws: Nothing.
Notes: This function has only sense if a "insert_check" has been previously executed to fill "commit_data". No value should be inserted or erased between the "insert_check" and "insert_commit" calls.
template<typename Iterator> void insert(Iterator b, Iterator e);
Requires: Dereferencing iterator must yield an lvalue of type value_type.
Effects: Inserts a range into the set.
Complexity: Insert range is in general O(N * log(N)), where N is the size of the range. However, it is linear in N if the range is already sorted by value_comp().
Throws: If the internal value_compare ordering function throws. Basic guarantee.
Note: Does not affect the validity of iterators and references. No copy-constructors are called.
iterator insert_before(const_iterator pos, reference value);
Requires: value must be an lvalue, "pos" must be a valid iterator (or end) and must be the succesor of value once inserted according to the predicate. "value" must not be equal to any inserted key according to the predicate.
Effects: Inserts x into the tree before "pos".
Complexity: Constant time.
Throws: Nothing.
Note: This function does not check preconditions so if "pos" is not the successor of "value" or "value" is not unique tree ordering and uniqueness invariants will be broken respectively. This is a low-level function to be used only for performance reasons by advanced users.
void push_back(reference value);
Requires: value must be an lvalue, and it must be greater than any inserted key according to the predicate.
Effects: Inserts x into the tree in the last position.
Complexity: Constant time.
Throws: Nothing.
Note: This function does not check preconditions so if value is less than or equal to the greatest inserted key tree ordering invariant will be broken. This function is slightly more efficient than using "insert_before". This is a low-level function to be used only for performance reasons by advanced users.
void push_front(reference value);
Requires: value must be an lvalue, and it must be less than any inserted key according to the predicate.
Effects: Inserts x into the tree in the first position.
Complexity: Constant time.
Throws: Nothing.
Note: This function does not check preconditions so if value is greater than or equal to the the mimum inserted key tree ordering or uniqueness invariants will be broken. This function is slightly more efficient than using "insert_before". This is a low-level function to be used only for performance reasons by advanced users.
iterator erase(const_iterator i);
Effects: Erases the element pointed to by pos.
Complexity: Average complexity is constant time.
Returns: An iterator to the element after the erased element.
Throws: Nothing.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
iterator erase(const_iterator b, const_iterator e);
Effects: Erases the range pointed to by b end e.
Complexity: Average complexity for erase range is at most O(log(size() + N)), where N is the number of elements in the range.
Returns: An iterator to the element after the erased elements.
Throws: Nothing.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
size_type erase(const_reference value);
Effects: Erases all the elements with the given value.
Returns: The number of erased elements.
Complexity: O(log(size()) + this->count(value)).
Throws: If the internal value_compare ordering function throws. Basic guarantee.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
template<typename KeyType, typename KeyValueCompare> size_type erase(const KeyType & key, KeyValueCompare comp);
Effects: Erases all the elements that compare equal with the given key and the given comparison functor.
Returns: The number of erased elements.
Complexity: O(log(size() + this->count(key, comp)).
Throws: If the comp ordering function throws. Basic guarantee.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
template<typename Disposer> iterator erase_and_dispose(const_iterator i, Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw.
Effects: Erases the element pointed to by pos. Disposer::operator()(pointer) is called for the removed element.
Complexity: Average complexity for erase element is constant time.
Returns: An iterator to the element after the erased element.
Throws: Nothing.
Note: Invalidates the iterators to the erased elements.
template<typename Disposer> iterator erase_and_dispose(const_iterator b, const_iterator e, Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw.
Effects: Erases the range pointed to by b end e. Disposer::operator()(pointer) is called for the removed elements.
Complexity: Average complexity for erase range is at most O(log(size() + N)), where N is the number of elements in the range.
Returns: An iterator to the element after the erased elements.
Throws: Nothing.
Note: Invalidates the iterators to the erased elements.
template<typename Disposer> size_type erase_and_dispose(const_reference value, Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw.
Effects: Erases all the elements with the given value. Disposer::operator()(pointer) is called for the removed elements.
Throws: If the internal value_compare ordering function throws.
Complexity: O(log(size() + this->count(value)). Basic guarantee.
Throws: Nothing.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
template<typename KeyType, typename KeyValueCompare, typename Disposer> size_type erase_and_dispose(const KeyType & key, KeyValueCompare comp, Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw.
Effects: Erases all the elements with the given key. according to the comparison functor "comp". Disposer::operator()(pointer) is called for the removed elements.
Returns: The number of erased elements.
Complexity: O(log(size() + this->count(key, comp)).
Throws: If comp ordering function throws. Basic guarantee.
Note: Invalidates the iterators to the erased elements.
void clear();
Effects: Erases all the elements of the container.
Complexity: Linear to the number of elements on the container. if it's a safe-mode or auto-unlink value_type. Constant time otherwise.
Throws: Nothing.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
template<typename Disposer> void clear_and_dispose(Disposer disposer);
Requires: Disposer::operator()(pointer) shouldn't throw.
Effects: Erases all the elements of the container.
Complexity: Linear to the number of elements on the container. Disposer::operator()(pointer) is called for the removed elements.
Throws: Nothing.
Note: Invalidates the iterators (but not the references) to the erased elements. No destructors are called.
size_type count(const_reference value) const;
Effects: Returns the number of contained elements with the given key
Complexity: Logarithmic to the number of elements contained plus lineal to number of objects with the given key.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> size_type count(const KeyType & key, KeyValueCompare comp) const;
Effects: Returns the number of contained elements with the same key compared with the given comparison functor.
Complexity: Logarithmic to the number of elements contained plus lineal to number of objects with the given key.
Throws: If comp ordering function throws.
iterator lower_bound(const_reference value);
Effects: Returns an iterator to the first element whose key is not less than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> iterator lower_bound(const KeyType & key, KeyValueCompare comp);
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Returns an iterator to the first element whose key according to the comparison functor is not less than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
const_iterator lower_bound(const_reference value) const;
Effects: Returns a const iterator to the first element whose key is not less than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> const_iterator lower_bound(const KeyType & key, KeyValueCompare comp) const;
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Returns a const_iterator to the first element whose key according to the comparison functor is not less than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
iterator upper_bound(const_reference value);
Effects: Returns an iterator to the first element whose key is greater than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> iterator upper_bound(const KeyType & key, KeyValueCompare comp);
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Returns an iterator to the first element whose key according to the comparison functor is greater than key or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
const_iterator upper_bound(const_reference value) const;
Effects: Returns an iterator to the first element whose key is greater than k or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> const_iterator upper_bound(const KeyType & key, KeyValueCompare comp) const;
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Returns a const_iterator to the first element whose key according to the comparison functor is greater than key or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
iterator find(const_reference value);
Effects: Finds an iterator to the first element whose value is "value" or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> iterator find(const KeyType & key, KeyValueCompare comp);
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Finds an iterator to the first element whose key is "key" according to the comparison functor or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
const_iterator find(const_reference value) const;
Effects: Finds a const_iterator to the first element whose value is "value" or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> const_iterator find(const KeyType & key, KeyValueCompare comp) const;
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Finds a const_iterator to the first element whose key is "key" according to the comparison functor or end() if that element does not exist.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
std::pair< iterator, iterator > equal_range(const_reference value);
Effects: Finds a range containing all elements whose key is k or an empty range that indicates the position where those elements would be if they there is no elements with key k.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> std::pair< iterator, iterator > equal_range(const KeyType & key, KeyValueCompare comp);
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Finds a range containing all elements whose key is k according to the comparison functor or an empty range that indicates the position where those elements would be if they there is no elements with key k.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
std::pair< const_iterator, const_iterator > equal_range(const_reference value) const;
Effects: Finds a range containing all elements whose key is k or an empty range that indicates the position where those elements would be if they there is no elements with key k.
Complexity: Logarithmic.
Throws: If the internal value_compare ordering function throws.
template<typename KeyType, typename KeyValueCompare> std::pair< const_iterator, const_iterator > equal_range(const KeyType & key, KeyValueCompare comp) const;
Requires: comp must imply the same element order as value_compare. Usually key is the part of the value_type that is used in the ordering functor.
Effects: Finds a range containing all elements whose key is k according to the comparison functor or an empty range that indicates the position where those elements would be if they there is no elements with key k.
Complexity: Logarithmic.
Throws: If comp ordering function throws.
Note: This function is used when constructing a value_type is expensive and the value_type can be compared with a cheaper key type. Usually this key is part of the value_type.
iterator iterator_to(reference value);
Requires: value must be an lvalue and shall be in a set of appropriate type. Otherwise the behavior is undefined.
Effects: Returns: a valid iterator i belonging to the set that points to the value
Complexity: Constant.
Throws: Nothing.
const_iterator iterator_to(const_reference value) const;
Requires: value must be an lvalue and shall be in a set of appropriate type. Otherwise the behavior is undefined.
Effects: Returns: a valid const_iterator i belonging to the set that points to the value
Complexity: Constant.
Throws: Nothing.
pointer unlink_leftmost_without_rebalance();
Effects: Unlinks the leftmost node from the tree.
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.
void replace_node(iterator replace_this, reference with_this);
Requires: replace_this must be a valid iterator of *this and with_this must not be inserted in any tree.
Effects: Replaces replace_this in its position in the tree with with_this. The tree does not need to be rebalanced.
Complexity: Constant.
Throws: Nothing.
Note: This function will break container ordering invariants if with_this is not equivalent to *replace_this according to the ordering rules. This function is faster than erasing and inserting the node, since no rebalancing or comparison is needed.
set
public static functionsstatic set & container_from_end_iterator(iterator end_iterator);
Precondition: end_iterator must be a valid end iterator of set.
Effects: Returns a reference to the set associated to the end iterator
Throws: Nothing.
Complexity: Constant.
static const set & container_from_end_iterator(const_iterator end_iterator);
Precondition: end_iterator must be a valid end const_iterator of set.
Effects: Returns a const reference to the set associated to the end iterator
Throws: Nothing.
Complexity: Constant.
static set & container_from_iterator(iterator it);
Precondition: it must be a valid iterator of set.
Effects: Returns a reference to the set associated to the iterator
Throws: Nothing.
Complexity: Logarithmic.
static const set & container_from_iterator(const_iterator it);
Precondition: it must be a valid const_iterator of set.
Effects: Returns a const reference to the set associated to the iterator
Throws: Nothing.
Complexity: Logarithmic.
static iterator s_iterator_to(reference value);
Requires: value must be an lvalue and shall be in a set of appropriate type. Otherwise the behavior is undefined.
Effects: Returns: a valid iterator i belonging to the set that points to the value
Complexity: Constant.
Throws: Nothing.
Note: This static function is available only if the value traits is stateless.
static const_iterator s_iterator_to(const_reference value);
Requires: value must be an lvalue and shall be in a set of appropriate type. Otherwise the behavior is undefined.
Effects: Returns: a valid const_iterator i belonging to the set that points to the value
Complexity: Constant.
Throws: Nothing.
Note: This static function is available only if the value traits is stateless.
static void init_node(reference value);
Requires: value shall not be in a set/multiset.
Effects: init_node puts the hook of a value in a well-known default state.
Throws: Nothing.
Complexity: Constant time.
Note: This function puts the hook in the well-known default state used by auto_unlink and safe hooks.