set.hpp 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923
  1. /////////////////////////////////////////////////////////////////////////////
  2. //
  3. // (C) Copyright Olaf Krzikalla 2004-2006.
  4. // (C) Copyright Ion Gaztanaga 2006-2013
  5. //
  6. // Distributed under the Boost Software License, Version 1.0.
  7. // (See accompanying file LICENSE_1_0.txt or copy at
  8. // http://www.boost.org/LICENSE_1_0.txt)
  9. //
  10. // See http://www.boost.org/libs/intrusive for documentation.
  11. //
  12. /////////////////////////////////////////////////////////////////////////////
  13. #ifndef BOOST_INTRUSIVE_SET_HPP
  14. #define BOOST_INTRUSIVE_SET_HPP
  15. #include <boost/intrusive/detail/config_begin.hpp>
  16. #include <boost/intrusive/intrusive_fwd.hpp>
  17. #include <boost/intrusive/detail/mpl.hpp>
  18. #include <boost/intrusive/rbtree.hpp>
  19. #include <iterator>
  20. #include <boost/move/move.hpp>
  21. namespace boost {
  22. namespace intrusive {
  23. //! The class template set is an intrusive container, that mimics most of
  24. //! the interface of std::set as described in the C++ standard.
  25. //!
  26. //! The template parameter \c T is the type to be managed by the container.
  27. //! The user can specify additional options and if no options are provided
  28. //! default options are used.
  29. //!
  30. //! The container supports the following options:
  31. //! \c base_hook<>/member_hook<>/value_traits<>,
  32. //! \c constant_time_size<>, \c size_type<> and
  33. //! \c compare<>.
  34. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  35. template<class T, class ...Options>
  36. #else
  37. template<class ValueTraits, class Compare, class SizeType, bool ConstantTimeSize>
  38. #endif
  39. class set_impl
  40. #ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  41. : public bstree_impl<ValueTraits, Compare, SizeType, ConstantTimeSize, RbTreeAlgorithms>
  42. #endif
  43. {
  44. /// @cond
  45. typedef bstree_impl<ValueTraits, Compare, SizeType, ConstantTimeSize, RbTreeAlgorithms> tree_type;
  46. BOOST_MOVABLE_BUT_NOT_COPYABLE(set_impl)
  47. typedef tree_type implementation_defined;
  48. /// @endcond
  49. public:
  50. typedef typename implementation_defined::value_type value_type;
  51. typedef typename implementation_defined::value_traits value_traits;
  52. typedef typename implementation_defined::pointer pointer;
  53. typedef typename implementation_defined::const_pointer const_pointer;
  54. typedef typename implementation_defined::reference reference;
  55. typedef typename implementation_defined::const_reference const_reference;
  56. typedef typename implementation_defined::difference_type difference_type;
  57. typedef typename implementation_defined::size_type size_type;
  58. typedef typename implementation_defined::value_compare value_compare;
  59. typedef typename implementation_defined::key_compare key_compare;
  60. typedef typename implementation_defined::iterator iterator;
  61. typedef typename implementation_defined::const_iterator const_iterator;
  62. typedef typename implementation_defined::reverse_iterator reverse_iterator;
  63. typedef typename implementation_defined::const_reverse_iterator const_reverse_iterator;
  64. typedef typename implementation_defined::insert_commit_data insert_commit_data;
  65. typedef typename implementation_defined::node_traits node_traits;
  66. typedef typename implementation_defined::node node;
  67. typedef typename implementation_defined::node_ptr node_ptr;
  68. typedef typename implementation_defined::const_node_ptr const_node_ptr;
  69. typedef typename implementation_defined::node_algorithms node_algorithms;
  70. static const bool constant_time_size = tree_type::constant_time_size;
  71. public:
  72. //! @copydoc ::boost::intrusive::rbtree::rbtree(const value_compare &,const value_traits &)
  73. explicit set_impl( const value_compare &cmp = value_compare()
  74. , const value_traits &v_traits = value_traits())
  75. : tree_type(cmp, v_traits)
  76. {}
  77. //! @copydoc ::boost::intrusive::rbtree::rbtree(bool,Iterator,Iterator,const value_compare &,const value_traits &)
  78. template<class Iterator>
  79. set_impl( Iterator b, Iterator e
  80. , const value_compare &cmp = value_compare()
  81. , const value_traits &v_traits = value_traits())
  82. : tree_type(true, b, e, cmp, v_traits)
  83. {}
  84. //! @copydoc ::boost::intrusive::rbtree::rbtree(rbtree &&)
  85. set_impl(BOOST_RV_REF(set_impl) x)
  86. : tree_type(::boost::move(static_cast<tree_type&>(x)))
  87. {}
  88. //! @copydoc ::boost::intrusive::rbtree::operator=(rbtree &&)
  89. set_impl& operator=(BOOST_RV_REF(set_impl) x)
  90. { return static_cast<set_impl&>(tree_type::operator=(::boost::move(static_cast<tree_type&>(x)))); }
  91. #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  92. //! @copydoc ::boost::intrusive::rbtree::~rbtree()
  93. ~set_impl();
  94. //! @copydoc ::boost::intrusive::rbtree::begin()
  95. iterator begin();
  96. //! @copydoc ::boost::intrusive::rbtree::begin()const
  97. const_iterator begin() const;
  98. //! @copydoc ::boost::intrusive::rbtree::cbegin()const
  99. const_iterator cbegin() const;
  100. //! @copydoc ::boost::intrusive::rbtree::end()
  101. iterator end();
  102. //! @copydoc ::boost::intrusive::rbtree::end()const
  103. const_iterator end() const;
  104. //! @copydoc ::boost::intrusive::rbtree::cend()const
  105. const_iterator cend() const;
  106. //! @copydoc ::boost::intrusive::rbtree::rbegin()
  107. reverse_iterator rbegin();
  108. //! @copydoc ::boost::intrusive::rbtree::rbegin()const
  109. const_reverse_iterator rbegin() const;
  110. //! @copydoc ::boost::intrusive::rbtree::crbegin()const
  111. const_reverse_iterator crbegin() const;
  112. //! @copydoc ::boost::intrusive::rbtree::rend()
  113. reverse_iterator rend();
  114. //! @copydoc ::boost::intrusive::rbtree::rend()const
  115. const_reverse_iterator rend() const;
  116. //! @copydoc ::boost::intrusive::rbtree::crend()const
  117. const_reverse_iterator crend() const;
  118. //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(iterator)
  119. static set_impl &container_from_end_iterator(iterator end_iterator);
  120. //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(const_iterator)
  121. static const set_impl &container_from_end_iterator(const_iterator end_iterator);
  122. //! @copydoc ::boost::intrusive::rbtree::container_from_iterator(iterator)
  123. static set_impl &container_from_iterator(iterator it);
  124. //! @copydoc ::boost::intrusive::rbtree::container_from_iterator(const_iterator)
  125. static const set_impl &container_from_iterator(const_iterator it);
  126. //! @copydoc ::boost::intrusive::rbtree::key_comp()const
  127. key_compare key_comp() const;
  128. //! @copydoc ::boost::intrusive::rbtree::value_comp()const
  129. value_compare value_comp() const;
  130. //! @copydoc ::boost::intrusive::rbtree::empty()const
  131. bool empty() const;
  132. //! @copydoc ::boost::intrusive::rbtree::size()const
  133. size_type size() const;
  134. //! @copydoc ::boost::intrusive::rbtree::swap
  135. void swap(set_impl& other);
  136. //! @copydoc ::boost::intrusive::rbtree::clone_from
  137. template <class Cloner, class Disposer>
  138. void clone_from(const set_impl &src, Cloner cloner, Disposer disposer);
  139. #endif //#ifdef BOOST_iNTRUSIVE_DOXYGEN_INVOKED
  140. //! @copydoc ::boost::intrusive::rbtree::insert_unique(reference)
  141. std::pair<iterator, bool> insert(reference value)
  142. { return tree_type::insert_unique(value); }
  143. //! @copydoc ::boost::intrusive::rbtree::insert_unique(const_iterator,reference)
  144. iterator insert(const_iterator hint, reference value)
  145. { return tree_type::insert_unique(hint, value); }
  146. //! @copydoc ::boost::intrusive::rbtree::insert_unique_check(const KeyType&,KeyValueCompare,insert_commit_data&)
  147. template<class KeyType, class KeyValueCompare>
  148. std::pair<iterator, bool> insert_check
  149. (const KeyType &key, KeyValueCompare key_value_comp, insert_commit_data &commit_data)
  150. { return tree_type::insert_unique_check(key, key_value_comp, commit_data); }
  151. //! @copydoc ::boost::intrusive::rbtree::insert_unique_check(const_iterator,const KeyType&,KeyValueCompare,insert_commit_data&)
  152. template<class KeyType, class KeyValueCompare>
  153. std::pair<iterator, bool> insert_check
  154. (const_iterator hint, const KeyType &key
  155. ,KeyValueCompare key_value_comp, insert_commit_data &commit_data)
  156. { return tree_type::insert_unique_check(hint, key, key_value_comp, commit_data); }
  157. //! @copydoc ::boost::intrusive::rbtree::insert_unique(Iterator,Iterator)
  158. template<class Iterator>
  159. void insert(Iterator b, Iterator e)
  160. { tree_type::insert_unique(b, e); }
  161. //! @copydoc ::boost::intrusive::rbtree::insert_unique_commit
  162. iterator insert_commit(reference value, const insert_commit_data &commit_data)
  163. { return tree_type::insert_unique_commit(value, commit_data); }
  164. #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  165. //! @copydoc ::boost::intrusive::rbtree::insert_before
  166. iterator insert_before(const_iterator pos, reference value);
  167. //! @copydoc ::boost::intrusive::rbtree::push_back
  168. void push_back(reference value);
  169. //! @copydoc ::boost::intrusive::rbtree::push_front
  170. void push_front(reference value);
  171. //! @copydoc ::boost::intrusive::rbtree::erase(const_iterator)
  172. iterator erase(const_iterator i);
  173. //! @copydoc ::boost::intrusive::rbtree::erase(const_iterator,const_iterator)
  174. iterator erase(const_iterator b, const_iterator e);
  175. //! @copydoc ::boost::intrusive::rbtree::erase(const_reference)
  176. size_type erase(const_reference value);
  177. //! @copydoc ::boost::intrusive::rbtree::erase(const KeyType&,KeyValueCompare)
  178. template<class KeyType, class KeyValueCompare>
  179. size_type erase(const KeyType& key, KeyValueCompare comp);
  180. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_iterator,Disposer)
  181. template<class Disposer>
  182. iterator erase_and_dispose(const_iterator i, Disposer disposer);
  183. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_iterator,const_iterator,Disposer)
  184. template<class Disposer>
  185. iterator erase_and_dispose(const_iterator b, const_iterator e, Disposer disposer);
  186. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_reference, Disposer)
  187. template<class Disposer>
  188. size_type erase_and_dispose(const_reference value, Disposer disposer);
  189. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const KeyType&,KeyValueCompare,Disposer)
  190. template<class KeyType, class KeyValueCompare, class Disposer>
  191. size_type erase_and_dispose(const KeyType& key, KeyValueCompare comp, Disposer disposer);
  192. //! @copydoc ::boost::intrusive::rbtree::clear
  193. void clear();
  194. //! @copydoc ::boost::intrusive::rbtree::clear_and_dispose
  195. template<class Disposer>
  196. void clear_and_dispose(Disposer disposer);
  197. //! @copydoc ::boost::intrusive::rbtree::count(const_reference)const
  198. size_type count(const_reference value) const;
  199. //! @copydoc ::boost::intrusive::rbtree::count(const KeyType&,KeyValueCompare)const
  200. template<class KeyType, class KeyValueCompare>
  201. size_type count(const KeyType& key, KeyValueCompare comp) const;
  202. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const_reference)
  203. iterator lower_bound(const_reference value);
  204. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const KeyType&,KeyValueCompare)
  205. template<class KeyType, class KeyValueCompare>
  206. iterator lower_bound(const KeyType& key, KeyValueCompare comp);
  207. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const_reference)const
  208. const_iterator lower_bound(const_reference value) const;
  209. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const KeyType&,KeyValueCompare)const
  210. template<class KeyType, class KeyValueCompare>
  211. const_iterator lower_bound(const KeyType& key, KeyValueCompare comp) const;
  212. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const_reference)
  213. iterator upper_bound(const_reference value);
  214. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const KeyType&,KeyValueCompare)
  215. template<class KeyType, class KeyValueCompare>
  216. iterator upper_bound(const KeyType& key, KeyValueCompare comp);
  217. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const_reference)const
  218. const_iterator upper_bound(const_reference value) const;
  219. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const KeyType&,KeyValueCompare)const
  220. template<class KeyType, class KeyValueCompare>
  221. const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const;
  222. //! @copydoc ::boost::intrusive::rbtree::find(const_reference)
  223. iterator find(const_reference value);
  224. //! @copydoc ::boost::intrusive::rbtree::find(const KeyType&,KeyValueCompare)
  225. template<class KeyType, class KeyValueCompare>
  226. iterator find(const KeyType& key, KeyValueCompare comp);
  227. //! @copydoc ::boost::intrusive::rbtree::find(const_reference)const
  228. const_iterator find(const_reference value) const;
  229. //! @copydoc ::boost::intrusive::rbtree::find(const KeyType&,KeyValueCompare)const
  230. template<class KeyType, class KeyValueCompare>
  231. const_iterator find(const KeyType& key, KeyValueCompare comp) const;
  232. //! @copydoc ::boost::intrusive::rbtree::equal_range(const_reference)
  233. std::pair<iterator,iterator> equal_range(const_reference value);
  234. //! @copydoc ::boost::intrusive::rbtree::equal_range(const KeyType&,KeyValueCompare)
  235. template<class KeyType, class KeyValueCompare>
  236. std::pair<iterator,iterator> equal_range(const KeyType& key, KeyValueCompare comp);
  237. //! @copydoc ::boost::intrusive::rbtree::equal_range(const_reference)const
  238. std::pair<const_iterator, const_iterator>
  239. equal_range(const_reference value) const;
  240. //! @copydoc ::boost::intrusive::rbtree::equal_range(const KeyType&,KeyValueCompare)const
  241. template<class KeyType, class KeyValueCompare>
  242. std::pair<const_iterator, const_iterator>
  243. equal_range(const KeyType& key, KeyValueCompare comp) const;
  244. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const_reference,const_reference,bool,bool)
  245. std::pair<iterator,iterator> bounded_range
  246. (const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed);
  247. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const KeyType&,const KeyType&,KeyValueCompare,bool,bool)
  248. template<class KeyType, class KeyValueCompare>
  249. std::pair<iterator,iterator> bounded_range
  250. (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed);
  251. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const_reference,const_reference,bool,bool)const
  252. std::pair<const_iterator, const_iterator>
  253. bounded_range(const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) const;
  254. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const KeyType&,const KeyType&,KeyValueCompare,bool,bool)const
  255. template<class KeyType, class KeyValueCompare>
  256. std::pair<const_iterator, const_iterator> bounded_range
  257. (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) const;
  258. //! @copydoc ::boost::intrusive::rbtree::s_iterator_to(reference)
  259. static iterator s_iterator_to(reference value);
  260. //! @copydoc ::boost::intrusive::rbtree::s_iterator_to(const_reference)
  261. static const_iterator s_iterator_to(const_reference value);
  262. //! @copydoc ::boost::intrusive::rbtree::iterator_to(reference)
  263. iterator iterator_to(reference value);
  264. //! @copydoc ::boost::intrusive::rbtree::iterator_to(const_reference)const
  265. const_iterator iterator_to(const_reference value) const;
  266. //! @copydoc ::boost::intrusive::rbtree::init_node(reference)
  267. static void init_node(reference value);
  268. //! @copydoc ::boost::intrusive::rbtree::unlink_leftmost_without_rebalance
  269. pointer unlink_leftmost_without_rebalance();
  270. //! @copydoc ::boost::intrusive::rbtree::replace_node
  271. void replace_node(iterator replace_this, reference with_this);
  272. //! @copydoc ::boost::intrusive::rbtree::remove_node
  273. void remove_node(reference value);
  274. #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  275. };
  276. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  277. template<class T, class ...Options>
  278. bool operator!= (const set_impl<T, Options...> &x, const set_impl<T, Options...> &y);
  279. template<class T, class ...Options>
  280. bool operator>(const set_impl<T, Options...> &x, const set_impl<T, Options...> &y);
  281. template<class T, class ...Options>
  282. bool operator<=(const set_impl<T, Options...> &x, const set_impl<T, Options...> &y);
  283. template<class T, class ...Options>
  284. bool operator>=(const set_impl<T, Options...> &x, const set_impl<T, Options...> &y);
  285. template<class T, class ...Options>
  286. void swap(set_impl<T, Options...> &x, set_impl<T, Options...> &y);
  287. #endif //#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  288. //! Helper metafunction to define a \c set that yields to the same type when the
  289. //! same options (either explicitly or implicitly) are used.
  290. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) || defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  291. template<class T, class ...Options>
  292. #else
  293. template<class T, class O1 = void, class O2 = void
  294. , class O3 = void, class O4 = void>
  295. #endif
  296. struct make_set
  297. {
  298. /// @cond
  299. typedef typename pack_options
  300. < rbtree_defaults,
  301. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  302. O1, O2, O3, O4
  303. #else
  304. Options...
  305. #endif
  306. >::type packed_options;
  307. typedef typename detail::get_value_traits
  308. <T, typename packed_options::proto_value_traits>::type value_traits;
  309. typedef set_impl
  310. < value_traits
  311. , typename packed_options::compare
  312. , typename packed_options::size_type
  313. , packed_options::constant_time_size
  314. > implementation_defined;
  315. /// @endcond
  316. typedef implementation_defined type;
  317. };
  318. #ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  319. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  320. template<class T, class O1, class O2, class O3, class O4>
  321. #else
  322. template<class T, class ...Options>
  323. #endif
  324. class set
  325. : public make_set<T,
  326. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  327. O1, O2, O3, O4
  328. #else
  329. Options...
  330. #endif
  331. >::type
  332. {
  333. typedef typename make_set
  334. <T,
  335. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  336. O1, O2, O3, O4
  337. #else
  338. Options...
  339. #endif
  340. >::type Base;
  341. BOOST_MOVABLE_BUT_NOT_COPYABLE(set)
  342. public:
  343. typedef typename Base::value_compare value_compare;
  344. typedef typename Base::value_traits value_traits;
  345. typedef typename Base::iterator iterator;
  346. typedef typename Base::const_iterator const_iterator;
  347. //Assert if passed value traits are compatible with the type
  348. BOOST_STATIC_ASSERT((detail::is_same<typename value_traits::value_type, T>::value));
  349. explicit set( const value_compare &cmp = value_compare()
  350. , const value_traits &v_traits = value_traits())
  351. : Base(cmp, v_traits)
  352. {}
  353. template<class Iterator>
  354. set( Iterator b, Iterator e
  355. , const value_compare &cmp = value_compare()
  356. , const value_traits &v_traits = value_traits())
  357. : Base(b, e, cmp, v_traits)
  358. {}
  359. set(BOOST_RV_REF(set) x)
  360. : Base(::boost::move(static_cast<Base&>(x)))
  361. {}
  362. set& operator=(BOOST_RV_REF(set) x)
  363. { return static_cast<set &>(this->Base::operator=(::boost::move(static_cast<Base&>(x)))); }
  364. static set &container_from_end_iterator(iterator end_iterator)
  365. { return static_cast<set &>(Base::container_from_end_iterator(end_iterator)); }
  366. static const set &container_from_end_iterator(const_iterator end_iterator)
  367. { return static_cast<const set &>(Base::container_from_end_iterator(end_iterator)); }
  368. static set &container_from_iterator(iterator it)
  369. { return static_cast<set &>(Base::container_from_iterator(it)); }
  370. static const set &container_from_iterator(const_iterator it)
  371. { return static_cast<const set &>(Base::container_from_iterator(it)); }
  372. };
  373. #endif
  374. //! The class template multiset is an intrusive container, that mimics most of
  375. //! the interface of std::multiset as described in the C++ standard.
  376. //!
  377. //! The template parameter \c T is the type to be managed by the container.
  378. //! The user can specify additional options and if no options are provided
  379. //! default options are used.
  380. //!
  381. //! The container supports the following options:
  382. //! \c base_hook<>/member_hook<>/value_traits<>,
  383. //! \c constant_time_size<>, \c size_type<> and
  384. //! \c compare<>.
  385. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  386. template<class T, class ...Options>
  387. #else
  388. template<class ValueTraits, class Compare, class SizeType, bool ConstantTimeSize>
  389. #endif
  390. class multiset_impl
  391. #ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  392. : public bstree_impl<ValueTraits, Compare, SizeType, ConstantTimeSize, RbTreeAlgorithms>
  393. #endif
  394. {
  395. /// @cond
  396. typedef bstree_impl<ValueTraits, Compare, SizeType, ConstantTimeSize, RbTreeAlgorithms> tree_type;
  397. BOOST_MOVABLE_BUT_NOT_COPYABLE(multiset_impl)
  398. typedef tree_type implementation_defined;
  399. /// @endcond
  400. public:
  401. typedef typename implementation_defined::value_type value_type;
  402. typedef typename implementation_defined::value_traits value_traits;
  403. typedef typename implementation_defined::pointer pointer;
  404. typedef typename implementation_defined::const_pointer const_pointer;
  405. typedef typename implementation_defined::reference reference;
  406. typedef typename implementation_defined::const_reference const_reference;
  407. typedef typename implementation_defined::difference_type difference_type;
  408. typedef typename implementation_defined::size_type size_type;
  409. typedef typename implementation_defined::value_compare value_compare;
  410. typedef typename implementation_defined::key_compare key_compare;
  411. typedef typename implementation_defined::iterator iterator;
  412. typedef typename implementation_defined::const_iterator const_iterator;
  413. typedef typename implementation_defined::reverse_iterator reverse_iterator;
  414. typedef typename implementation_defined::const_reverse_iterator const_reverse_iterator;
  415. typedef typename implementation_defined::insert_commit_data insert_commit_data;
  416. typedef typename implementation_defined::node_traits node_traits;
  417. typedef typename implementation_defined::node node;
  418. typedef typename implementation_defined::node_ptr node_ptr;
  419. typedef typename implementation_defined::const_node_ptr const_node_ptr;
  420. typedef typename implementation_defined::node_algorithms node_algorithms;
  421. static const bool constant_time_size = tree_type::constant_time_size;
  422. public:
  423. //! @copydoc ::boost::intrusive::rbtree::rbtree(const value_compare &,const value_traits &)
  424. explicit multiset_impl( const value_compare &cmp = value_compare()
  425. , const value_traits &v_traits = value_traits())
  426. : tree_type(cmp, v_traits)
  427. {}
  428. //! @copydoc ::boost::intrusive::rbtree::rbtree(bool,Iterator,Iterator,const value_compare &,const value_traits &)
  429. template<class Iterator>
  430. multiset_impl( Iterator b, Iterator e
  431. , const value_compare &cmp = value_compare()
  432. , const value_traits &v_traits = value_traits())
  433. : tree_type(false, b, e, cmp, v_traits)
  434. {}
  435. //! @copydoc ::boost::intrusive::rbtree::rbtree(rbtree &&)
  436. multiset_impl(BOOST_RV_REF(multiset_impl) x)
  437. : tree_type(::boost::move(static_cast<tree_type&>(x)))
  438. {}
  439. //! @copydoc ::boost::intrusive::rbtree::operator=(rbtree &&)
  440. multiset_impl& operator=(BOOST_RV_REF(multiset_impl) x)
  441. { return static_cast<multiset_impl&>(tree_type::operator=(::boost::move(static_cast<tree_type&>(x)))); }
  442. #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  443. //! @copydoc ::boost::intrusive::rbtree::~rbtree()
  444. ~multiset_impl();
  445. //! @copydoc ::boost::intrusive::rbtree::begin()
  446. iterator begin();
  447. //! @copydoc ::boost::intrusive::rbtree::begin()const
  448. const_iterator begin() const;
  449. //! @copydoc ::boost::intrusive::rbtree::cbegin()const
  450. const_iterator cbegin() const;
  451. //! @copydoc ::boost::intrusive::rbtree::end()
  452. iterator end();
  453. //! @copydoc ::boost::intrusive::rbtree::end()const
  454. const_iterator end() const;
  455. //! @copydoc ::boost::intrusive::rbtree::cend()const
  456. const_iterator cend() const;
  457. //! @copydoc ::boost::intrusive::rbtree::rbegin()
  458. reverse_iterator rbegin();
  459. //! @copydoc ::boost::intrusive::rbtree::rbegin()const
  460. const_reverse_iterator rbegin() const;
  461. //! @copydoc ::boost::intrusive::rbtree::crbegin()const
  462. const_reverse_iterator crbegin() const;
  463. //! @copydoc ::boost::intrusive::rbtree::rend()
  464. reverse_iterator rend();
  465. //! @copydoc ::boost::intrusive::rbtree::rend()const
  466. const_reverse_iterator rend() const;
  467. //! @copydoc ::boost::intrusive::rbtree::crend()const
  468. const_reverse_iterator crend() const;
  469. //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(iterator)
  470. static multiset_impl &container_from_end_iterator(iterator end_iterator);
  471. //! @copydoc ::boost::intrusive::rbtree::container_from_end_iterator(const_iterator)
  472. static const multiset_impl &container_from_end_iterator(const_iterator end_iterator);
  473. //! @copydoc ::boost::intrusive::rbtree::container_from_iterator(iterator)
  474. static multiset_impl &container_from_iterator(iterator it);
  475. //! @copydoc ::boost::intrusive::rbtree::container_from_iterator(const_iterator)
  476. static const multiset_impl &container_from_iterator(const_iterator it);
  477. //! @copydoc ::boost::intrusive::rbtree::key_comp()const
  478. key_compare key_comp() const;
  479. //! @copydoc ::boost::intrusive::rbtree::value_comp()const
  480. value_compare value_comp() const;
  481. //! @copydoc ::boost::intrusive::rbtree::empty()const
  482. bool empty() const;
  483. //! @copydoc ::boost::intrusive::rbtree::size()const
  484. size_type size() const;
  485. //! @copydoc ::boost::intrusive::rbtree::swap
  486. void swap(multiset_impl& other);
  487. //! @copydoc ::boost::intrusive::rbtree::clone_from
  488. template <class Cloner, class Disposer>
  489. void clone_from(const multiset_impl &src, Cloner cloner, Disposer disposer);
  490. #endif //#ifdef BOOST_iNTRUSIVE_DOXYGEN_INVOKED
  491. //! @copydoc ::boost::intrusive::rbtree::insert_equal(reference)
  492. iterator insert(reference value)
  493. { return tree_type::insert_equal(value); }
  494. //! @copydoc ::boost::intrusive::rbtree::insert_equal(const_iterator,reference)
  495. iterator insert(const_iterator hint, reference value)
  496. { return tree_type::insert_equal(hint, value); }
  497. //! @copydoc ::boost::intrusive::rbtree::insert_equal(Iterator,Iterator)
  498. template<class Iterator>
  499. void insert(Iterator b, Iterator e)
  500. { tree_type::insert_equal(b, e); }
  501. #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  502. //! @copydoc ::boost::intrusive::rbtree::insert_before
  503. iterator insert_before(const_iterator pos, reference value);
  504. //! @copydoc ::boost::intrusive::rbtree::push_back
  505. void push_back(reference value);
  506. //! @copydoc ::boost::intrusive::rbtree::push_front
  507. void push_front(reference value);
  508. //! @copydoc ::boost::intrusive::rbtree::erase(const_iterator)
  509. iterator erase(const_iterator i);
  510. //! @copydoc ::boost::intrusive::rbtree::erase(const_iterator,const_iterator)
  511. iterator erase(const_iterator b, const_iterator e);
  512. //! @copydoc ::boost::intrusive::rbtree::erase(const_reference)
  513. size_type erase(const_reference value);
  514. //! @copydoc ::boost::intrusive::rbtree::erase(const KeyType&,KeyValueCompare)
  515. template<class KeyType, class KeyValueCompare>
  516. size_type erase(const KeyType& key, KeyValueCompare comp);
  517. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_iterator,Disposer)
  518. template<class Disposer>
  519. iterator erase_and_dispose(const_iterator i, Disposer disposer);
  520. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_iterator,const_iterator,Disposer)
  521. template<class Disposer>
  522. iterator erase_and_dispose(const_iterator b, const_iterator e, Disposer disposer);
  523. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const_reference, Disposer)
  524. template<class Disposer>
  525. size_type erase_and_dispose(const_reference value, Disposer disposer);
  526. //! @copydoc ::boost::intrusive::rbtree::erase_and_dispose(const KeyType&,KeyValueCompare,Disposer)
  527. template<class KeyType, class KeyValueCompare, class Disposer>
  528. size_type erase_and_dispose(const KeyType& key, KeyValueCompare comp, Disposer disposer);
  529. //! @copydoc ::boost::intrusive::rbtree::clear
  530. void clear();
  531. //! @copydoc ::boost::intrusive::rbtree::clear_and_dispose
  532. template<class Disposer>
  533. void clear_and_dispose(Disposer disposer);
  534. //! @copydoc ::boost::intrusive::rbtree::count(const_reference)const
  535. size_type count(const_reference value) const;
  536. //! @copydoc ::boost::intrusive::rbtree::count(const KeyType&,KeyValueCompare)const
  537. template<class KeyType, class KeyValueCompare>
  538. size_type count(const KeyType& key, KeyValueCompare comp) const;
  539. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const_reference)
  540. iterator lower_bound(const_reference value);
  541. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const KeyType&,KeyValueCompare)
  542. template<class KeyType, class KeyValueCompare>
  543. iterator lower_bound(const KeyType& key, KeyValueCompare comp);
  544. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const_reference)const
  545. const_iterator lower_bound(const_reference value) const;
  546. //! @copydoc ::boost::intrusive::rbtree::lower_bound(const KeyType&,KeyValueCompare)const
  547. template<class KeyType, class KeyValueCompare>
  548. const_iterator lower_bound(const KeyType& key, KeyValueCompare comp) const;
  549. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const_reference)
  550. iterator upper_bound(const_reference value);
  551. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const KeyType&,KeyValueCompare)
  552. template<class KeyType, class KeyValueCompare>
  553. iterator upper_bound(const KeyType& key, KeyValueCompare comp);
  554. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const_reference)const
  555. const_iterator upper_bound(const_reference value) const;
  556. //! @copydoc ::boost::intrusive::rbtree::upper_bound(const KeyType&,KeyValueCompare)const
  557. template<class KeyType, class KeyValueCompare>
  558. const_iterator upper_bound(const KeyType& key, KeyValueCompare comp) const;
  559. //! @copydoc ::boost::intrusive::rbtree::find(const_reference)
  560. iterator find(const_reference value);
  561. //! @copydoc ::boost::intrusive::rbtree::find(const KeyType&,KeyValueCompare)
  562. template<class KeyType, class KeyValueCompare>
  563. iterator find(const KeyType& key, KeyValueCompare comp);
  564. //! @copydoc ::boost::intrusive::rbtree::find(const_reference)const
  565. const_iterator find(const_reference value) const;
  566. //! @copydoc ::boost::intrusive::rbtree::find(const KeyType&,KeyValueCompare)const
  567. template<class KeyType, class KeyValueCompare>
  568. const_iterator find(const KeyType& key, KeyValueCompare comp) const;
  569. //! @copydoc ::boost::intrusive::rbtree::equal_range(const_reference)
  570. std::pair<iterator,iterator> equal_range(const_reference value);
  571. //! @copydoc ::boost::intrusive::rbtree::equal_range(const KeyType&,KeyValueCompare)
  572. template<class KeyType, class KeyValueCompare>
  573. std::pair<iterator,iterator> equal_range(const KeyType& key, KeyValueCompare comp);
  574. //! @copydoc ::boost::intrusive::rbtree::equal_range(const_reference)const
  575. std::pair<const_iterator, const_iterator>
  576. equal_range(const_reference value) const;
  577. //! @copydoc ::boost::intrusive::rbtree::equal_range(const KeyType&,KeyValueCompare)const
  578. template<class KeyType, class KeyValueCompare>
  579. std::pair<const_iterator, const_iterator>
  580. equal_range(const KeyType& key, KeyValueCompare comp) const;
  581. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const_reference,const_reference,bool,bool)
  582. std::pair<iterator,iterator> bounded_range
  583. (const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed);
  584. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const KeyType&,const KeyType&,KeyValueCompare,bool,bool)
  585. template<class KeyType, class KeyValueCompare>
  586. std::pair<iterator,iterator> bounded_range
  587. (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed);
  588. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const_reference,const_reference,bool,bool)const
  589. std::pair<const_iterator, const_iterator>
  590. bounded_range(const_reference lower_value, const_reference upper_value, bool left_closed, bool right_closed) const;
  591. //! @copydoc ::boost::intrusive::rbtree::bounded_range(const KeyType&,const KeyType&,KeyValueCompare,bool,bool)const
  592. template<class KeyType, class KeyValueCompare>
  593. std::pair<const_iterator, const_iterator> bounded_range
  594. (const KeyType& lower_key, const KeyType& upper_key, KeyValueCompare comp, bool left_closed, bool right_closed) const;
  595. //! @copydoc ::boost::intrusive::rbtree::s_iterator_to(reference)
  596. static iterator s_iterator_to(reference value);
  597. //! @copydoc ::boost::intrusive::rbtree::s_iterator_to(const_reference)
  598. static const_iterator s_iterator_to(const_reference value);
  599. //! @copydoc ::boost::intrusive::rbtree::iterator_to(reference)
  600. iterator iterator_to(reference value);
  601. //! @copydoc ::boost::intrusive::rbtree::iterator_to(const_reference)const
  602. const_iterator iterator_to(const_reference value) const;
  603. //! @copydoc ::boost::intrusive::rbtree::init_node(reference)
  604. static void init_node(reference value);
  605. //! @copydoc ::boost::intrusive::rbtree::unlink_leftmost_without_rebalance
  606. pointer unlink_leftmost_without_rebalance();
  607. //! @copydoc ::boost::intrusive::rbtree::replace_node
  608. void replace_node(iterator replace_this, reference with_this);
  609. //! @copydoc ::boost::intrusive::rbtree::remove_node
  610. void remove_node(reference value);
  611. #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  612. };
  613. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  614. template<class T, class ...Options>
  615. bool operator!= (const multiset_impl<T, Options...> &x, const multiset_impl<T, Options...> &y);
  616. template<class T, class ...Options>
  617. bool operator>(const multiset_impl<T, Options...> &x, const multiset_impl<T, Options...> &y);
  618. template<class T, class ...Options>
  619. bool operator<=(const multiset_impl<T, Options...> &x, const multiset_impl<T, Options...> &y);
  620. template<class T, class ...Options>
  621. bool operator>=(const multiset_impl<T, Options...> &x, const multiset_impl<T, Options...> &y);
  622. template<class T, class ...Options>
  623. void swap(multiset_impl<T, Options...> &x, multiset_impl<T, Options...> &y);
  624. #endif //#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
  625. //! Helper metafunction to define a \c multiset that yields to the same type when the
  626. //! same options (either explicitly or implicitly) are used.
  627. #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) || defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  628. template<class T, class ...Options>
  629. #else
  630. template<class T, class O1 = void, class O2 = void
  631. , class O3 = void, class O4 = void>
  632. #endif
  633. struct make_multiset
  634. {
  635. /// @cond
  636. typedef typename pack_options
  637. < rbtree_defaults,
  638. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  639. O1, O2, O3, O4
  640. #else
  641. Options...
  642. #endif
  643. >::type packed_options;
  644. typedef typename detail::get_value_traits
  645. <T, typename packed_options::proto_value_traits>::type value_traits;
  646. typedef multiset_impl
  647. < value_traits
  648. , typename packed_options::compare
  649. , typename packed_options::size_type
  650. , packed_options::constant_time_size
  651. > implementation_defined;
  652. /// @endcond
  653. typedef implementation_defined type;
  654. };
  655. #ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED
  656. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  657. template<class T, class O1, class O2, class O3, class O4>
  658. #else
  659. template<class T, class ...Options>
  660. #endif
  661. class multiset
  662. : public make_multiset<T,
  663. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  664. O1, O2, O3, O4
  665. #else
  666. Options...
  667. #endif
  668. >::type
  669. {
  670. typedef typename make_multiset<T,
  671. #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
  672. O1, O2, O3, O4
  673. #else
  674. Options...
  675. #endif
  676. >::type Base;
  677. BOOST_MOVABLE_BUT_NOT_COPYABLE(multiset)
  678. public:
  679. typedef typename Base::value_compare value_compare;
  680. typedef typename Base::value_traits value_traits;
  681. typedef typename Base::iterator iterator;
  682. typedef typename Base::const_iterator const_iterator;
  683. //Assert if passed value traits are compatible with the type
  684. BOOST_STATIC_ASSERT((detail::is_same<typename value_traits::value_type, T>::value));
  685. multiset( const value_compare &cmp = value_compare()
  686. , const value_traits &v_traits = value_traits())
  687. : Base(cmp, v_traits)
  688. {}
  689. template<class Iterator>
  690. multiset( Iterator b, Iterator e
  691. , const value_compare &cmp = value_compare()
  692. , const value_traits &v_traits = value_traits())
  693. : Base(b, e, cmp, v_traits)
  694. {}
  695. multiset(BOOST_RV_REF(multiset) x)
  696. : Base(::boost::move(static_cast<Base&>(x)))
  697. {}
  698. multiset& operator=(BOOST_RV_REF(multiset) x)
  699. { return static_cast<multiset &>(this->Base::operator=(::boost::move(static_cast<Base&>(x)))); }
  700. static multiset &container_from_end_iterator(iterator end_iterator)
  701. { return static_cast<multiset &>(Base::container_from_end_iterator(end_iterator)); }
  702. static const multiset &container_from_end_iterator(const_iterator end_iterator)
  703. { return static_cast<const multiset &>(Base::container_from_end_iterator(end_iterator)); }
  704. static multiset &container_from_iterator(iterator it)
  705. { return static_cast<multiset &>(Base::container_from_iterator(it)); }
  706. static const multiset &container_from_iterator(const_iterator it)
  707. { return static_cast<const multiset &>(Base::container_from_iterator(it)); }
  708. };
  709. #endif
  710. } //namespace intrusive
  711. } //namespace boost
  712. #include <boost/intrusive/detail/config_end.hpp>
  713. #endif //BOOST_INTRUSIVE_SET_HPP