diff options
Diffstat (limited to 'boost/intrusive/sg_set.hpp')
| -rw-r--r-- | boost/intrusive/sg_set.hpp | 1106 |
1 files changed, 638 insertions, 468 deletions
diff --git a/boost/intrusive/sg_set.hpp b/boost/intrusive/sg_set.hpp index fb59496ee1..9b020cc221 100644 --- a/boost/intrusive/sg_set.hpp +++ b/boost/intrusive/sg_set.hpp @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // -// (C) Copyright Ion Gaztanaga 2007-2009 +// (C) Copyright Ion Gaztanaga 2007-2012 // // Distributed under the Boost Software License, Version 1.0. // (See accompanying file LICENSE_1_0.txt or copy at @@ -22,9 +22,9 @@ namespace boost { namespace intrusive { -//! The class template sg_set is an intrusive container, that mimics most of +//! The class template sg_set is an intrusive container, that mimics most of //! the interface of std::set as described in the C++ standard. -//! +//! //! The template parameter \c 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. @@ -77,30 +77,30 @@ class sg_set_impl /// @endcond public: - //! <b>Effects</b>: Constructs an empty sg_set. - //! - //! <b>Complexity</b>: Constant. - //! + //! <b>Effects</b>: Constructs an empty sg_set. + //! + //! <b>Complexity</b>: Constant. + //! //! <b>Throws</b>: 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. + //! or the copy constructor of the value_compare object throws. sg_set_impl( const value_compare &cmp = value_compare() - , const value_traits &v_traits = value_traits()) + , const value_traits &v_traits = value_traits()) : tree_(cmp, v_traits) {} - //! <b>Requires</b>: Dereferencing iterator must yield an lvalue of type value_type. + //! <b>Requires</b>: Dereferencing iterator must yield an lvalue of type value_type. //! cmp must be a comparison function that induces a strict weak ordering. - //! - //! <b>Effects</b>: Constructs an empty sg_set and inserts elements from + //! + //! <b>Effects</b>: Constructs an empty sg_set and inserts elements from //! [b, e). - //! - //! <b>Complexity</b>: Linear in N if [b, e) is already sorted using + //! + //! <b>Complexity</b>: Linear in N if [b, e) is already sorted using //! comp and otherwise N * log N, where N is std::distance(last, first). - //! + //! //! <b>Throws</b>: 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. + //! or the copy constructor/operator() of the value_compare object throws. template<class Iterator> sg_set_impl( Iterator b, Iterator e , const value_compare &cmp = value_compare() @@ -109,135 +109,135 @@ class sg_set_impl {} //! <b>Effects</b>: to-do - //! - sg_set_impl(BOOST_RV_REF(sg_set_impl) x) + //! + sg_set_impl(BOOST_RV_REF(sg_set_impl) x) : tree_(::boost::move(x.tree_)) {} //! <b>Effects</b>: to-do - //! - sg_set_impl& operator=(BOOST_RV_REF(sg_set_impl) x) + //! + sg_set_impl& operator=(BOOST_RV_REF(sg_set_impl) x) { tree_ = ::boost::move(x.tree_); return *this; } - //! <b>Effects</b>: Detaches all elements from this. The objects in the sg_set + //! <b>Effects</b>: Detaches all elements from this. The objects in the sg_set //! are not deleted (i.e. no destructors are called). - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! if it's a safe-mode or auto-unlink value_type. Constant time otherwise. - //! + //! //! <b>Throws</b>: Nothing. - ~sg_set_impl() + ~sg_set_impl() {} //! <b>Effects</b>: Returns an iterator pointing to the beginning of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator begin() { return tree_.begin(); } //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator begin() const { return tree_.begin(); } //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator cbegin() const { return tree_.cbegin(); } //! <b>Effects</b>: Returns an iterator pointing to the end of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator end() { return tree_.end(); } //! <b>Effects</b>: Returns a const_iterator pointing to the end of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator end() const { return tree_.end(); } //! <b>Effects</b>: Returns a const_iterator pointing to the end of the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator cend() const { return tree_.cend(); } //! <b>Effects</b>: Returns a reverse_iterator pointing to the beginning of the //! reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. reverse_iterator rbegin() { return tree_.rbegin(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning //! of the reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator rbegin() const { return tree_.rbegin(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning //! of the reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator crbegin() const { return tree_.crbegin(); } //! <b>Effects</b>: Returns a reverse_iterator pointing to the end //! of the reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. reverse_iterator rend() { return tree_.rend(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end //! of the reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator rend() const { return tree_.rend(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end //! of the reversed sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator crend() const { return tree_.crend(); } //! <b>Precondition</b>: end_iterator must be a valid end iterator //! of sg_set. - //! + //! //! <b>Effects</b>: Returns a const reference to the sg_set associated to the end iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static sg_set_impl &container_from_end_iterator(iterator end_iterator) { @@ -248,11 +248,11 @@ class sg_set_impl //! <b>Precondition</b>: end_iterator must be a valid end const_iterator //! of sg_set. - //! + //! //! <b>Effects</b>: Returns a const reference to the sg_set associated to the end iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static const sg_set_impl &container_from_end_iterator(const_iterator end_iterator) { @@ -262,11 +262,11 @@ class sg_set_impl } //! <b>Precondition</b>: it must be a valid iterator of set. - //! + //! //! <b>Effects</b>: Returns a reference to the set associated to the iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Logarithmic. static sg_set_impl &container_from_iterator(iterator it) { @@ -276,11 +276,11 @@ class sg_set_impl } //! <b>Precondition</b>: it must be a valid const_iterator of set. - //! + //! //! <b>Effects</b>: Returns a const reference to the set associated to the iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Logarithmic. static const sg_set_impl &container_from_iterator(const_iterator it) { @@ -290,42 +290,42 @@ class sg_set_impl } //! <b>Effects</b>: Returns the key_compare object used by the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If key_compare copy-constructor throws. key_compare key_comp() const { return tree_.value_comp(); } //! <b>Effects</b>: Returns the value_compare object used by the sg_set. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If value_compare copy-constructor throws. value_compare value_comp() const { return tree_.value_comp(); } //! <b>Effects</b>: Returns true if the container is empty. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. bool empty() const { return tree_.empty(); } //! <b>Effects</b>: Returns the number of elements stored in the sg_set. - //! + //! //! <b>Complexity</b>: Linear to elements contained in *this if, //! constant-time size option is enabled. Constant-time otherwise. - //! + //! //! <b>Throws</b>: Nothing. size_type size() const { return tree_.size(); } //! <b>Effects</b>: Swaps the contents of two sets. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If the swap() call for the comparison functor //! found using ADL throws. Strong guarantee. void swap(sg_set_impl& other) @@ -335,22 +335,22 @@ class sg_set_impl //! Cloner should yield to nodes equivalent to the original nodes. //! //! <b>Effects</b>: Erases all the elements from *this - //! calling Disposer::operator()(pointer), clones all the + //! 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). - //! + //! //! <b>Complexity</b>: Linear to erased plus inserted elements. - //! + //! //! <b>Throws</b>: If cloner throws or predicate copy assignment throws. Basic guarantee. template <class Cloner, class Disposer> void clone_from(const sg_set_impl &src, Cloner cloner, Disposer disposer) { tree_.clone_from(src.tree_, cloner, disposer); } //! <b>Requires</b>: value must be an lvalue - //! + //! //! <b>Effects</b>: Tries to inserts value into the sg_set. //! //! <b>Returns</b>: If the value @@ -358,39 +358,39 @@ class sg_set_impl //! 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. - //! + //! //! <b>Complexity</b>: Average complexity for insert element is at //! most logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Strong guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. std::pair<iterator, bool> insert(reference value) { return tree_.insert_unique(value); } //! <b>Requires</b>: value must be an lvalue - //! - //! <b>Effects</b>: Tries to to insert x into the sg_set, using "hint" + //! + //! <b>Effects</b>: Tries to to insert x into the sg_set, using "hint" //! as a hint to where it will be inserted. //! - //! <b>Returns</b>: An iterator that points to the position where the + //! <b>Returns</b>: An iterator that points to the position where the //! new element was inserted into the sg_set. - //! + //! //! <b>Complexity</b>: Logarithmic in general, but it's amortized //! constant time if t is inserted immediately before hint. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Strong guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. iterator insert(const_iterator hint, reference value) { return tree_.insert_unique(hint, value); } - //! <b>Requires</b>: key_value_comp must be a comparison function that induces + //! <b>Requires</b>: 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. - //! + //! //! <b>Effects</b>: Checks if a value can be inserted in the sg_set, using //! a user provided key instead of the value itself. //! @@ -399,16 +399,16 @@ class sg_set_impl //! 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. - //! + //! //! <b>Complexity</b>: Average complexity is at most logarithmic. //! //! <b>Throws</b>: If the key_value_comp ordering function throws. Strong guarantee. - //! + //! //! <b>Notes</b>: 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 + //! 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 @@ -422,12 +422,12 @@ class sg_set_impl (const KeyType &key, KeyValueCompare key_value_comp, insert_commit_data &commit_data) { return tree_.insert_unique_check(key, key_value_comp, commit_data); } - //! <b>Requires</b>: key_value_comp must be a comparison function that induces + //! <b>Requires</b>: 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. - //! + //! //! <b>Effects</b>: Checks if a value can be inserted in the sg_set, using - //! a user provided key instead of the value itself, using "hint" + //! a user provided key instead of the value itself, using "hint" //! as a hint to where it will be inserted. //! //! <b>Returns</b>: If there is an equivalent value @@ -435,23 +435,23 @@ class sg_set_impl //! 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. - //! + //! //! <b>Complexity</b>: Logarithmic in general, but it's amortized //! constant time if t is inserted immediately before hint. //! //! <b>Throws</b>: If the key_value_comp ordering function throws. Strong guarantee. - //! + //! //! <b>Notes</b>: 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 + //! 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 sg_set. template<class KeyType, class KeyValueCompare> @@ -464,33 +464,33 @@ class sg_set_impl //! must have been obtained from a previous call to "insert_check". //! No objects should have been inserted or erased from the sg_set between //! the "insert_check" that filled "commit_data" and the call to "insert_commit". - //! + //! //! <b>Effects</b>: Inserts the value in the sg_set using the information obtained //! from the "commit_data" that a previous "insert_check" filled. //! //! <b>Returns</b>: An iterator to the newly inserted object. - //! + //! //! <b>Complexity</b>: Constant time. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Notes</b>: 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. iterator insert_commit(reference value, const insert_commit_data &commit_data) { return tree_.insert_unique_commit(value, commit_data); } - //! <b>Requires</b>: Dereferencing iterator must yield an lvalue + //! <b>Requires</b>: Dereferencing iterator must yield an lvalue //! of type value_type. - //! + //! //! <b>Effects</b>: Inserts a range into the sg_set. - //! + //! //! <b>Complexity</b>: 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(). - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. template<class Iterator> @@ -503,11 +503,11 @@ class sg_set_impl //! inserted key according to the predicate. //! //! <b>Effects</b>: Inserts x into the tree before "pos". - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: 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. @@ -520,11 +520,11 @@ class sg_set_impl //! any inserted key according to the predicate. //! //! <b>Effects</b>: Inserts x into the tree in the last position. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: 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". @@ -537,11 +537,11 @@ class sg_set_impl //! than any inserted key according to the predicate. //! //! <b>Effects</b>: Inserts x into the tree in the first position. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: 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. @@ -551,41 +551,41 @@ class sg_set_impl void push_front(reference value) { tree_.push_front(value); } - //! <b>Effects</b>: Erases the element pointed to by pos. - //! + //! <b>Effects</b>: Erases the element pointed to by pos. + //! //! <b>Complexity</b>: Average complexity is constant time. - //! + //! //! <b>Returns</b>: An iterator to the element after the erased element. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. iterator erase(const_iterator i) { return tree_.erase(i); } - //! <b>Effects</b>: Erases the range pointed to by b end e. - //! - //! <b>Complexity</b>: Average complexity for erase range is at most + //! <b>Effects</b>: Erases the range pointed to by b end e. + //! + //! <b>Complexity</b>: Average complexity for erase range is at most //! O(log(size() + N)), where N is the number of elements in the range. - //! + //! //! <b>Returns</b>: An iterator to the element after the erased elements. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. iterator erase(const_iterator b, const_iterator e) { return tree_.erase(b, e); } //! <b>Effects</b>: Erases all the elements with the given value. - //! + //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size()) + this->count(value)). - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. size_type erase(const_reference value) @@ -593,13 +593,13 @@ class sg_set_impl //! <b>Effects</b>: Erases all the elements that compare equal with //! the given key and the given comparison functor. - //! + //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(key, comp)). - //! + //! //! <b>Throws</b>: If the comp ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class KeyType, class KeyValueCompare> @@ -612,16 +612,16 @@ class sg_set_impl //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw. //! - //! <b>Effects</b>: Erases the element pointed to by pos. + //! <b>Effects</b>: Erases the element pointed to by pos. //! Disposer::operator()(pointer) is called for the removed element. - //! - //! <b>Complexity</b>: Average complexity for erase element is constant time. - //! + //! + //! <b>Complexity</b>: Average complexity for erase element is constant time. + //! //! <b>Returns</b>: An iterator to the element after the erased element. - //! + //! //! <b>Throws</b>: Nothing. - //! - //! <b>Note</b>: Invalidates the iterators + //! + //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class Disposer> iterator erase_and_dispose(const_iterator i, Disposer disposer) @@ -637,14 +637,14 @@ class sg_set_impl //! //! <b>Effects</b>: Erases the range pointed to by b end e. //! Disposer::operator()(pointer) is called for the removed elements. - //! - //! <b>Complexity</b>: Average complexity for erase range is at most + //! + //! <b>Complexity</b>: Average complexity for erase range is at most //! O(log(size() + N)), where N is the number of elements in the range. - //! + //! //! <b>Returns</b>: An iterator to the element after the erased elements. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class Disposer> @@ -655,13 +655,13 @@ class sg_set_impl //! //! <b>Effects</b>: Erases all the elements with the given value. //! Disposer::operator()(pointer) is called for the removed elements. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(value)). Basic guarantee. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class Disposer> @@ -675,11 +675,11 @@ class sg_set_impl //! Disposer::operator()(pointer) is called for the removed elements. //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(key, comp)). - //! + //! //! <b>Throws</b>: If comp ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class KeyType, class KeyValueCompare, class Disposer> @@ -691,26 +691,26 @@ class sg_set_impl { return tree_.erase_and_dispose(key, comp, disposer); } //! <b>Effects</b>: Erases all the elements of the container. - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! if it's a safe-mode or auto-unlink value_type. Constant time otherwise. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. void clear() { return tree_.clear(); } //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw. - //! + //! //! <b>Effects</b>: Erases all the elements of the container. - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! Disposer::operator()(pointer) is called for the removed elements. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class Disposer> @@ -718,20 +718,20 @@ class sg_set_impl { return tree_.clear_and_dispose(disposer); } //! <b>Effects</b>: Returns the number of contained elements with the given key - //! + //! //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal //! to number of objects with the given key. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. size_type count(const_reference value) const { return tree_.find(value) != end(); } //! <b>Effects</b>: Returns the number of contained elements with the same key //! compared with the given comparison functor. - //! + //! //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal //! to number of objects with the given key. - //! + //! //! <b>Throws</b>: If comp ordering function throws. template<class KeyType, class KeyValueCompare> size_type count(const KeyType& key, KeyValueCompare comp) const @@ -739,9 +739,9 @@ class sg_set_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is not less than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator lower_bound(const_reference value) { return tree_.lower_bound(value); } @@ -751,13 +751,13 @@ class sg_set_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns an iterator to the first element whose - //! key according to the comparison functor is not less than k or + //! key according to the comparison functor is not less than k or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. - //! + //! //! <b>Note</b>: 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. @@ -767,9 +767,9 @@ class sg_set_impl //! <b>Effects</b>: Returns a const iterator to the first element whose //! key is not less than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator lower_bound(const_reference value) const { return tree_.lower_bound(value); } @@ -779,13 +779,13 @@ class sg_set_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns a const_iterator to the first element whose - //! key according to the comparison functor is not less than k or + //! key according to the comparison functor is not less than k or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. - //! + //! //! <b>Note</b>: 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. @@ -795,9 +795,9 @@ class sg_set_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is greater than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator upper_bound(const_reference value) { return tree_.upper_bound(value); } @@ -807,11 +807,11 @@ class sg_set_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns an iterator to the first element whose - //! key according to the comparison functor is greater than key or + //! key according to the comparison functor is greater than key or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -823,9 +823,9 @@ class sg_set_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is greater than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator upper_bound(const_reference value) const { return tree_.upper_bound(value); } @@ -835,11 +835,11 @@ class sg_set_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns a const_iterator to the first element whose - //! key according to the comparison functor is greater than key or + //! key according to the comparison functor is greater than key or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -849,11 +849,11 @@ class sg_set_impl const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.upper_bound(key, comp); } - //! <b>Effects</b>: Finds an iterator to the first element whose value is + //! <b>Effects</b>: Finds an iterator to the first element whose value is //! "value" or end() if that element does not exist. //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator find(const_reference value) { return tree_.find(value); } @@ -862,12 +862,12 @@ class sg_set_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds an iterator to the first element whose key is - //! "key" according to the comparison functor or end() if that element + //! <b>Effects</b>: Finds an iterator to the first element whose key is + //! "key" according to the comparison functor or end() if that element //! does not exist. //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -877,11 +877,11 @@ class sg_set_impl iterator find(const KeyType& key, KeyValueCompare comp) { return tree_.find(key, comp); } - //! <b>Effects</b>: Finds a const_iterator to the first element whose value is + //! <b>Effects</b>: Finds a const_iterator to the first element whose value is //! "value" or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator find(const_reference value) const { return tree_.find(value); } @@ -890,12 +890,12 @@ class sg_set_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a const_iterator to the first element whose key is - //! "key" according to the comparison functor or end() if that element + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -908,9 +908,9 @@ class sg_set_impl //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. std::pair<iterator,iterator> equal_range(const_reference value) { return tree_.equal_range(value); } @@ -919,13 +919,13 @@ class sg_set_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a range containing all elements whose key is k - //! according to the comparison functor or an empty range + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -938,9 +938,9 @@ class sg_set_impl //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. std::pair<const_iterator, const_iterator> equal_range(const_reference value) const @@ -950,13 +950,13 @@ class sg_set_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a range containing all elements whose key is k - //! according to the comparison functor or an empty range + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -967,16 +967,101 @@ class sg_set_impl equal_range(const KeyType& key, KeyValueCompare comp) const { return tree_.equal_range(key, comp); } + //! <b>Requires</b>: 'lower_value' must not be greater than 'upper_value'. If + //! 'lower_value' == 'upper_value', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: 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 + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If the predicate throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_value and upper_value. + std::pair<iterator,iterator> bounded_range + (const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) + { return tree_.bounded_range(lower_value, upper_value, left_closed, right_closed); } + + //! <b>Requires</b>: KeyValueCompare is a function object that induces a strict weak + //! ordering compatible with the strict weak ordering used to create the + //! the tree. + //! 'lower_key' must not be greater than 'upper_key' according to 'comp'. If + //! 'lower_key' == 'upper_key', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: Returns an a pair with the following criteria: + //! + //! first = lower_bound(lower_key, comp) if left_closed, upper_bound(lower_key, comp) otherwise + //! + //! second = upper_bound(upper_key, comp) if right_closed, lower_bound(upper_key, comp) otherwise + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If "comp" throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_key and upper_key. + template<class KeyType, class KeyValueCompare> + std::pair<iterator,iterator> bounded_range + (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) + { return tree_.bounded_range(lower_key, upper_key, comp, left_closed, right_closed); } + + //! <b>Requires</b>: 'lower_value' must not be greater than 'upper_value'. If + //! 'lower_value' == 'upper_value', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: 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 + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If the predicate throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_value and upper_value. + std::pair<const_iterator, const_iterator> + bounded_range(const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) const + { return tree_.bounded_range(lower_value, upper_value, left_closed, right_closed); } + + //! <b>Requires</b>: KeyValueCompare is a function object that induces a strict weak + //! ordering compatible with the strict weak ordering used to create the + //! the tree. + //! 'lower_key' must not be greater than 'upper_key' according to 'comp'. If + //! 'lower_key' == 'upper_key', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: Returns an a pair with the following criteria: + //! + //! first = lower_bound(lower_key, comp) if left_closed, upper_bound(lower_key, comp) otherwise + //! + //! second = upper_bound(upper_key, comp) if right_closed, lower_bound(upper_key, comp) otherwise + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If "comp" throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_key and upper_key. + template<class KeyType, class KeyValueCompare> + std::pair<const_iterator, const_iterator> + bounded_range + (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) const + { return tree_.bounded_range(lower_key, upper_key, comp, left_closed, right_closed); } + //! <b>Requires</b>: value must be an lvalue and shall be in a sg_set of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid iterator i belonging to the sg_set //! that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This static function is available only if the <i>value traits</i> //! is stateless. static iterator s_iterator_to(reference value) @@ -984,14 +1069,14 @@ class sg_set_impl //! <b>Requires</b>: value must be an lvalue and shall be in a sg_set of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the //! sg_set that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This static function is available only if the <i>value traits</i> //! is stateless. static const_iterator s_iterator_to(const_reference value) @@ -999,48 +1084,48 @@ class sg_set_impl //! <b>Requires</b>: value must be an lvalue and shall be in a sg_set of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid iterator i belonging to the sg_set //! that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator iterator_to(reference value) { return tree_.iterator_to(value); } //! <b>Requires</b>: value must be an lvalue and shall be in a sg_set of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the //! sg_set that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator iterator_to(const_reference value) const { return tree_.iterator_to(value); } //! <b>Requires</b>: value shall not be in a sg_set/sg_multiset. - //! + //! //! <b>Effects</b>: init_node puts the hook of a value in a well-known default //! state. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Note</b>: This function puts the hook in the well-known default state //! used by auto_unlink and safe hooks. static void init_node(reference value) { tree_type::init_node(value); } //! <b>Effects</b>: Unlinks the leftmost node from the tree. - //! + //! //! <b>Complexity</b>: Average complexity is constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Notes</b>: 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 @@ -1050,14 +1135,14 @@ class sg_set_impl //! <b>Requires</b>: replace_this must be a valid iterator of *this //! and with_this must not be inserted in any tree. - //! + //! //! <b>Effects</b>: Replaces replace_this in its position in the //! tree with with_this. The tree does not need to be rebalanced. - //! - //! <b>Complexity</b>: Constant. - //! + //! + //! <b>Complexity</b>: Constant. + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: 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 @@ -1066,21 +1151,21 @@ class sg_set_impl { tree_.replace_node(replace_this, with_this); } //! <b>Effects</b>: Rebalances the tree. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear. void rebalance() { tree_.rebalance(); } //! <b>Requires</b>: old_root is a node of a tree. - //! + //! //! <b>Effects</b>: Rebalances the subtree rooted at old_root. //! //! <b>Returns</b>: The new root of the subtree. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear to the elements in the subtree. iterator rebalance_subtree(iterator root) { return tree_.rebalance_subtree(root); } @@ -1088,18 +1173,18 @@ class sg_set_impl //! <b>Returns</b>: The balance factor (alpha) used in this tree //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. float balance_factor() const { return tree_.balance_factor(); } //! <b>Requires</b>: new_alpha must be a value between 0.5 and 1.0 - //! + //! //! <b>Effects</b>: Establishes a new balance factor (alpha) and rebalances //! the tree if the new balance factor is stricter (less) than the old factor. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear to the elements in the subtree. void balance_factor(float new_alpha) { tree_.balance_factor(new_alpha); } @@ -1190,7 +1275,7 @@ struct make_sg_set { /// @cond typedef sg_set_impl - < typename make_sgtree_opt<T, + < typename make_sgtree_opt<T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -1210,7 +1295,7 @@ template<class T, class O1, class O2, class O3, class O4> template<class T, class ...Options> #endif class sg_set - : public make_sg_set<T, + : public make_sg_set<T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -1219,7 +1304,7 @@ class sg_set >::type { typedef typename make_sg_set - <T, + <T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -1271,9 +1356,9 @@ class sg_set #endif -//! The class template sg_multiset is an intrusive container, that mimics most of +//! The class template sg_multiset is an intrusive container, that mimics most of //! the interface of std::sg_multiset as described in the C++ standard. -//! +//! //! The template parameter \c 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. @@ -1325,30 +1410,30 @@ class sg_multiset_impl /// @endcond public: - //! <b>Effects</b>: Constructs an empty sg_multiset. - //! - //! <b>Complexity</b>: Constant. - //! + //! <b>Effects</b>: Constructs an empty sg_multiset. + //! + //! <b>Complexity</b>: Constant. + //! //! <b>Throws</b>: 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. + //! or the copy constructor/operator() of the value_compare object throws. sg_multiset_impl( const value_compare &cmp = value_compare() - , const value_traits &v_traits = value_traits()) + , const value_traits &v_traits = value_traits()) : tree_(cmp, v_traits) {} - //! <b>Requires</b>: Dereferencing iterator must yield an lvalue of type value_type. + //! <b>Requires</b>: Dereferencing iterator must yield an lvalue of type value_type. //! cmp must be a comparison function that induces a strict weak ordering. - //! - //! <b>Effects</b>: Constructs an empty sg_multiset and inserts elements from + //! + //! <b>Effects</b>: Constructs an empty sg_multiset and inserts elements from //! [b, e). - //! + //! //! <b>Complexity</b>: Linear in N if [b, e) is already sorted using //! comp and otherwise N * log N, where N is the distance between first and last - //! + //! //! <b>Throws</b>: 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. + //! or the copy constructor/operator() of the value_compare object throws. template<class Iterator> sg_multiset_impl( Iterator b, Iterator e , const value_compare &cmp = value_compare() @@ -1357,135 +1442,135 @@ class sg_multiset_impl {} //! <b>Effects</b>: to-do - //! - sg_multiset_impl(BOOST_RV_REF(sg_multiset_impl) x) + //! + sg_multiset_impl(BOOST_RV_REF(sg_multiset_impl) x) : tree_(::boost::move(x.tree_)) {} //! <b>Effects</b>: to-do - //! - sg_multiset_impl& operator=(BOOST_RV_REF(sg_multiset_impl) x) + //! + sg_multiset_impl& operator=(BOOST_RV_REF(sg_multiset_impl) x) { tree_ = ::boost::move(x.tree_); return *this; } - //! <b>Effects</b>: Detaches all elements from this. The objects in the sg_multiset + //! <b>Effects</b>: Detaches all elements from this. The objects in the sg_multiset //! are not deleted (i.e. no destructors are called). - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! if it's a safe-mode or auto-unlink value_type. Constant time otherwise. - //! + //! //! <b>Throws</b>: Nothing. - ~sg_multiset_impl() + ~sg_multiset_impl() {} //! <b>Effects</b>: Returns an iterator pointing to the beginning of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator begin() { return tree_.begin(); } //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator begin() const { return tree_.begin(); } //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator cbegin() const { return tree_.cbegin(); } //! <b>Effects</b>: Returns an iterator pointing to the end of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator end() { return tree_.end(); } //! <b>Effects</b>: Returns a const_iterator pointing to the end of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator end() const { return tree_.end(); } //! <b>Effects</b>: Returns a const_iterator pointing to the end of the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator cend() const { return tree_.cend(); } //! <b>Effects</b>: Returns a reverse_iterator pointing to the beginning of the //! reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. reverse_iterator rbegin() { return tree_.rbegin(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning //! of the reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator rbegin() const { return tree_.rbegin(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning //! of the reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator crbegin() const { return tree_.crbegin(); } //! <b>Effects</b>: Returns a reverse_iterator pointing to the end //! of the reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. reverse_iterator rend() { return tree_.rend(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end //! of the reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator rend() const { return tree_.rend(); } //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end //! of the reversed sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_reverse_iterator crend() const { return tree_.crend(); } //! <b>Precondition</b>: end_iterator must be a valid end iterator //! of sg_multiset. - //! + //! //! <b>Effects</b>: Returns a const reference to the sg_multiset associated to the end iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static sg_multiset_impl &container_from_end_iterator(iterator end_iterator) { @@ -1496,11 +1581,11 @@ class sg_multiset_impl //! <b>Precondition</b>: end_iterator must be a valid end const_iterator //! of sg_multiset. - //! + //! //! <b>Effects</b>: Returns a const reference to the sg_multiset associated to the end iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static const sg_multiset_impl &container_from_end_iterator(const_iterator end_iterator) { @@ -1510,11 +1595,11 @@ class sg_multiset_impl } //! <b>Precondition</b>: it must be a valid iterator of multiset. - //! + //! //! <b>Effects</b>: Returns a const reference to the multiset associated to the iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static sg_multiset_impl &container_from_iterator(iterator it) { @@ -1524,11 +1609,11 @@ class sg_multiset_impl } //! <b>Precondition</b>: it must be a valid const_iterator of multiset. - //! + //! //! <b>Effects</b>: Returns a const reference to the multiset associated to the iterator - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. static const sg_multiset_impl &container_from_iterator(const_iterator it) { @@ -1538,42 +1623,42 @@ class sg_multiset_impl } //! <b>Effects</b>: Returns the key_compare object used by the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If key_compare copy-constructor throws. key_compare key_comp() const { return tree_.value_comp(); } //! <b>Effects</b>: Returns the value_compare object used by the sg_multiset. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If value_compare copy-constructor throws. value_compare value_comp() const { return tree_.value_comp(); } //! <b>Effects</b>: Returns true if the container is empty. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. bool empty() const { return tree_.empty(); } //! <b>Effects</b>: Returns the number of elements stored in the sg_multiset. - //! + //! //! <b>Complexity</b>: Linear to elements contained in *this if, //! constant-time size option is enabled. Constant-time otherwise. - //! + //! //! <b>Throws</b>: Nothing. size_type size() const { return tree_.size(); } //! <b>Effects</b>: Swaps the contents of two sg_multisets. - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: If the swap() call for the comparison functor //! found using ADL throws. Strong guarantee. void swap(sg_multiset_impl& other) @@ -1583,69 +1668,69 @@ class sg_multiset_impl //! Cloner should yield to nodes equivalent to the original nodes. //! //! <b>Effects</b>: Erases all the elements from *this - //! calling Disposer::operator()(pointer), clones all the + //! 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). - //! + //! //! <b>Complexity</b>: Linear to erased plus inserted elements. - //! + //! //! <b>Throws</b>: If cloner throws or predicate copy assignment throws. Basic guarantee. template <class Cloner, class Disposer> void clone_from(const sg_multiset_impl &src, Cloner cloner, Disposer disposer) { tree_.clone_from(src.tree_, cloner, disposer); } //! <b>Requires</b>: value must be an lvalue - //! + //! //! <b>Effects</b>: Inserts value into the sg_multiset. - //! + //! //! <b>Returns</b>: An iterator that points to the position where the new //! element was inserted. - //! + //! //! <b>Complexity</b>: Average complexity for insert element is at //! most logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Strong guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. iterator insert(reference value) { return tree_.insert_equal(value); } //! <b>Requires</b>: value must be an lvalue - //! + //! //! <b>Effects</b>: Inserts x into the sg_multiset, using pos as a hint to //! where it will be inserted. - //! + //! //! <b>Returns</b>: An iterator that points to the position where the new //! element was inserted. - //! + //! //! <b>Complexity</b>: Logarithmic in general, but it is amortized //! constant time if t is inserted immediately before hint. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Strong guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. iterator insert(const_iterator hint, reference value) { return tree_.insert_equal(hint, value); } - //! <b>Requires</b>: Dereferencing iterator must yield an lvalue + //! <b>Requires</b>: Dereferencing iterator must yield an lvalue //! of type value_type. - //! + //! //! <b>Effects</b>: Inserts a range into the sg_multiset. - //! + //! //! <b>Returns</b>: An iterator that points to the position where the new //! element was inserted. - //! + //! //! <b>Complexity</b>: 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(). - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Does not affect the validity of iterators and references. //! No copy-constructors are called. template<class Iterator> @@ -1657,11 +1742,11 @@ class sg_multiset_impl //! once inserted according to the predicate //! //! <b>Effects</b>: Inserts x into the tree before "pos". - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This function does not check preconditions so if "pos" is not //! the successor of "value" tree ordering invariant will be broken. //! This is a low-level function to be used only for performance reasons @@ -1673,11 +1758,11 @@ class sg_multiset_impl //! than the greatest inserted key //! //! <b>Effects</b>: Inserts x into the tree in the last position. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This function does not check preconditions so if value is //! less than the greatest inserted key tree ordering invariant will be broken. //! This function is slightly more efficient than using "insert_before". @@ -1690,11 +1775,11 @@ class sg_multiset_impl //! than the minimum inserted key //! //! <b>Effects</b>: Inserts x into the tree in the first position. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This function does not check preconditions so if value is //! greater than the minimum inserted key tree ordering invariant will be broken. //! This function is slightly more efficient than using "insert_before". @@ -1703,41 +1788,41 @@ class sg_multiset_impl void push_front(reference value) { tree_.push_front(value); } - //! <b>Effects</b>: Erases the element pointed to by pos. - //! - //! <b>Complexity</b>: Average complexity is constant time. - //! + //! <b>Effects</b>: Erases the element pointed to by pos. + //! + //! <b>Complexity</b>: Average complexity is constant time. + //! //! <b>Returns</b>: An iterator to the element after the erased element. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. iterator erase(const_iterator i) { return tree_.erase(i); } - //! <b>Effects</b>: Erases the range pointed to by b end e. + //! <b>Effects</b>: Erases the range pointed to by b end e. //! //! <b>Returns</b>: An iterator to the element after the erased elements. - //! - //! <b>Complexity</b>: Average complexity for erase range is at most + //! + //! <b>Complexity</b>: Average complexity for erase range is at most //! O(log(size() + N)), where N is the number of elements in the range. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. iterator erase(const_iterator b, const_iterator e) { return tree_.erase(b, e); } //! <b>Effects</b>: Erases all the elements with the given value. - //! + //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(value)). - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. size_type erase(const_reference value) @@ -1745,13 +1830,13 @@ class sg_multiset_impl //! <b>Effects</b>: Erases all the elements that compare equal with //! the given key and the given comparison functor. - //! + //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(key, comp)). - //! + //! //! <b>Throws</b>: If comp ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class KeyType, class KeyValueCompare> @@ -1766,14 +1851,14 @@ class sg_multiset_impl //! //! <b>Returns</b>: An iterator to the element after the erased element. //! - //! <b>Effects</b>: Erases the element pointed to by pos. + //! <b>Effects</b>: Erases the element pointed to by pos. //! Disposer::operator()(pointer) is called for the removed element. - //! - //! <b>Complexity</b>: Average complexity for erase element is constant time. - //! + //! + //! <b>Complexity</b>: Average complexity for erase element is constant time. + //! //! <b>Throws</b>: Nothing. - //! - //! <b>Note</b>: Invalidates the iterators + //! + //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class Disposer> iterator erase_and_dispose(const_iterator i, Disposer disposer) @@ -1791,12 +1876,12 @@ class sg_multiset_impl //! //! <b>Effects</b>: Erases the range pointed to by b end e. //! Disposer::operator()(pointer) is called for the removed elements. - //! - //! <b>Complexity</b>: Average complexity for erase range is at most + //! + //! <b>Complexity</b>: Average complexity for erase range is at most //! O(log(size() + N)), where N is the number of elements in the range. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class Disposer> @@ -1807,13 +1892,13 @@ class sg_multiset_impl //! //! <b>Effects</b>: Erases all the elements with the given value. //! Disposer::operator()(pointer) is called for the removed elements. - //! + //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(value)). - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class Disposer> @@ -1827,11 +1912,11 @@ class sg_multiset_impl //! Disposer::operator()(pointer) is called for the removed elements. //! //! <b>Returns</b>: The number of erased elements. - //! + //! //! <b>Complexity</b>: O(log(size() + this->count(key, comp)). - //! + //! //! <b>Throws</b>: If comp ordering function throws. Basic guarantee. - //! + //! //! <b>Note</b>: Invalidates the iterators //! to the erased elements. template<class KeyType, class KeyValueCompare, class Disposer> @@ -1843,26 +1928,26 @@ class sg_multiset_impl { return tree_.erase_and_dispose(key, comp, disposer); } //! <b>Effects</b>: Erases all the elements of the container. - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! if it's a safe-mode or auto-unlink value_type. Constant time otherwise. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. void clear() { return tree_.clear(); } //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw. - //! + //! //! <b>Effects</b>: Erases all the elements of the container. - //! + //! //! <b>Complexity</b>: Linear to the number of elements on the container. //! Disposer::operator()(pointer) is called for the removed elements. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template<class Disposer> @@ -1870,20 +1955,20 @@ class sg_multiset_impl { return tree_.clear_and_dispose(disposer); } //! <b>Effects</b>: Returns the number of contained elements with the given key - //! + //! //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal //! to number of objects with the given key. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. size_type count(const_reference value) const { return tree_.count(value); } //! <b>Effects</b>: Returns the number of contained elements with the same key //! compared with the given comparison functor. - //! + //! //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal //! to number of objects with the given key. - //! + //! //! <b>Throws</b>: If comp ordering function throws. template<class KeyType, class KeyValueCompare> size_type count(const KeyType& key, KeyValueCompare comp) const @@ -1891,9 +1976,9 @@ class sg_multiset_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is not less than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator lower_bound(const_reference value) { return tree_.lower_bound(value); } @@ -1903,13 +1988,13 @@ class sg_multiset_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns an iterator to the first element whose - //! key according to the comparison functor is not less than k or + //! key according to the comparison functor is not less than k or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. - //! + //! //! <b>Note</b>: 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. @@ -1919,9 +2004,9 @@ class sg_multiset_impl //! <b>Effects</b>: Returns a const iterator to the first element whose //! key is not less than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator lower_bound(const_reference value) const { return tree_.lower_bound(value); } @@ -1931,13 +2016,13 @@ class sg_multiset_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns a const_iterator to the first element whose - //! key according to the comparison functor is not less than k or + //! key according to the comparison functor is not less than k or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. - //! + //! //! <b>Note</b>: 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. @@ -1947,9 +2032,9 @@ class sg_multiset_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is greater than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator upper_bound(const_reference value) { return tree_.upper_bound(value); } @@ -1959,11 +2044,11 @@ class sg_multiset_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns an iterator to the first element whose - //! key according to the comparison functor is greater than key or + //! key according to the comparison functor is greater than key or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -1975,9 +2060,9 @@ class sg_multiset_impl //! <b>Effects</b>: Returns an iterator to the first element whose //! key is greater than k or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator upper_bound(const_reference value) const { return tree_.upper_bound(value); } @@ -1987,11 +2072,11 @@ class sg_multiset_impl //! that is used in the ordering functor. //! //! <b>Effects</b>: Returns a const_iterator to the first element whose - //! key according to the comparison functor is greater than key or + //! key according to the comparison functor is greater than key or //! end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -2001,11 +2086,11 @@ class sg_multiset_impl const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.upper_bound(key, comp); } - //! <b>Effects</b>: Finds an iterator to the first element whose value is + //! <b>Effects</b>: Finds an iterator to the first element whose value is //! "value" or end() if that element does not exist. //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. iterator find(const_reference value) { return tree_.find(value); } @@ -2014,12 +2099,12 @@ class sg_multiset_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds an iterator to the first element whose key is - //! "key" according to the comparison functor or end() if that element + //! <b>Effects</b>: Finds an iterator to the first element whose key is + //! "key" according to the comparison functor or end() if that element //! does not exist. //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -2029,11 +2114,11 @@ class sg_multiset_impl iterator find(const KeyType& key, KeyValueCompare comp) { return tree_.find(key, comp); } - //! <b>Effects</b>: Finds a const_iterator to the first element whose value is + //! <b>Effects</b>: Finds a const_iterator to the first element whose value is //! "value" or end() if that element does not exist. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. const_iterator find(const_reference value) const { return tree_.find(value); } @@ -2042,12 +2127,12 @@ class sg_multiset_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a const_iterator to the first element whose key is - //! "key" according to the comparison functor or end() if that element + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -2060,9 +2145,9 @@ class sg_multiset_impl //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. std::pair<iterator,iterator> equal_range(const_reference value) { return tree_.equal_range(value); } @@ -2071,13 +2156,13 @@ class sg_multiset_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a range containing all elements whose key is k - //! according to the comparison functor or an empty range + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -2090,9 +2175,9 @@ class sg_multiset_impl //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If the internal value_compare ordering function throws. std::pair<const_iterator, const_iterator> equal_range(const_reference value) const @@ -2102,13 +2187,13 @@ class sg_multiset_impl //! value_compare. Usually key is the part of the value_type //! that is used in the ordering functor. //! - //! <b>Effects</b>: Finds a range containing all elements whose key is k - //! according to the comparison functor or an empty range + //! <b>Effects</b>: 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. - //! + //! //! <b>Complexity</b>: Logarithmic. - //! + //! //! <b>Throws</b>: If comp ordering function throws. //! //! <b>Note</b>: This function is used when constructing a value_type @@ -2119,16 +2204,101 @@ class sg_multiset_impl equal_range(const KeyType& key, KeyValueCompare comp) const { return tree_.equal_range(key, comp); } + //! <b>Requires</b>: 'lower_value' must not be greater than 'upper_value'. If + //! 'lower_value' == 'upper_value', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: 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 + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If the predicate throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_value and upper_value. + std::pair<iterator,iterator> bounded_range + (const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) + { return tree_.bounded_range(lower_value, upper_value, left_closed, right_closed); } + + //! <b>Requires</b>: KeyValueCompare is a function object that induces a strict weak + //! ordering compatible with the strict weak ordering used to create the + //! the tree. + //! 'lower_key' must not be greater than 'upper_key' according to 'comp'. If + //! 'lower_key' == 'upper_key', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: Returns an a pair with the following criteria: + //! + //! first = lower_bound(lower_key, comp) if left_closed, upper_bound(lower_key, comp) otherwise + //! + //! second = upper_bound(upper_key, comp) if right_closed, lower_bound(upper_key, comp) otherwise + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If "comp" throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_key and upper_key. + template<class KeyType, class KeyValueCompare> + std::pair<iterator,iterator> bounded_range + (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) + { return tree_.bounded_range(lower_key, upper_key, comp, left_closed, right_closed); } + + //! <b>Requires</b>: 'lower_value' must not be greater than 'upper_value'. If + //! 'lower_value' == 'upper_value', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: 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 + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If the predicate throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_value and upper_value. + std::pair<const_iterator, const_iterator> + bounded_range(const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) const + { return tree_.bounded_range(lower_value, upper_value, left_closed, right_closed); } + + //! <b>Requires</b>: KeyValueCompare is a function object that induces a strict weak + //! ordering compatible with the strict weak ordering used to create the + //! the tree. + //! 'lower_key' must not be greater than 'upper_key' according to 'comp'. If + //! 'lower_key' == 'upper_key', ('left_closed' || 'right_closed') must be false. + //! + //! <b>Effects</b>: Returns an a pair with the following criteria: + //! + //! first = lower_bound(lower_key, comp) if left_closed, upper_bound(lower_key, comp) otherwise + //! + //! second = upper_bound(upper_key, comp) if right_closed, lower_bound(upper_key, comp) otherwise + //! + //! <b>Complexity</b>: Logarithmic. + //! + //! <b>Throws</b>: If "comp" throws. + //! + //! <b>Note</b>: This function can be more efficient than calling upper_bound + //! and lower_bound for lower_key and upper_key. + template<class KeyType, class KeyValueCompare> + std::pair<const_iterator, const_iterator> + bounded_range + (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) const + { return tree_.bounded_range(lower_key, upper_key, comp, left_closed, right_closed); } + //! <b>Requires</b>: value must be an lvalue and shall be in a sg_multiset of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid iterator i belonging to the sg_multiset //! that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This static function is available only if the <i>value traits</i> //! is stateless. static iterator s_iterator_to(reference value) @@ -2136,14 +2306,14 @@ class sg_multiset_impl //! <b>Requires</b>: value must be an lvalue and shall be in a sg_multiset of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the //! sg_multiset that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: This static function is available only if the <i>value traits</i> //! is stateless. static const_iterator s_iterator_to(const_reference value) @@ -2151,48 +2321,48 @@ class sg_multiset_impl //! <b>Requires</b>: value must be an lvalue and shall be in a sg_multiset of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid iterator i belonging to the sg_multiset //! that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. iterator iterator_to(reference value) { return tree_.iterator_to(value); } //! <b>Requires</b>: value must be an lvalue and shall be in a sg_multiset of //! appropriate type. Otherwise the behavior is undefined. - //! + //! //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the //! sg_multiset that points to the value - //! + //! //! <b>Complexity</b>: Constant. - //! + //! //! <b>Throws</b>: Nothing. const_iterator iterator_to(const_reference value) const { return tree_.iterator_to(value); } //! <b>Requires</b>: value shall not be in a sg_multiset/sg_multiset. - //! + //! //! <b>Effects</b>: init_node puts the hook of a value in a well-known default //! state. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant time. - //! + //! //! <b>Note</b>: This function puts the hook in the well-known default state //! used by auto_unlink and safe hooks. static void init_node(reference value) { tree_type::init_node(value); } //! <b>Effects</b>: Unlinks the leftmost node from the tree. - //! + //! //! <b>Complexity</b>: Average complexity is constant time. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Notes</b>: 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 @@ -2202,14 +2372,14 @@ class sg_multiset_impl //! <b>Requires</b>: replace_this must be a valid iterator of *this //! and with_this must not be inserted in any tree. - //! + //! //! <b>Effects</b>: Replaces replace_this in its position in the //! tree with with_this. The tree does not need to be rebalanced. - //! - //! <b>Complexity</b>: Constant. - //! + //! + //! <b>Complexity</b>: Constant. + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Note</b>: 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 @@ -2218,21 +2388,21 @@ class sg_multiset_impl { tree_.replace_node(replace_this, with_this); } //! <b>Effects</b>: Rebalances the tree. - //! + //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear. void rebalance() { tree_.rebalance(); } //! <b>Requires</b>: old_root is a node of a tree. - //! + //! //! <b>Effects</b>: Rebalances the subtree rooted at old_root. //! //! <b>Returns</b>: The new root of the subtree. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear to the elements in the subtree. iterator rebalance_subtree(iterator root) { return tree_.rebalance_subtree(root); } @@ -2240,18 +2410,18 @@ class sg_multiset_impl //! <b>Returns</b>: The balance factor (alpha) used in this tree //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Constant. float balance_factor() const { return tree_.balance_factor(); } //! <b>Requires</b>: new_alpha must be a value between 0.5 and 1.0 - //! + //! //! <b>Effects</b>: Establishes a new balance factor (alpha) and rebalances //! the tree if the new balance factor is stricter (less) than the old factor. //! //! <b>Throws</b>: Nothing. - //! + //! //! <b>Complexity</b>: Linear to the elements in the subtree. void balance_factor(float new_alpha) { tree_.balance_factor(new_alpha); } @@ -2342,7 +2512,7 @@ struct make_sg_multiset { /// @cond typedef sg_multiset_impl - < typename make_sgtree_opt<T, + < typename make_sgtree_opt<T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -2362,7 +2532,7 @@ template<class T, class O1, class O2, class O3, class O4> template<class T, class ...Options> #endif class sg_multiset - : public make_sg_multiset<T, + : public make_sg_multiset<T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -2371,7 +2541,7 @@ class sg_multiset >::type { typedef typename make_sg_multiset - <T, + <T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4 #else @@ -2423,8 +2593,8 @@ class sg_multiset #endif -} //namespace intrusive -} //namespace boost +} //namespace intrusive +} //namespace boost #include <boost/intrusive/detail/config_end.hpp> |