///////////////////////////////////////////////////////////////////////////// // // (C) Copyright Olaf Krzikalla 2004-2006. // (C) Copyright Ion Gaztanaga 2006-2007 // // Distributed under the Boost Software License, Version 1.0. // (See accompanying file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) // // See http://www.boost.org/libs/intrusive for documentation. // ///////////////////////////////////////////////////////////////////////////// #ifndef BOOST_INTRUSIVE_SET_HPP #define BOOST_INTRUSIVE_SET_HPP #include #include #include #include namespace boost { namespace intrusive { //! 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 ValueTraits is called "value traits". It stores //! information and operations about the type to be stored in the container. //! //! The template parameter Compare, provides a function object that can compare two //! element values as sort keys to determine their relative order in the set. //! //! If the user specifies ConstantTimeSize as "true", a member of type SizeType //! will be embedded in the class, that will keep track of the number of stored objects. //! This will allow constant-time O(1) size() member, instead of default O(N) size. template < class ValueTraits , class Compare //= std::less , bool ConstantTimeSize //= true , class SizeType //= std::size_t > class set { /// @cond typedef rbtree tree_type; //! This class is //! non-copyable set (const set&); //! This class is //! non-assignable set &operator =(const set&); typedef tree_type implementation_defined; /// @endcond public: typedef ValueTraits value_traits; typedef typename ValueTraits::value_type value_type; typedef typename ValueTraits::pointer pointer; typedef typename ValueTraits::const_pointer const_pointer; typedef typename std::iterator_traits::reference reference; typedef typename std::iterator_traits::reference const_reference; typedef typename std::iterator_traits::difference_type difference_type; typedef SizeType size_type; typedef value_type key_type; typedef Compare value_compare; typedef value_compare key_compare; typedef typename implementation_defined::iterator iterator; typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation_defined::reverse_iterator reverse_iterator; typedef typename implementation_defined::const_reverse_iterator const_reverse_iterator; typedef typename implementation_defined::insert_commit_data insert_commit_data; /// @cond private: tree_type tree_; template friend bool operator==(const set& x, const set& y); template friend bool operator<(const set& x, const set& y); /// @endcond public: //! 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 Compare object throws. set(const Compare &cmp = Compare()) : tree_(cmp) {} //! 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 Compare object throws. template set(Iterator b, Iterator e, const Compare &cmp = Compare()) : tree_(true, b, e, cmp) { insert(b, e); } //! Effects: Detaches all elements from this. The objects in the set //! are not deleted (i.e. no destructors are called). //! //! Complexity: O(log(size()) + size()) if it's a safe-mode or auto-unlink //! value. Otherwise constant. //! //! Throws: Nothing. ~set() {} //! Effects: Returns an iterator pointing to the beginning of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. iterator begin() { return tree_.begin(); } //! Effects: Returns a const_iterator pointing to the beginning of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator begin() const { return tree_.begin(); } //! Effects: Returns a const_iterator pointing to the beginning of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator cbegin() const { return tree_.cbegin(); } //! Effects: Returns an iterator pointing to the end of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. iterator end() { return tree_.end(); } //! Effects: Returns a const_iterator pointing to the end of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator end() const { return tree_.end(); } //! Effects: Returns a const_iterator pointing to the end of the set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator cend() const { return tree_.cend(); } //! Effects: Returns a reverse_iterator pointing to the beginning of the //! reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. reverse_iterator rbegin() { return tree_.rbegin(); } //! Effects: Returns a const_reverse_iterator pointing to the beginning //! of the reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator rbegin() const { return tree_.rbegin(); } //! Effects: Returns a const_reverse_iterator pointing to the beginning //! of the reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator crbegin() const { return tree_.crbegin(); } //! Effects: Returns a reverse_iterator pointing to the end //! of the reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. reverse_iterator rend() { return tree_.rend(); } //! Effects: Returns a const_reverse_iterator pointing to the end //! of the reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator rend() const { return tree_.rend(); } //! Effects: Returns a const_reverse_iterator pointing to the end //! of the reversed set. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator crend() const { return tree_.crend(); } //! Precondition: end_iterator must be a valid end iterator //! of set. //! //! Effects: Returns a const reference to the set associated to the end iterator //! //! Throws: Nothing. //! //! Complexity: Constant. static set &container_from_end_iterator(iterator end_iterator) { return *detail::parent_from_member ( &tree_type::container_from_end_iterator(end_iterator) , &set::tree_); } //! 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 const set &container_from_end_iterator(const_iterator end_iterator) { return *detail::parent_from_member ( &tree_type::container_from_end_iterator(end_iterator) , &set::tree_); } //! Effects: Returns the key_compare object used by the set. //! //! Complexity: Constant. //! //! Throws: If key_compare copy-constructor throws. key_compare key_comp() const { return tree_.value_comp(); } //! Effects: Returns the value_compare object used by the set. //! //! Complexity: Constant. //! //! Throws: If value_compare copy-constructor throws. value_compare value_comp() const { return tree_.value_comp(); } //! Effects: Returns true is the container is empty. //! //! Complexity: Constant. //! //! Throws: Nothing. bool empty() const { return tree_.empty(); } //! Effects: Returns the number of elements stored in the set. //! //! Complexity: Linear to elements contained in *this if, //! ConstantTimeSize is false. Constant-time otherwise. //! //! Throws: Nothing. size_type size() const { return tree_.size(); } //! Effects: Swaps the contents of two sets. //! //! Complexity: Constant. //! //! Throws: If the swap() call for the comparison functor //! found using ADL throws. Strong guarantee. void swap(set& other) { tree_.swap(other.tree_); } //! Requires: Disposer::operator()(pointer) shouldn't throw. //! //! 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. //! //! 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. template void clone_from(const set &src, Cloner cloner, Disposer disposer) { tree_.clone_from(src.tree_, cloner, disposer); } //! 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 Compare ordering function throws. Strong guarantee. //! //! Note: Does not affect the validity of iterators and references. //! No copy-constructors are called. std::pair insert(reference value) { return tree_.insert_unique(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 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) { return tree_.insert_unique(hint, value); } //! 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 std::pair insert_check (const KeyType &key, KeyValueCompare key_value_comp, insert_commit_data &commit_data) { return tree_.insert_unique_check(key, key_value_comp, 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. template std::pair insert_check (const_iterator hint, const KeyType &key ,KeyValueCompare key_value_comp, insert_commit_data &commit_data) { return tree_.insert_unique_check(hint, key, key_value_comp, 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. iterator insert_commit(reference value, const insert_commit_data &commit_data) { return tree_.insert_unique_commit(value, commit_data); } //! 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 Compare ordering function throws. Basic guarantee. //! //! Note: Does not affect the validity of iterators and references. //! No copy-constructors are called. template void insert(Iterator b, Iterator e) { tree_.insert_unique(b, e); } //! 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(iterator i) { return tree_.erase(i); } //! 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. iterator erase(iterator b, iterator e) { return tree_.erase(b, e); } //! 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 Compare ordering function throws. Basic guarantee. //! //! Note: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. size_type erase(const_reference value) { return tree_.erase(value); } //! 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 size_type erase(const KeyType& key, KeyValueCompare comp) { return tree_.erase(key, comp); } //! 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 iterator erase_and_dispose(iterator i, Disposer disposer) { return tree_.erase_and_dispose(i, 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 iterator erase_and_dispose(iterator b, iterator e, Disposer disposer) { return tree_.erase_and_dispose(b, e, 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 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 size_type erase_and_dispose(const_reference value, Disposer disposer) { return tree_.erase_and_dispose(value, 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. template size_type erase_and_dispose(const KeyType& key, KeyValueCompare comp, Disposer disposer) { return tree_.erase_and_dispose(key, comp, disposer); } //! 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. void clear() { return tree_.clear(); } //! 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. template void clear_and_dispose(Disposer disposer) { return tree_.clear_and_dispose(disposer); } //! 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 Compare ordering function throws. size_type count(const_reference value) const { return tree_.find(value) != end(); } //! 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. template size_type count(const KeyType& key, KeyValueCompare comp) const { return tree_.find(key, comp) != end(); } //! 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 Compare ordering function throws. iterator lower_bound(const_reference value) { return tree_.lower_bound(value); } //! 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. template iterator lower_bound(const KeyType& key, KeyValueCompare comp) { return tree_.lower_bound(key, comp); } //! 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 Compare ordering function throws. const_iterator lower_bound(const_reference value) const { return tree_.lower_bound(value); } //! 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. template const_iterator lower_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.lower_bound(key, comp); } //! 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 Compare ordering function throws. iterator upper_bound(const_reference value) { return tree_.upper_bound(value); } //! 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. template iterator upper_bound(const KeyType& key, KeyValueCompare comp) { return tree_.upper_bound(key, comp); } //! 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 Compare ordering function throws. const_iterator upper_bound(const_reference value) const { return tree_.upper_bound(value); } //! 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. template const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.upper_bound(key, comp); } //! 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 Compare ordering function throws. iterator find(const_reference value) { return tree_.find(value); } //! 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. template iterator find(const KeyType& key, KeyValueCompare comp) { return tree_.find(key, comp); } //! 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 Compare ordering function throws. const_iterator find(const_reference value) const { return tree_.find(value); } //! 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. template const_iterator find(const KeyType& key, KeyValueCompare comp) const { return tree_.find(key, comp); } //! 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 Compare ordering function throws. std::pair equal_range(const_reference value) { return tree_.equal_range(value); } //! 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. template std::pair equal_range(const KeyType& key, KeyValueCompare comp) { return tree_.equal_range(key, comp); } //! 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 Compare ordering function throws. std::pair equal_range(const_reference value) const { return tree_.equal_range(value); } //! 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. template std::pair equal_range(const KeyType& key, KeyValueCompare comp) const { return tree_.equal_range(key, comp); } //! 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. static iterator iterator_to(reference value) { return tree_type::iterator_to(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. static const_iterator iterator_to(const_reference value) { return tree_type::iterator_to(value); } /// @cond friend bool operator==(const set &x, const set &y) { return x.tree_ == y.tree_; } friend bool operator<(const set &x, const set &y) { return x.tree_ < y.tree_; } /// @endcond }; template inline bool operator!=(const set& x, const set& y) { return !(x==y); } template inline bool operator>(const set& x, const set& y) { return y < x; } template inline bool operator<=(const set& x, const set& y) { return !(y > x); } template inline bool operator>=(const set& x, const set& y) { return !(x < y); } template inline void swap(set& x, set& y) { x.swap(y); } //! The class template multiset is an intrusive container, that mimics most of //! the interface of std::multiset as described in the C++ standard. //! //! The template parameter ValueTraits is called "value traits". It stores //! information and operations about the type to be stored //! in list and what type of hook has been chosen to include it in the list. //! The value_traits class is supplied by the appropriate hook as a template subtype //! called "value_traits". //! //! The template parameter Compare, provides a function object that can compare two //! element values as sort keys to determine their relative order in the set. //! //! If the user specifies ConstantTimeSize as "true", a member of type SizeType //! will be embedded in the class, that will keep track of the number of stored objects. //! This will allow constant-time O(1) size() member, instead of default O(N) size. template < class ValueTraits , class Compare //= std::less , bool ConstantTimeSize //= true , class SizeType //= std::size_t > class multiset { /// @cond typedef rbtree tree_type; //! This class is //! non-copyable multiset (const multiset&); //! This class is //! non-asignable multiset &operator =(const multiset&); typedef tree_type implementation_defined; /// @endcond public: typedef ValueTraits value_traits; typedef typename ValueTraits::value_type value_type; typedef typename ValueTraits::pointer pointer; typedef typename ValueTraits::const_pointer const_pointer; typedef typename std::iterator_traits::reference reference; typedef typename std::iterator_traits::reference const_reference; typedef typename std::iterator_traits::difference_type difference_type; typedef SizeType size_type; typedef value_type key_type; typedef Compare value_compare; typedef value_compare key_compare; typedef typename implementation_defined::iterator iterator; typedef typename implementation_defined::const_iterator const_iterator; typedef typename implementation_defined::reverse_iterator reverse_iterator; typedef typename implementation_defined::const_reverse_iterator const_reverse_iterator; typedef typename implementation_defined::insert_commit_data insert_commit_data; /// @cond private: tree_type tree_; /// @endcond public: //! Effects: Constructs an empty multiset. //! //! Complexity: Constant. //! //! 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 Compare object throws. multiset(const Compare &cmp = Compare()) : tree_(cmp) {} //! 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 multiset 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 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 Compare object throws. template multiset(Iterator b, Iterator e, const Compare &cmp = Compare()) : tree_(false, b, e, cmp) {} //! Effects: Detaches all elements from this. The objects in the set //! are not deleted (i.e. no destructors are called). //! //! Complexity: O(log(size()) + size()) if it's a safe-mode or //! auto-unlink value. Otherwise constant. //! //! Throws: Nothing. ~multiset() {} //! Effects: Returns an iterator pointing to the beginning of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. iterator begin() { return tree_.begin(); } //! Effects: Returns a const_iterator pointing to the beginning of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator begin() const { return tree_.begin(); } //! Effects: Returns a const_iterator pointing to the beginning of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator cbegin() const { return tree_.cbegin(); } //! Effects: Returns an iterator pointing to the end of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. iterator end() { return tree_.end(); } //! Effects: Returns a const_iterator pointing to the end of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator end() const { return tree_.end(); } //! Effects: Returns a const_iterator pointing to the end of the multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_iterator cend() const { return tree_.cend(); } //! Effects: Returns a reverse_iterator pointing to the beginning of the //! reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. reverse_iterator rbegin() { return tree_.rbegin(); } //! Effects: Returns a const_reverse_iterator pointing to the beginning //! of the reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator rbegin() const { return tree_.rbegin(); } //! Effects: Returns a const_reverse_iterator pointing to the beginning //! of the reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator crbegin() const { return tree_.crbegin(); } //! Effects: Returns a reverse_iterator pointing to the end //! of the reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. reverse_iterator rend() { return tree_.rend(); } //! Effects: Returns a const_reverse_iterator pointing to the end //! of the reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator rend() const { return tree_.rend(); } //! Effects: Returns a const_reverse_iterator pointing to the end //! of the reversed multiset. //! //! Complexity: Constant. //! //! Throws: Nothing. const_reverse_iterator crend() const { return tree_.crend(); } //! Precondition: end_iterator must be a valid end iterator //! of multiset. //! //! Effects: Returns a const reference to the multiset associated to the end iterator //! //! Throws: Nothing. //! //! Complexity: Constant. static multiset &container_from_end_iterator(iterator end_iterator) { return *detail::parent_from_member ( &tree_type::container_from_end_iterator(end_iterator) , &multiset::tree_); } //! Precondition: end_iterator must be a valid end const_iterator //! of multiset. //! //! Effects: Returns a const reference to the multiset associated to the end iterator //! //! Throws: Nothing. //! //! Complexity: Constant. static const multiset &container_from_end_iterator(const_iterator end_iterator) { return *detail::parent_from_member ( &tree_type::container_from_end_iterator(end_iterator) , &multiset::tree_); } //! Effects: Returns the key_compare object used by the multiset. //! //! Complexity: Constant. //! //! Throws: If key_compare copy-constructor throws. key_compare key_comp() const { return tree_.value_comp(); } //! Effects: Returns the value_compare object used by the multiset. //! //! Complexity: Constant. //! //! Throws: If value_compare copy-constructor throws. value_compare value_comp() const { return tree_.value_comp(); } //! Effects: Returns true is the container is empty. //! //! Complexity: Constant. //! //! Throws: Nothing. bool empty() const { return tree_.empty(); } //! Effects: Returns the number of elements stored in the multiset. //! //! Complexity: Linear to elements contained in *this if, //! ConstantTimeSize is false. Constant-time otherwise. //! //! Throws: Nothing. size_type size() const { return tree_.size(); } //! Effects: Swaps the contents of two multisets. //! //! Complexity: Constant. //! //! Throws: If the swap() call for the comparison functor //! found using ADL throws. Strong guarantee. void swap(multiset& other) { tree_.swap(other.tree_); } //! Requires: Disposer::operator()(pointer) shouldn't throw. //! //! 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. //! //! 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. Basic guarantee. template void clone_from(const multiset &src, Cloner cloner, Disposer disposer) { tree_.clone_from(src.tree_, cloner, disposer); } //! Requires: value must be an lvalue //! //! Effects: Inserts value into the multiset. //! //! Returns: An iterator that points to the position where the new //! element was inserted. //! //! Complexity: Average complexity for insert element is at //! most logarithmic. //! //! Throws: If the internal Compare ordering function throws. Strong guarantee. //! //! Note: Does not affect the validity of iterators and references. //! No copy-constructors are called. iterator insert(reference value) { return tree_.insert_equal_upper_bound(value); } //! Requires: value must be an lvalue //! //! Effects: Inserts x into the multiset, using pos as a hint to //! where it will be inserted. //! //! Returns: An iterator that points to the position where the new //! element was inserted. //! //! Complexity: Logarithmic in general, but it is amortized //! constant time if t is inserted immediately before hint. //! //! Throws: If the internal 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) { return tree_.insert_equal(hint, value); } //! Requires: Dereferencing iterator must yield an lvalue //! of type value_type. //! //! Effects: Inserts a range into the multiset. //! //! Returns: An iterator that points to the position where the new //! element was inserted. //! //! 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 Compare ordering function throws. Basic guarantee. //! //! Note: Does not affect the validity of iterators and references. //! No copy-constructors are called. template void insert(Iterator b, Iterator e) { tree_.insert_equal(b, e); } //! 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(iterator i) { return tree_.erase(i); } //! Effects: Erases the range pointed to by b end e. //! //! Returns: An iterator to the element after the erased elements. //! //! Complexity: Average complexity for erase range is at most //! O(log(size() + N)), where N is the number of elements in the range. //! //! Throws: Nothing. //! //! Note: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. iterator erase(iterator b, iterator e) { return tree_.erase(b, e); } //! 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 Compare ordering function throws. Basic guarantee. //! //! Note: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. size_type erase(const_reference value) { return tree_.erase(value); } //! 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 comp ordering function throws. Basic guarantee. //! //! Note: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template size_type erase(const KeyType& key, KeyValueCompare comp) { return tree_.erase(key, comp); } //! Requires: Disposer::operator()(pointer) shouldn't throw. //! //! Returns: An iterator to the element after the erased element. //! //! 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. //! //! Throws: Nothing. //! //! Note: Invalidates the iterators //! to the erased elements. template iterator erase_and_dispose(iterator i, Disposer disposer) { return tree_.erase_and_dispose(i, disposer); } //! Requires: Disposer::operator()(pointer) shouldn't throw. //! //! Returns: An iterator to the element after the erased elements. //! //! 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. //! //! Throws: Nothing. //! //! Note: Invalidates the iterators //! to the erased elements. template iterator erase_and_dispose(iterator b, iterator e, Disposer disposer) { return tree_.erase_and_dispose(b, e, 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. //! //! Returns: The number of erased elements. //! //! Complexity: O(log(size() + this->count(value)). //! //! Throws: If the internal Compare ordering function throws. Basic guarantee. //! //! Note: Invalidates the iterators (but not the references) //! to the erased elements. No destructors are called. template size_type erase_and_dispose(const_reference value, Disposer disposer) { return tree_.erase_and_dispose(value, 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. template size_type erase_and_dispose(const KeyType& key, KeyValueCompare comp, Disposer disposer) { return tree_.erase_and_dispose(key, comp, disposer); } //! 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. void clear() { return tree_.clear(); } //! 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. template void clear_and_dispose(Disposer disposer) { return tree_.clear_and_dispose(disposer); } //! 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. template size_type count(const KeyType& key, KeyValueCompare comp) const { return tree_.find(key, comp) != end(); } //! 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 Compare ordering function throws. iterator lower_bound(const_reference value) { return tree_.lower_bound(value); } //! 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. template iterator lower_bound(const KeyType& key, KeyValueCompare comp) { return tree_.lower_bound(key, comp); } //! 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 Compare ordering function throws. const_iterator lower_bound(const_reference value) const { return tree_.lower_bound(value); } //! 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. template const_iterator lower_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.lower_bound(key, comp); } //! 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 Compare ordering function throws. iterator upper_bound(const_reference value) { return tree_.upper_bound(value); } //! 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. template iterator upper_bound(const KeyType& key, KeyValueCompare comp) { return tree_.upper_bound(key, comp); } //! 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 Compare ordering function throws. const_iterator upper_bound(const_reference value) const { return tree_.upper_bound(value); } //! 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. template const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const { return tree_.upper_bound(key, comp); } //! 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 Compare ordering function throws. iterator find(const_reference value) { return tree_.find(value); } //! 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. template iterator find(const KeyType& key, KeyValueCompare comp) { return tree_.find(key, comp); } //! 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 Compare ordering function throws. const_iterator find(const_reference value) const { return tree_.find(value); } //! 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. template const_iterator find(const KeyType& key, KeyValueCompare comp) const { return tree_.find(key, comp); } //! 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 Compare ordering function throws. std::pair equal_range(const_reference value) { return tree_.equal_range(value); } //! 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. template std::pair equal_range(const KeyType& key, KeyValueCompare comp) { return tree_.equal_range(key, comp); } //! 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 Compare ordering function throws. std::pair equal_range(const_reference value) const { return tree_.equal_range(value); } //! 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. template std::pair equal_range(const KeyType& key, KeyValueCompare comp) const { return tree_.equal_range(key, comp); } //! 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. static iterator iterator_to(reference value) { return tree_type::iterator_to(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. static const_iterator iterator_to(const_reference value) { return tree_type::iterator_to(value); } /// @cond friend bool operator==(const multiset &x, const multiset &y) { return x.tree_ == y.tree_; } friend bool operator<(const multiset &x, const multiset &y) { return x.tree_ < y.tree_; } /// @endcond }; template inline bool operator!=(const multiset& x, const multiset& y) { return !(x==y); } template inline bool operator>(const multiset& x, const multiset& y) { return y < x; } template inline bool operator<=(const multiset& x, const multiset& y) { return !(y > x); } template inline bool operator>=(const multiset& x, const multiset& y) { return !(x < y); } template inline void swap(multiset& x, multiset& y) { x.swap(y); } } //namespace intrusive } //namespace boost #include #endif //BOOST_INTRUSIVE_SET_HPP