boost/intrusive/rbtree.hpp
///////////////////////////////////////////////////////////////////////////// // // (C) Copyright Ion Gaztanaga 2006-2014 // // 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_RBTREE_HPP #define BOOST_INTRUSIVE_RBTREE_HPP #include <boost/intrusive/detail/config_begin.hpp> #include <boost/intrusive/intrusive_fwd.hpp> #include <cstddef> #include <boost/intrusive/detail/minimal_less_equal_header.hpp> #include <boost/intrusive/detail/minimal_pair_header.hpp> //std::pair #include <boost/intrusive/set_hook.hpp> #include <boost/intrusive/detail/rbtree_node.hpp> #include <boost/intrusive/bstree.hpp> #include <boost/intrusive/detail/tree_node.hpp> #include <boost/intrusive/detail/mpl.hpp> #include <boost/intrusive/pointer_traits.hpp> #include <boost/intrusive/detail/get_value_traits.hpp> #include <boost/intrusive/rbtree_algorithms.hpp> #include <boost/intrusive/link_mode.hpp> #include <boost/move/utility_core.hpp> #include <boost/static_assert.hpp> #if defined(BOOST_HAS_PRAGMA_ONCE) # pragma once #endif namespace boost { namespace intrusive { /// @cond struct default_rbtree_hook_applier { template <class T> struct apply{ typedef typename T::default_rbtree_hook type; }; }; template<> struct is_default_hook_tag<default_rbtree_hook_applier> { static const bool value = true; }; struct rbtree_defaults : bstree_defaults { typedef default_rbtree_hook_applier proto_value_traits; }; /// @endcond //! The class template rbtree is an intrusive red-black tree container, that //! is used to construct intrusive set and multiset containers. The no-throw //! guarantee holds only, if the key_compare object //! doesn't throw. //! //! 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. //! //! The container supports the following options: //! \c base_hook<>/member_hook<>/value_traits<>, //! \c constant_time_size<>, \c size_type<> and //! \c compare<>. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) template<class T, class ...Options> #else template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, class SizeType, bool ConstantTimeSize, typename HeaderHolder> #endif class rbtree_impl /// @cond : public bstree_impl<ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, SizeType, ConstantTimeSize, RbTreeAlgorithms, HeaderHolder> /// @endcond { public: typedef ValueTraits value_traits; /// @cond typedef bstree_impl< ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, SizeType , ConstantTimeSize, RbTreeAlgorithms , HeaderHolder> tree_type; typedef tree_type implementation_defined; /// @endcond typedef typename implementation_defined::pointer pointer; typedef typename implementation_defined::const_pointer const_pointer; typedef typename implementation_defined::value_type value_type; typedef typename implementation_defined::key_type key_type; typedef typename implementation_defined::key_of_value key_of_value; typedef typename implementation_defined::reference reference; typedef typename implementation_defined::const_reference const_reference; typedef typename implementation_defined::difference_type difference_type; typedef typename implementation_defined::size_type size_type; typedef typename implementation_defined::value_compare value_compare; typedef typename implementation_defined::key_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::node_traits node_traits; typedef typename implementation_defined::node node; typedef typename implementation_defined::node_ptr node_ptr; typedef typename implementation_defined::const_node_ptr const_node_ptr; typedef typename implementation_defined::node_algorithms node_algorithms; static const bool constant_time_size = implementation_defined::constant_time_size; /// @cond private: //noncopyable BOOST_MOVABLE_BUT_NOT_COPYABLE(rbtree_impl) /// @endcond public: typedef typename implementation_defined::insert_commit_data insert_commit_data; //! @copydoc ::boost::intrusive::bstree::bstree(const key_compare &,const value_traits &) explicit rbtree_impl( const key_compare &cmp = key_compare() , const value_traits &v_traits = value_traits()) : tree_type(cmp, v_traits) {} //! @copydoc ::boost::intrusive::bstree::bstree(bool,Iterator,Iterator,const key_compare &,const value_traits &) template<class Iterator> rbtree_impl( bool unique, Iterator b, Iterator e , const key_compare &cmp = key_compare() , const value_traits &v_traits = value_traits()) : tree_type(unique, b, e, cmp, v_traits) {} //! @copydoc ::boost::intrusive::bstree::bstree(bstree &&) rbtree_impl(BOOST_RV_REF(rbtree_impl) x) : tree_type(BOOST_MOVE_BASE(tree_type, x)) {} //! @copydoc ::boost::intrusive::bstree::operator=(bstree &&) rbtree_impl& operator=(BOOST_RV_REF(rbtree_impl) x) { return static_cast<rbtree_impl&>(tree_type::operator=(BOOST_MOVE_BASE(tree_type, x))); } #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED //! @copydoc ::boost::intrusive::bstree::~bstree() ~rbtree_impl(); //! @copydoc ::boost::intrusive::bstree::begin() iterator begin(); //! @copydoc ::boost::intrusive::bstree::begin()const const_iterator begin() const; //! @copydoc ::boost::intrusive::bstree::cbegin()const const_iterator cbegin() const; //! @copydoc ::boost::intrusive::bstree::end() iterator end(); //! @copydoc ::boost::intrusive::bstree::end()const const_iterator end() const; //! @copydoc ::boost::intrusive::bstree::cend()const const_iterator cend() const; //! @copydoc ::boost::intrusive::bstree::rbegin() reverse_iterator rbegin(); //! @copydoc ::boost::intrusive::bstree::rbegin()const const_reverse_iterator rbegin() const; //! @copydoc ::boost::intrusive::bstree::crbegin()const const_reverse_iterator crbegin() const; //! @copydoc ::boost::intrusive::bstree::rend() reverse_iterator rend(); //! @copydoc ::boost::intrusive::bstree::rend()const const_reverse_iterator rend() const; //! @copydoc ::boost::intrusive::bstree::crend()const const_reverse_iterator crend() const; //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(iterator) static rbtree_impl &container_from_end_iterator(iterator end_iterator); //! @copydoc ::boost::intrusive::bstree::container_from_end_iterator(const_iterator) static const rbtree_impl &container_from_end_iterator(const_iterator end_iterator); //! @copydoc ::boost::intrusive::bstree::container_from_iterator(iterator) static rbtree_impl &container_from_iterator(iterator it); //! @copydoc ::boost::intrusive::bstree::container_from_iterator(const_iterator) static const rbtree_impl &container_from_iterator(const_iterator it); //! @copydoc ::boost::intrusive::bstree::key_comp()const key_compare key_comp() const; //! @copydoc ::boost::intrusive::bstree::value_comp()const value_compare value_comp() const; //! @copydoc ::boost::intrusive::bstree::empty()const bool empty() const; //! @copydoc ::boost::intrusive::bstree::size()const size_type size() const; //! @copydoc ::boost::intrusive::bstree::swap void swap(rbtree_impl& other); //! @copydoc ::boost::intrusive::bstree::clone_from(const bstree&,Cloner,Disposer) template <class Cloner, class Disposer> void clone_from(const rbtree_impl &src, Cloner cloner, Disposer disposer); #else //BOOST_INTRUSIVE_DOXYGEN_INVOKED using tree_type::clone_from; #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED //! @copydoc ::boost::intrusive::bstree::clone_from(bstree&&,Cloner,Disposer) template <class Cloner, class Disposer> void clone_from(BOOST_RV_REF(rbtree_impl) src, Cloner cloner, Disposer disposer) { tree_type::clone_from(BOOST_MOVE_BASE(tree_type, src), cloner, disposer); } #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED //! @copydoc ::boost::intrusive::bstree::clone_from(bstree&&,Cloner,Disposer) template <class Cloner, class Disposer> void clone_from(rbtree_impl &&src, Cloner cloner, Disposer disposer); //! @copydoc ::boost::intrusive::bstree::insert_equal(reference) iterator insert_equal(reference value); //! @copydoc ::boost::intrusive::bstree::insert_equal(const_iterator,reference) iterator insert_equal(const_iterator hint, reference value); //! @copydoc ::boost::intrusive::bstree::insert_equal(Iterator,Iterator) template<class Iterator> void insert_equal(Iterator b, Iterator e); //! @copydoc ::boost::intrusive::bstree::insert_unique(reference) std::pair<iterator, bool> insert_unique(reference value); //! @copydoc ::boost::intrusive::bstree::insert_unique(const_iterator,reference) iterator insert_unique(const_iterator hint, reference value); //! @copydoc ::boost::intrusive::bstree::insert_unique_check(const KeyType&,KeyTypeKeyCompare,insert_commit_data&) template<class KeyType, class KeyTypeKeyCompare> std::pair<iterator, bool> insert_unique_check (const KeyType &key, KeyTypeKeyCompare comp, insert_commit_data &commit_data); //! @copydoc ::boost::intrusive::bstree::insert_unique_check(const_iterator,const KeyType&,KeyTypeKeyCompare,insert_commit_data&) template<class KeyType, class KeyTypeKeyCompare> std::pair<iterator, bool> insert_unique_check (const_iterator hint, const KeyType &key ,KeyTypeKeyCompare comp, insert_commit_data &commit_data); //! @copydoc ::boost::intrusive::bstree::insert_unique_commit iterator insert_unique_commit(reference value, const insert_commit_data &commit_data); //! @copydoc ::boost::intrusive::bstree::insert_unique(Iterator,Iterator) template<class Iterator> void insert_unique(Iterator b, Iterator e); //! @copydoc ::boost::intrusive::bstree::insert_before iterator insert_before(const_iterator pos, reference value); //! @copydoc ::boost::intrusive::bstree::push_back void push_back(reference value); //! @copydoc ::boost::intrusive::bstree::push_front void push_front(reference value); //! @copydoc ::boost::intrusive::bstree::erase(const_iterator) iterator erase(const_iterator i); //! @copydoc ::boost::intrusive::bstree::erase(const_iterator,const_iterator) iterator erase(const_iterator b, const_iterator e); //! @copydoc ::boost::intrusive::bstree::erase(const key_type &key) size_type erase(const key_type &key); //! @copydoc ::boost::intrusive::bstree::erase(const KeyType&,KeyTypeKeyCompare) template<class KeyType, class KeyTypeKeyCompare> size_type erase(const KeyType& key, KeyTypeKeyCompare comp); //! @copydoc ::boost::intrusive::bstree::erase_and_dispose(const_iterator,Disposer) template<class Disposer> iterator erase_and_dispose(const_iterator i, Disposer disposer); //! @copydoc ::boost::intrusive::bstree::erase_and_dispose(const_iterator,const_iterator,Disposer) template<class Disposer> iterator erase_and_dispose(const_iterator b, const_iterator e, Disposer disposer); //! @copydoc ::boost::intrusive::bstree::erase_and_dispose(const key_type &, Disposer) template<class Disposer> size_type erase_and_dispose(const key_type &key, Disposer disposer); //! @copydoc ::boost::intrusive::bstree::erase_and_dispose(const KeyType&,KeyTypeKeyCompare,Disposer) template<class KeyType, class KeyTypeKeyCompare, class Disposer> size_type erase_and_dispose(const KeyType& key, KeyTypeKeyCompare comp, Disposer disposer); //! @copydoc ::boost::intrusive::bstree::clear void clear(); //! @copydoc ::boost::intrusive::bstree::clear_and_dispose template<class Disposer> void clear_and_dispose(Disposer disposer); //! @copydoc ::boost::intrusive::bstree::count(const key_type &)const size_type count(const key_type &key) const; //! @copydoc ::boost::intrusive::bstree::count(const KeyType&,KeyTypeKeyCompare)const template<class KeyType, class KeyTypeKeyCompare> size_type count(const KeyType& key, KeyTypeKeyCompare comp) const; //! @copydoc ::boost::intrusive::bstree::lower_bound(const key_type &) iterator lower_bound(const key_type &key); //! @copydoc ::boost::intrusive::bstree::lower_bound(const KeyType&,KeyTypeKeyCompare) template<class KeyType, class KeyTypeKeyCompare> iterator lower_bound(const KeyType& key, KeyTypeKeyCompare comp); //! @copydoc ::boost::intrusive::bstree::lower_bound(const key_type &)const const_iterator lower_bound(const key_type &key) const; //! @copydoc ::boost::intrusive::bstree::lower_bound(const KeyType&,KeyTypeKeyCompare)const template<class KeyType, class KeyTypeKeyCompare> const_iterator lower_bound(const KeyType& key, KeyTypeKeyCompare comp) const; //! @copydoc ::boost::intrusive::bstree::upper_bound(const key_type &) iterator upper_bound(const key_type &key); //! @copydoc ::boost::intrusive::bstree::upper_bound(const KeyType&,KeyTypeKeyCompare) template<class KeyType, class KeyTypeKeyCompare> iterator upper_bound(const KeyType& key, KeyTypeKeyCompare comp); //! @copydoc ::boost::intrusive::bstree::upper_bound(const key_type &)const const_iterator upper_bound(const key_type &key) const; //! @copydoc ::boost::intrusive::bstree::upper_bound(const KeyType&,KeyTypeKeyCompare)const template<class KeyType, class KeyTypeKeyCompare> const_iterator upper_bound(const KeyType& key, KeyTypeKeyCompare comp) const; //! @copydoc ::boost::intrusive::bstree::find(const key_type &) iterator find(const key_type &key); //! @copydoc ::boost::intrusive::bstree::find(const KeyType&,KeyTypeKeyCompare) template<class KeyType, class KeyTypeKeyCompare> iterator find(const KeyType& key, KeyTypeKeyCompare comp); //! @copydoc ::boost::intrusive::bstree::find(const key_type &)const const_iterator find(const key_type &key) const; //! @copydoc ::boost::intrusive::bstree::find(const KeyType&,KeyTypeKeyCompare)const template<class KeyType, class KeyTypeKeyCompare> const_iterator find(const KeyType& key, KeyTypeKeyCompare comp) const; //! @copydoc ::boost::intrusive::bstree::equal_range(const key_type &) std::pair<iterator,iterator> equal_range(const key_type &key); //! @copydoc ::boost::intrusive::bstree::equal_range(const KeyType&,KeyTypeKeyCompare) template<class KeyType, class KeyTypeKeyCompare> std::pair<iterator,iterator> equal_range(const KeyType& key, KeyTypeKeyCompare comp); //! @copydoc ::boost::intrusive::bstree::equal_range(const key_type &)const std::pair<const_iterator, const_iterator> equal_range(const key_type &key) const; //! @copydoc ::boost::intrusive::bstree::equal_range(const KeyType&,KeyTypeKeyCompare)const template<class KeyType, class KeyTypeKeyCompare> std::pair<const_iterator, const_iterator> equal_range(const KeyType& key, KeyTypeKeyCompare comp) const; //! @copydoc ::boost::intrusive::bstree::bounded_range(const key_type &,const key_type &,bool,bool) std::pair<iterator,iterator> bounded_range (const key_type &lower, const key_type &upper_key, bool left_closed, bool right_closed); //! @copydoc ::boost::intrusive::bstree::bounded_range(const KeyType&,const KeyType&,KeyTypeKeyCompare,bool,bool) template<class KeyType, class KeyTypeKeyCompare> std::pair<iterator,iterator> bounded_range (const KeyType& lower_key, const KeyType& upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed); //! @copydoc ::boost::intrusive::bstree::bounded_range(const key_type &,const key_type &,bool,bool)const std::pair<const_iterator, const_iterator> bounded_range(const key_type &lower_key, const key_type &upper_key, bool left_closed, bool right_closed) const; //! @copydoc ::boost::intrusive::bstree::bounded_range(const KeyType&,const KeyType&,KeyTypeKeyCompare,bool,bool)const template<class KeyType, class KeyTypeKeyCompare> std::pair<const_iterator, const_iterator> bounded_range (const KeyType& lower_key, const KeyType& upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed) const; //! @copydoc ::boost::intrusive::bstree::s_iterator_to(reference) static iterator s_iterator_to(reference value); //! @copydoc ::boost::intrusive::bstree::s_iterator_to(const_reference) static const_iterator s_iterator_to(const_reference value); //! @copydoc ::boost::intrusive::bstree::iterator_to(reference) iterator iterator_to(reference value); //! @copydoc ::boost::intrusive::bstree::iterator_to(const_reference)const const_iterator iterator_to(const_reference value) const; //! @copydoc ::boost::intrusive::bstree::init_node(reference) static void init_node(reference value); //! @copydoc ::boost::intrusive::bstree::unlink_leftmost_without_rebalance pointer unlink_leftmost_without_rebalance(); //! @copydoc ::boost::intrusive::bstree::replace_node void replace_node(iterator replace_this, reference with_this); //! @copydoc ::boost::intrusive::bstree::remove_node void remove_node(reference value); friend bool operator< (const rbtree_impl &x, const rbtree_impl &y); friend bool operator==(const rbtree_impl &x, const rbtree_impl &y); friend bool operator!= (const rbtree_impl &x, const rbtree_impl &y); friend bool operator>(const rbtree_impl &x, const rbtree_impl &y); friend bool operator<=(const rbtree_impl &x, const rbtree_impl &y); friend bool operator>=(const rbtree_impl &x, const rbtree_impl &y); friend void swap(rbtree_impl &x, rbtree_impl &y); #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED }; //! Helper metafunction to define a \c rbtree that yields to the same type when the //! same options (either explicitly or implicitly) are used. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) || defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) template<class T, class ...Options> #else template<class T, class O1 = void, class O2 = void , class O3 = void, class O4 = void , class O5 = void, class O6 = void> #endif struct make_rbtree { /// @cond typedef typename pack_options < rbtree_defaults, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4, O5, O6 #else Options... #endif >::type packed_options; typedef typename detail::get_value_traits <T, typename packed_options::proto_value_traits>::type value_traits; typedef rbtree_impl < value_traits , typename packed_options::key_of_value , typename packed_options::compare , typename packed_options::size_type , packed_options::constant_time_size , typename packed_options::header_holder_type > implementation_defined; /// @endcond typedef implementation_defined type; }; #ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) template<class T, class O1, class O2, class O3, class O4, class O5, class O6> #else template<class T, class ...Options> #endif class rbtree : public make_rbtree<T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4, O5, O6 #else Options... #endif >::type { typedef typename make_rbtree <T, #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES) O1, O2, O3, O4, O5, O6 #else Options... #endif >::type Base; BOOST_MOVABLE_BUT_NOT_COPYABLE(rbtree) public: typedef typename Base::key_compare key_compare; typedef typename Base::value_traits value_traits; typedef typename Base::iterator iterator; typedef typename Base::const_iterator const_iterator; typedef typename Base::reverse_iterator reverse_iterator; typedef typename Base::const_reverse_iterator const_reverse_iterator; //Assert if passed value traits are compatible with the type BOOST_STATIC_ASSERT((detail::is_same<typename value_traits::value_type, T>::value)); explicit rbtree( const key_compare &cmp = key_compare() , const value_traits &v_traits = value_traits()) : Base(cmp, v_traits) {} template<class Iterator> rbtree( bool unique, Iterator b, Iterator e , const key_compare &cmp = key_compare() , const value_traits &v_traits = value_traits()) : Base(unique, b, e, cmp, v_traits) {} rbtree(BOOST_RV_REF(rbtree) x) : Base(BOOST_MOVE_BASE(Base, x)) {} rbtree& operator=(BOOST_RV_REF(rbtree) x) { return static_cast<rbtree &>(this->Base::operator=(BOOST_MOVE_BASE(Base, x))); } template <class Cloner, class Disposer> void clone_from(const rbtree &src, Cloner cloner, Disposer disposer) { Base::clone_from(src, cloner, disposer); } template <class Cloner, class Disposer> void clone_from(BOOST_RV_REF(rbtree) src, Cloner cloner, Disposer disposer) { Base::clone_from(BOOST_MOVE_BASE(Base, src), cloner, disposer); } static rbtree &container_from_end_iterator(iterator end_iterator) { return static_cast<rbtree &>(Base::container_from_end_iterator(end_iterator)); } static const rbtree &container_from_end_iterator(const_iterator end_iterator) { return static_cast<const rbtree &>(Base::container_from_end_iterator(end_iterator)); } static rbtree &container_from_iterator(iterator it) { return static_cast<rbtree &>(Base::container_from_iterator(it)); } static const rbtree &container_from_iterator(const_iterator it) { return static_cast<const rbtree &>(Base::container_from_iterator(it)); } }; #endif } //namespace intrusive } //namespace boost #include <boost/intrusive/detail/config_end.hpp> #endif //BOOST_INTRUSIVE_RBTREE_HPP