1/////////////////////////////////////////////////////////////////////////////
2//
3// (C) Copyright Ion Gaztanaga 2013-2014
4//
5// Distributed under the Boost Software License, Version 1.0.
6// (See accompanying file LICENSE_1_0.txt or copy at
7// http://www.boost.org/LICENSE_1_0.txt)
8//
9// See http://www.boost.org/libs/intrusive for documentation.
10//
11/////////////////////////////////////////////////////////////////////////////
12#ifndef BOOST_INTRUSIVE_BSTREE_HPP
13#define BOOST_INTRUSIVE_BSTREE_HPP
14
15#include <boost/intrusive/detail/config_begin.hpp>
16#include <boost/intrusive/intrusive_fwd.hpp>
17
18#include <boost/intrusive/detail/assert.hpp>
19#include <boost/static_assert.hpp>
20#include <boost/intrusive/intrusive_fwd.hpp>
21#include <boost/intrusive/bs_set_hook.hpp>
22#include <boost/intrusive/detail/tree_node.hpp>
23#include <boost/intrusive/detail/tree_iterator.hpp>
24#include <boost/intrusive/detail/ebo_functor_holder.hpp>
25#include <boost/intrusive/detail/mpl.hpp>
26#include <boost/intrusive/pointer_traits.hpp>
27#include <boost/intrusive/detail/is_stateful_value_traits.hpp>
28#include <boost/intrusive/detail/empty_node_checker.hpp>
29#include <boost/intrusive/detail/default_header_holder.hpp>
30#include <boost/intrusive/detail/reverse_iterator.hpp>
31#include <boost/intrusive/detail/exception_disposer.hpp>
32#include <boost/intrusive/detail/node_cloner_disposer.hpp>
33#include <boost/intrusive/detail/key_nodeptr_comp.hpp>
34#include <boost/intrusive/detail/simple_disposers.hpp>
35#include <boost/intrusive/detail/size_holder.hpp>
36#include <boost/intrusive/detail/algo_type.hpp>
37#include <boost/intrusive/detail/algorithm.hpp>
38#include <boost/intrusive/detail/tree_value_compare.hpp>
39
40#include <boost/intrusive/detail/get_value_traits.hpp>
41#include <boost/intrusive/bstree_algorithms.hpp>
42#include <boost/intrusive/link_mode.hpp>
43#include <boost/intrusive/parent_from_member.hpp>
44#include <boost/move/utility_core.hpp>
45#include <boost/move/adl_move_swap.hpp>
46
47#include <boost/intrusive/detail/minimal_pair_header.hpp>
48#include <cstddef> //size_t...
49#include <boost/intrusive/detail/minimal_less_equal_header.hpp>//less, equal_to
50
51#if defined(BOOST_HAS_PRAGMA_ONCE)
52# pragma once
53#endif
54
55namespace boost {
56namespace intrusive {
57
58/// @cond
59
60struct default_bstree_hook_applier
61{ template <class T> struct apply{ typedef typename T::default_bstree_hook type; }; };
62
63template<>
64struct is_default_hook_tag<default_bstree_hook_applier>
65{ static const bool value = true; };
66
67struct bstree_defaults
68{
69 typedef default_bstree_hook_applier proto_value_traits;
70 static const bool constant_time_size = true;
71 typedef std::size_t size_type;
72 typedef void compare;
73 typedef void key_of_value;
74 static const bool floating_point = true; //For sgtree
75 typedef void priority; //For treap
76 typedef void header_holder_type;
77};
78
79template<class ValueTraits, algo_types AlgoType, typename HeaderHolder>
80struct bstbase3
81{
82 typedef ValueTraits value_traits;
83 typedef typename value_traits::node_traits node_traits;
84 typedef typename node_traits::node node_type;
85 typedef typename get_algo<AlgoType, node_traits>::type node_algorithms;
86 typedef typename node_traits::node_ptr node_ptr;
87 typedef typename node_traits::const_node_ptr const_node_ptr;
88 typedef tree_iterator<value_traits, false> iterator;
89 typedef tree_iterator<value_traits, true> const_iterator;
90 typedef boost::intrusive::reverse_iterator<iterator> reverse_iterator;
91 typedef boost::intrusive::reverse_iterator<const_iterator> const_reverse_iterator;
92 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::pointer) pointer;
93 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::const_pointer) const_pointer;
94 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<pointer>::element_type) value_type;
95 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<pointer>::reference) reference;
96 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::reference) const_reference;
97 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::difference_type) difference_type;
98 typedef typename detail::get_header_holder_type
99 < value_traits,HeaderHolder >::type header_holder_type;
100
101 static const bool safemode_or_autounlink = is_safe_autounlink<value_traits::link_mode>::value;
102 static const bool stateful_value_traits = detail::is_stateful_value_traits<value_traits>::value;
103 static const bool has_container_from_iterator =
104 detail::is_same< header_holder_type, detail::default_header_holder< node_traits > >::value;
105
106 struct holder_t : public ValueTraits
107 {
108 explicit holder_t(const ValueTraits &vtraits)
109 : ValueTraits(vtraits)
110 {}
111 header_holder_type root;
112 } holder;
113
114 static bstbase3 &get_tree_base_from_end_iterator(const const_iterator &end_iterator)
115 {
116 BOOST_STATIC_ASSERT(has_container_from_iterator);
117 node_ptr p = end_iterator.pointed_node();
118 header_holder_type* h = header_holder_type::get_holder(p);
119 holder_t *holder = get_parent_from_member<holder_t, header_holder_type>(h, &holder_t::root);
120 bstbase3 *base = get_parent_from_member<bstbase3, holder_t> (holder, &bstbase3::holder);
121 return *base;
122 }
123
124 bstbase3(const ValueTraits &vtraits)
125 : holder(vtraits)
126 {
127 node_algorithms::init_header(this->header_ptr());
128 }
129
130 node_ptr header_ptr()
131 { return holder.root.get_node(); }
132
133 const_node_ptr header_ptr() const
134 { return holder.root.get_node(); }
135
136 const value_traits &get_value_traits() const
137 { return this->holder; }
138
139 value_traits &get_value_traits()
140 { return this->holder; }
141
142 typedef typename boost::intrusive::value_traits_pointers
143 <ValueTraits>::const_value_traits_ptr const_value_traits_ptr;
144
145 const_value_traits_ptr priv_value_traits_ptr() const
146 { return pointer_traits<const_value_traits_ptr>::pointer_to(this->get_value_traits()); }
147
148 iterator begin()
149 { return iterator(node_algorithms::begin_node(this->header_ptr()), this->priv_value_traits_ptr()); }
150
151 const_iterator begin() const
152 { return cbegin(); }
153
154 const_iterator cbegin() const
155 { return const_iterator(node_algorithms::begin_node(this->header_ptr()), this->priv_value_traits_ptr()); }
156
157 iterator end()
158 { return iterator(node_algorithms::end_node(this->header_ptr()), this->priv_value_traits_ptr()); }
159
160 const_iterator end() const
161 { return cend(); }
162
163 const_iterator cend() const
164 { return const_iterator(node_algorithms::end_node(this->header_ptr()), this->priv_value_traits_ptr()); }
165
166 iterator root()
167 { return iterator(node_algorithms::root_node(this->header_ptr()), this->priv_value_traits_ptr()); }
168
169 const_iterator root() const
170 { return croot(); }
171
172 const_iterator croot() const
173 { return const_iterator(node_algorithms::root_node(this->header_ptr()), this->priv_value_traits_ptr()); }
174
175 reverse_iterator rbegin()
176 { return reverse_iterator(end()); }
177
178 const_reverse_iterator rbegin() const
179 { return const_reverse_iterator(end()); }
180
181 const_reverse_iterator crbegin() const
182 { return const_reverse_iterator(end()); }
183
184 reverse_iterator rend()
185 { return reverse_iterator(begin()); }
186
187 const_reverse_iterator rend() const
188 { return const_reverse_iterator(begin()); }
189
190 const_reverse_iterator crend() const
191 { return const_reverse_iterator(begin()); }
192
193 void replace_node(iterator replace_this, reference with_this)
194 {
195 node_algorithms::replace_node( get_value_traits().to_node_ptr(*replace_this)
196 , this->header_ptr()
197 , get_value_traits().to_node_ptr(with_this));
198 if(safemode_or_autounlink)
199 node_algorithms::init(replace_this.pointed_node());
200 }
201
202 void rebalance()
203 { node_algorithms::rebalance(this->header_ptr()); }
204
205 iterator rebalance_subtree(iterator root)
206 { return iterator(node_algorithms::rebalance_subtree(root.pointed_node()), this->priv_value_traits_ptr()); }
207
208 static iterator s_iterator_to(reference value)
209 {
210 BOOST_STATIC_ASSERT((!stateful_value_traits));
211 return iterator (value_traits::to_node_ptr(value), const_value_traits_ptr());
212 }
213
214 static const_iterator s_iterator_to(const_reference value)
215 {
216 BOOST_STATIC_ASSERT((!stateful_value_traits));
217 return const_iterator (value_traits::to_node_ptr(*pointer_traits<pointer>::const_cast_from(pointer_traits<const_pointer>::pointer_to(value))), const_value_traits_ptr());
218 }
219
220 iterator iterator_to(reference value)
221 { return iterator (this->get_value_traits().to_node_ptr(value), this->priv_value_traits_ptr()); }
222
223 const_iterator iterator_to(const_reference value) const
224 { return const_iterator (this->get_value_traits().to_node_ptr(*pointer_traits<pointer>::const_cast_from(pointer_traits<const_pointer>::pointer_to(value))), this->priv_value_traits_ptr()); }
225
226 static void init_node(reference value)
227 { node_algorithms::init(value_traits::to_node_ptr(value)); }
228
229};
230
231template<class Less, class T>
232struct get_compare
233{
234 typedef Less type;
235};
236
237template<class T>
238struct get_compare<void, T>
239{
240 typedef ::std::less<T> type;
241};
242
243template<class KeyOfValue, class T>
244struct get_key_of_value
245{
246 typedef KeyOfValue type;
247};
248
249template<class T>
250struct get_key_of_value<void, T>
251{
252 typedef ::boost::intrusive::detail::identity<T> type;
253};
254
255template<class T, class VoidOrKeyOfValue, class VoidOrKeyComp>
256struct bst_key_types
257{
258 typedef typename get_key_of_value
259 < VoidOrKeyOfValue, T>::type key_of_value;
260 typedef typename key_of_value::type key_type;
261 typedef typename get_compare< VoidOrKeyComp
262 , key_type
263 >::type key_compare;
264 typedef tree_value_compare
265 <key_type, T, key_compare, key_of_value> value_compare;
266};
267
268template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, algo_types AlgoType, typename HeaderHolder>
269struct bstbase2
270 //Put the (possibly empty) functor in the first position to get EBO in MSVC
271 //Use public inheritance to avoid MSVC bugs with closures
272 : public detail::ebo_functor_holder
273 < typename bst_key_types
274 < typename ValueTraits::value_type
275 , VoidOrKeyOfValue
276 , VoidOrKeyComp
277 >::value_compare
278 >
279 , public bstbase3<ValueTraits, AlgoType, HeaderHolder>
280{
281 typedef bstbase3<ValueTraits, AlgoType, HeaderHolder> treeheader_t;
282 typedef bst_key_types< typename ValueTraits::value_type
283 , VoidOrKeyOfValue
284 , VoidOrKeyComp> key_types;
285 typedef typename treeheader_t::value_traits value_traits;
286 typedef typename treeheader_t::node_algorithms node_algorithms;
287 typedef typename ValueTraits::value_type value_type;
288 typedef typename key_types::key_type key_type;
289 typedef typename key_types::key_of_value key_of_value;
290 typedef typename key_types::key_compare key_compare;
291 typedef typename key_types::value_compare value_compare;
292 typedef typename treeheader_t::iterator iterator;
293 typedef typename treeheader_t::const_iterator const_iterator;
294 typedef typename treeheader_t::node_ptr node_ptr;
295 typedef typename treeheader_t::const_node_ptr const_node_ptr;
296
297 bstbase2(const key_compare &comp, const ValueTraits &vtraits)
298 : detail::ebo_functor_holder<value_compare>(value_compare(comp)), treeheader_t(vtraits)
299 {}
300
301 const value_compare &comp() const
302 { return this->get(); }
303
304 value_compare &comp()
305 { return this->get(); }
306
307 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::pointer) pointer;
308 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::const_pointer) const_pointer;
309 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<pointer>::reference) reference;
310 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::reference) const_reference;
311 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::difference_type) difference_type;
312 typedef typename node_algorithms::insert_commit_data insert_commit_data;
313
314 value_compare value_comp() const
315 { return this->comp(); }
316
317 key_compare key_comp() const
318 { return this->comp().key_comp(); }
319
320 //lower_bound
321 iterator lower_bound(const key_type &key)
322 { return this->lower_bound(key, this->key_comp()); }
323
324 const_iterator lower_bound(const key_type &key) const
325 { return this->lower_bound(key, this->key_comp()); }
326
327 template<class KeyType, class KeyTypeKeyCompare>
328 iterator lower_bound(const KeyType &key, KeyTypeKeyCompare comp)
329 {
330 return iterator(node_algorithms::lower_bound
331 (this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
332 }
333
334 template<class KeyType, class KeyTypeKeyCompare>
335 const_iterator lower_bound(const KeyType &key, KeyTypeKeyCompare comp) const
336 {
337 return const_iterator(node_algorithms::lower_bound
338 (this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
339 }
340
341 //upper_bound
342 iterator upper_bound(const key_type &key)
343 { return this->upper_bound(key, this->key_comp()); }
344
345 template<class KeyType, class KeyTypeKeyCompare>
346 iterator upper_bound(const KeyType &key, KeyTypeKeyCompare comp)
347 {
348 return iterator(node_algorithms::upper_bound
349 (this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
350 }
351
352 const_iterator upper_bound(const key_type &key) const
353 { return this->upper_bound(key, this->key_comp()); }
354
355 template<class KeyType, class KeyTypeKeyCompare>
356 const_iterator upper_bound(const KeyType &key, KeyTypeKeyCompare comp) const
357 {
358 return const_iterator(node_algorithms::upper_bound
359 (this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
360 }
361
362 template<class KeyTypeKeyCompare>
363 struct key_node_comp_ret
364 { typedef detail::key_nodeptr_comp<KeyTypeKeyCompare, value_traits, key_of_value> type; };
365
366 template<class KeyTypeKeyCompare>
367 typename key_node_comp_ret<KeyTypeKeyCompare>::type key_node_comp(KeyTypeKeyCompare comp) const
368 {
369 return detail::key_nodeptr_comp<KeyTypeKeyCompare, value_traits, key_of_value>(comp, &this->get_value_traits());
370 }
371
372 //find
373 iterator find(const key_type &key)
374 { return this->find(key, this->key_comp()); }
375
376 template<class KeyType, class KeyTypeKeyCompare>
377 iterator find(const KeyType &key, KeyTypeKeyCompare comp)
378 {
379 return iterator
380 (node_algorithms::find(this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
381 }
382
383 const_iterator find(const key_type &key) const
384 { return this->find(key, this->key_comp()); }
385
386 template<class KeyType, class KeyTypeKeyCompare>
387 const_iterator find(const KeyType &key, KeyTypeKeyCompare comp) const
388 {
389 return const_iterator
390 (node_algorithms::find(this->header_ptr(), key, this->key_node_comp(comp)), this->priv_value_traits_ptr());
391 }
392
393 //equal_range
394 std::pair<iterator,iterator> equal_range(const key_type &key)
395 { return this->equal_range(key, this->key_comp()); }
396
397 template<class KeyType, class KeyTypeKeyCompare>
398 std::pair<iterator,iterator> equal_range(const KeyType &key, KeyTypeKeyCompare comp)
399 {
400 std::pair<node_ptr, node_ptr> ret
401 (node_algorithms::equal_range(this->header_ptr(), key, this->key_node_comp(comp)));
402 return std::pair<iterator, iterator>( iterator(ret.first, this->priv_value_traits_ptr())
403 , iterator(ret.second, this->priv_value_traits_ptr()));
404 }
405
406 std::pair<const_iterator, const_iterator>
407 equal_range(const key_type &key) const
408 { return this->equal_range(key, this->key_comp()); }
409
410 template<class KeyType, class KeyTypeKeyCompare>
411 std::pair<const_iterator, const_iterator>
412 equal_range(const KeyType &key, KeyTypeKeyCompare comp) const
413 {
414 std::pair<node_ptr, node_ptr> ret
415 (node_algorithms::equal_range(this->header_ptr(), key, this->key_node_comp(comp)));
416 return std::pair<const_iterator, const_iterator>( const_iterator(ret.first, this->priv_value_traits_ptr())
417 , const_iterator(ret.second, this->priv_value_traits_ptr()));
418 }
419
420 //lower_bound_range
421 std::pair<iterator,iterator> lower_bound_range(const key_type &key)
422 { return this->lower_bound_range(key, this->key_comp()); }
423
424 template<class KeyType, class KeyTypeKeyCompare>
425 std::pair<iterator,iterator> lower_bound_range(const KeyType &key, KeyTypeKeyCompare comp)
426 {
427 std::pair<node_ptr, node_ptr> ret
428 (node_algorithms::lower_bound_range(this->header_ptr(), key, this->key_node_comp(comp)));
429 return std::pair<iterator, iterator>( iterator(ret.first, this->priv_value_traits_ptr())
430 , iterator(ret.second, this->priv_value_traits_ptr()));
431 }
432
433 std::pair<const_iterator, const_iterator>
434 lower_bound_range(const key_type &key) const
435 { return this->lower_bound_range(key, this->key_comp()); }
436
437 template<class KeyType, class KeyTypeKeyCompare>
438 std::pair<const_iterator, const_iterator>
439 lower_bound_range(const KeyType &key, KeyTypeKeyCompare comp) const
440 {
441 std::pair<node_ptr, node_ptr> ret
442 (node_algorithms::lower_bound_range(this->header_ptr(), key, this->key_node_comp(comp)));
443 return std::pair<const_iterator, const_iterator>( const_iterator(ret.first, this->priv_value_traits_ptr())
444 , const_iterator(ret.second, this->priv_value_traits_ptr()));
445 }
446
447 //bounded_range
448 std::pair<iterator,iterator> bounded_range
449 (const key_type &lower_key, const key_type &upper_key, bool left_closed, bool right_closed)
450 { return this->bounded_range(lower_key, upper_key, this->key_comp(), left_closed, right_closed); }
451
452 template<class KeyType, class KeyTypeKeyCompare>
453 std::pair<iterator,iterator> bounded_range
454 (const KeyType &lower_key, const KeyType &upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed)
455 {
456 std::pair<node_ptr, node_ptr> ret
457 (node_algorithms::bounded_range
458 (this->header_ptr(), lower_key, upper_key, this->key_node_comp(comp), left_closed, right_closed));
459 return std::pair<iterator, iterator>( iterator(ret.first, this->priv_value_traits_ptr())
460 , iterator(ret.second, this->priv_value_traits_ptr()));
461 }
462
463 std::pair<const_iterator,const_iterator> bounded_range
464 (const key_type &lower_key, const key_type &upper_key, bool left_closed, bool right_closed) const
465 { return this->bounded_range(lower_key, upper_key, this->key_comp(), left_closed, right_closed); }
466
467 template<class KeyType, class KeyTypeKeyCompare>
468 std::pair<const_iterator,const_iterator> bounded_range
469 (const KeyType &lower_key, const KeyType &upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed) const
470 {
471 std::pair<node_ptr, node_ptr> ret
472 (node_algorithms::bounded_range
473 (this->header_ptr(), lower_key, upper_key, this->key_node_comp(comp), left_closed, right_closed));
474 return std::pair<const_iterator, const_iterator>( const_iterator(ret.first, this->priv_value_traits_ptr())
475 , const_iterator(ret.second, this->priv_value_traits_ptr()));
476 }
477
478 //insert_unique_check
479 template<class KeyType, class KeyTypeKeyCompare>
480 std::pair<iterator, bool> insert_unique_check
481 (const KeyType &key, KeyTypeKeyCompare comp, insert_commit_data &commit_data)
482 {
483 std::pair<node_ptr, bool> ret =
484 (node_algorithms::insert_unique_check
485 (this->header_ptr(), key, this->key_node_comp(comp), commit_data));
486 return std::pair<iterator, bool>(iterator(ret.first, this->priv_value_traits_ptr()), ret.second);
487 }
488
489 template<class KeyType, class KeyTypeKeyCompare>
490 std::pair<iterator, bool> insert_unique_check
491 (const_iterator hint, const KeyType &key
492 ,KeyTypeKeyCompare comp, insert_commit_data &commit_data)
493 {
494 std::pair<node_ptr, bool> ret =
495 (node_algorithms::insert_unique_check
496 (this->header_ptr(), hint.pointed_node(), key, this->key_node_comp(comp), commit_data));
497 return std::pair<iterator, bool>(iterator(ret.first, this->priv_value_traits_ptr()), ret.second);
498 }
499};
500
501//Due to MSVC's EBO implementation, to save space and maintain the ABI, we must put the non-empty size member
502//in the first position, but if size is not going to be stored then we'll use an specialization
503//that doesn't inherit from size_holder
504template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, bool ConstantTimeSize, class SizeType, algo_types AlgoType, typename HeaderHolder>
505struct bstbase_hack
506 : public detail::size_holder<ConstantTimeSize, SizeType>
507 , public bstbase2 < ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, AlgoType, HeaderHolder>
508{
509 typedef bstbase2< ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, AlgoType, HeaderHolder> base_type;
510 typedef typename base_type::key_compare key_compare;
511 typedef typename base_type::value_compare value_compare;
512 typedef SizeType size_type;
513 typedef typename base_type::node_traits node_traits;
514 typedef typename get_algo
515 <AlgoType, node_traits>::type algo_type;
516
517 bstbase_hack(const key_compare & comp, const ValueTraits &vtraits)
518 : base_type(comp, vtraits)
519 {
520 this->sz_traits().set_size(size_type(0));
521 }
522
523 typedef detail::size_holder<ConstantTimeSize, SizeType> size_traits;
524
525 size_traits &sz_traits()
526 { return static_cast<size_traits &>(*this); }
527
528 const size_traits &sz_traits() const
529 { return static_cast<const size_traits &>(*this); }
530};
531
532//Specialization for ConstantTimeSize == false
533template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, class SizeType, algo_types AlgoType, typename HeaderHolder>
534struct bstbase_hack<ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, false, SizeType, AlgoType, HeaderHolder>
535 : public bstbase2 < ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, AlgoType, HeaderHolder>
536{
537 typedef bstbase2< ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, AlgoType, HeaderHolder> base_type;
538 typedef typename base_type::value_compare value_compare;
539 typedef typename base_type::key_compare key_compare;
540 bstbase_hack(const key_compare & comp, const ValueTraits &vtraits)
541 : base_type(comp, vtraits)
542 {}
543
544 typedef detail::size_holder<false, SizeType> size_traits;
545
546 size_traits &sz_traits()
547 { return s_size_traits; }
548
549 const size_traits &sz_traits() const
550 { return s_size_traits; }
551
552 static size_traits s_size_traits;
553};
554
555template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, class SizeType, algo_types AlgoType, typename HeaderHolder>
556detail::size_holder<false, SizeType> bstbase_hack<ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, false, SizeType, AlgoType, HeaderHolder>::s_size_traits;
557
558//This class will
559template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, bool ConstantTimeSize, class SizeType, algo_types AlgoType, typename HeaderHolder>
560struct bstbase
561 : public bstbase_hack< ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, ConstantTimeSize, SizeType, AlgoType, HeaderHolder>
562{
563 typedef bstbase_hack< ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, ConstantTimeSize, SizeType, AlgoType, HeaderHolder> base_type;
564 typedef ValueTraits value_traits;
565 typedef typename base_type::value_compare value_compare;
566 typedef typename base_type::key_compare key_compare;
567 typedef typename base_type::const_reference const_reference;
568 typedef typename base_type::reference reference;
569 typedef typename base_type::iterator iterator;
570 typedef typename base_type::const_iterator const_iterator;
571 typedef typename base_type::node_traits node_traits;
572 typedef typename get_algo
573 <AlgoType, node_traits>::type node_algorithms;
574 typedef SizeType size_type;
575
576 bstbase(const key_compare & comp, const ValueTraits &vtraits)
577 : base_type(comp, vtraits)
578 {}
579
580 //Detach all inserted nodes. This will add exception safety to bstree_impl
581 //constructors inserting elements.
582 ~bstbase()
583 {
584 if(is_safe_autounlink<value_traits::link_mode>::value){
585 node_algorithms::clear_and_dispose
586 ( this->header_ptr()
587 , detail::node_disposer<detail::null_disposer, value_traits, AlgoType>
588 (detail::null_disposer(), &this->get_value_traits()));
589 node_algorithms::init(this->header_ptr());
590 }
591 }
592};
593
594
595/// @endcond
596
597//! The class template bstree is an unbalanced intrusive binary search tree
598//! container. The no-throw guarantee holds only, if the key_compare object
599//! doesn't throw.
600//!
601//! The complexity guarantees only hold if the tree is balanced, logarithmic
602//! complexity would increase to linear if the tree is totally unbalanced.
603//!
604//! The template parameter \c T is the type to be managed by the container.
605//! The user can specify additional options and if no options are provided
606//! default options are used.
607//!
608//! The container supports the following options:
609//! \c base_hook<>/member_hook<>/value_traits<>,
610//! \c constant_time_size<>, \c size_type<> and
611//! \c compare<>.
612#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
613template<class T, class ...Options>
614#else
615template<class ValueTraits, class VoidOrKeyOfValue, class VoidOrKeyComp, class SizeType, bool ConstantTimeSize, algo_types AlgoType, typename HeaderHolder>
616#endif
617class bstree_impl
618 : public bstbase<ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, ConstantTimeSize, SizeType, AlgoType, HeaderHolder>
619{
620 public:
621 /// @cond
622 typedef bstbase<ValueTraits, VoidOrKeyOfValue, VoidOrKeyComp, ConstantTimeSize, SizeType, AlgoType, HeaderHolder> data_type;
623 typedef tree_iterator<ValueTraits, false> iterator_type;
624 typedef tree_iterator<ValueTraits, true> const_iterator_type;
625 /// @endcond
626
627 typedef BOOST_INTRUSIVE_IMPDEF(ValueTraits) value_traits;
628 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::pointer) pointer;
629 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::const_pointer) const_pointer;
630 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<pointer>::element_type) value_type;
631 typedef BOOST_INTRUSIVE_IMPDEF(typename data_type::key_type) key_type;
632 typedef BOOST_INTRUSIVE_IMPDEF(typename data_type::key_of_value) key_of_value;
633 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<pointer>::reference) reference;
634 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::reference) const_reference;
635 typedef BOOST_INTRUSIVE_IMPDEF(typename pointer_traits<const_pointer>::difference_type) difference_type;
636 typedef BOOST_INTRUSIVE_IMPDEF(SizeType) size_type;
637 typedef BOOST_INTRUSIVE_IMPDEF(typename data_type::value_compare) value_compare;
638 typedef BOOST_INTRUSIVE_IMPDEF(typename data_type::key_compare) key_compare;
639 typedef BOOST_INTRUSIVE_IMPDEF(iterator_type) iterator;
640 typedef BOOST_INTRUSIVE_IMPDEF(const_iterator_type) const_iterator;
641 typedef BOOST_INTRUSIVE_IMPDEF(boost::intrusive::reverse_iterator<iterator>) reverse_iterator;
642 typedef BOOST_INTRUSIVE_IMPDEF(boost::intrusive::reverse_iterator<const_iterator>) const_reverse_iterator;
643 typedef BOOST_INTRUSIVE_IMPDEF(typename value_traits::node_traits) node_traits;
644 typedef BOOST_INTRUSIVE_IMPDEF(typename node_traits::node) node;
645 typedef BOOST_INTRUSIVE_IMPDEF(typename node_traits::node_ptr) node_ptr;
646 typedef BOOST_INTRUSIVE_IMPDEF(typename node_traits::const_node_ptr) const_node_ptr;
647 /// @cond
648 typedef typename get_algo<AlgoType, node_traits>::type algo_type;
649 /// @endcond
650 typedef BOOST_INTRUSIVE_IMPDEF(algo_type) node_algorithms;
651
652 static const bool constant_time_size = ConstantTimeSize;
653 static const bool stateful_value_traits = detail::is_stateful_value_traits<value_traits>::value;
654 /// @cond
655 private:
656
657 //noncopyable
658 BOOST_MOVABLE_BUT_NOT_COPYABLE(bstree_impl)
659
660 static const bool safemode_or_autounlink = is_safe_autounlink<value_traits::link_mode>::value;
661
662 //Constant-time size is incompatible with auto-unlink hooks!
663 BOOST_STATIC_ASSERT(!(constant_time_size && ((int)value_traits::link_mode == (int)auto_unlink)));
664
665
666 protected:
667
668
669 /// @endcond
670
671 public:
672
673 typedef typename node_algorithms::insert_commit_data insert_commit_data;
674
675 //! <b>Effects</b>: Constructs an empty container.
676 //!
677 //! <b>Complexity</b>: Constant.
678 //!
679 //! <b>Throws</b>: If value_traits::node_traits::node
680 //! constructor throws (this does not happen with predefined Boost.Intrusive hooks)
681 //! or the copy constructor of the key_compare object throws. Basic guarantee.
682 explicit bstree_impl( const key_compare &cmp = key_compare()
683 , const value_traits &v_traits = value_traits())
684 : data_type(cmp, v_traits)
685 {}
686
687 //! <b>Requires</b>: Dereferencing iterator must yield an lvalue of type value_type.
688 //! cmp must be a comparison function that induces a strict weak ordering.
689 //!
690 //! <b>Effects</b>: Constructs an empty container and inserts elements from
691 //! [b, e).
692 //!
693 //! <b>Complexity</b>: Linear in N if [b, e) is already sorted using
694 //! comp and otherwise N * log N, where N is the distance between first and last.
695 //!
696 //! <b>Throws</b>: If value_traits::node_traits::node
697 //! constructor throws (this does not happen with predefined Boost.Intrusive hooks)
698 //! or the copy constructor/operator() of the key_compare object throws. Basic guarantee.
699 template<class Iterator>
700 bstree_impl( bool unique, Iterator b, Iterator e
701 , const key_compare &cmp = key_compare()
702 , const value_traits &v_traits = value_traits())
703 : data_type(cmp, v_traits)
704 {
705 //bstbase releases elements in case of exceptions
706 if(unique)
707 this->insert_unique(b, e);
708 else
709 this->insert_equal(b, e);
710 }
711
712 //! <b>Effects</b>: to-do
713 //!
714 bstree_impl(BOOST_RV_REF(bstree_impl) x)
715 : data_type(::boost::move(x.comp()), ::boost::move(x.get_value_traits()))
716 {
717 this->swap(x);
718 }
719
720 //! <b>Effects</b>: to-do
721 //!
722 bstree_impl& operator=(BOOST_RV_REF(bstree_impl) x)
723 { this->swap(x); return *this; }
724
725 #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
726 //! <b>Effects</b>: Detaches all elements from this. The objects in the set
727 //! are not deleted (i.e. no destructors are called), but the nodes according to
728 //! the value_traits template parameter are reinitialized and thus can be reused.
729 //!
730 //! <b>Complexity</b>: Linear to elements contained in *this.
731 //!
732 //! <b>Throws</b>: Nothing.
733 ~bstree_impl()
734 {}
735
736 //! <b>Effects</b>: Returns an iterator pointing to the beginning of the container.
737 //!
738 //! <b>Complexity</b>: Constant.
739 //!
740 //! <b>Throws</b>: Nothing.
741 iterator begin();
742
743 //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the container.
744 //!
745 //! <b>Complexity</b>: Constant.
746 //!
747 //! <b>Throws</b>: Nothing.
748 const_iterator begin() const;
749
750 //! <b>Effects</b>: Returns a const_iterator pointing to the beginning of the container.
751 //!
752 //! <b>Complexity</b>: Constant.
753 //!
754 //! <b>Throws</b>: Nothing.
755 const_iterator cbegin() const;
756
757 //! <b>Effects</b>: Returns an iterator pointing to the end of the container.
758 //!
759 //! <b>Complexity</b>: Constant.
760 //!
761 //! <b>Throws</b>: Nothing.
762 iterator end();
763
764 //! <b>Effects</b>: Returns a const_iterator pointing to the end of the container.
765 //!
766 //! <b>Complexity</b>: Constant.
767 //!
768 //! <b>Throws</b>: Nothing.
769 const_iterator end() const;
770
771 //! <b>Effects</b>: Returns a const_iterator pointing to the end of the container.
772 //!
773 //! <b>Complexity</b>: Constant.
774 //!
775 //! <b>Throws</b>: Nothing.
776 const_iterator cend() const;
777
778 //! <b>Effects</b>: Returns a reverse_iterator pointing to the beginning of the
779 //! reversed container.
780 //!
781 //! <b>Complexity</b>: Constant.
782 //!
783 //! <b>Throws</b>: Nothing.
784 reverse_iterator rbegin();
785
786 //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning
787 //! of the reversed container.
788 //!
789 //! <b>Complexity</b>: Constant.
790 //!
791 //! <b>Throws</b>: Nothing.
792 const_reverse_iterator rbegin() const;
793
794 //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the beginning
795 //! of the reversed container.
796 //!
797 //! <b>Complexity</b>: Constant.
798 //!
799 //! <b>Throws</b>: Nothing.
800 const_reverse_iterator crbegin() const;
801
802 //! <b>Effects</b>: Returns a reverse_iterator pointing to the end
803 //! of the reversed container.
804 //!
805 //! <b>Complexity</b>: Constant.
806 //!
807 //! <b>Throws</b>: Nothing.
808 reverse_iterator rend();
809
810 //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end
811 //! of the reversed container.
812 //!
813 //! <b>Complexity</b>: Constant.
814 //!
815 //! <b>Throws</b>: Nothing.
816 const_reverse_iterator rend() const;
817
818 //! <b>Effects</b>: Returns a const_reverse_iterator pointing to the end
819 //! of the reversed container.
820 //!
821 //! <b>Complexity</b>: Constant.
822 //!
823 //! <b>Throws</b>: Nothing.
824 const_reverse_iterator crend() const;
825
826 #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
827
828 //! <b>Precondition</b>: end_iterator must be a valid end iterator
829 //! of the container.
830 //!
831 //! <b>Effects</b>: Returns a const reference to the container associated to the end iterator
832 //!
833 //! <b>Throws</b>: Nothing.
834 //!
835 //! <b>Complexity</b>: Constant.
836 static bstree_impl &container_from_end_iterator(iterator end_iterator)
837 {
838 return static_cast<bstree_impl&>
839 (data_type::get_tree_base_from_end_iterator(end_iterator));
840 }
841
842 //! <b>Precondition</b>: end_iterator must be a valid end const_iterator
843 //! of the container.
844 //!
845 //! <b>Effects</b>: Returns a const reference to the container associated to the iterator
846 //!
847 //! <b>Throws</b>: Nothing.
848 //!
849 //! <b>Complexity</b>: Constant.
850 static const bstree_impl &container_from_end_iterator(const_iterator end_iterator)
851 {
852 return static_cast<bstree_impl&>
853 (data_type::get_tree_base_from_end_iterator(end_iterator));
854 }
855
856 //! <b>Precondition</b>: it must be a valid iterator
857 //! of the container.
858 //!
859 //! <b>Effects</b>: Returns a const reference to the container associated to the iterator
860 //!
861 //! <b>Throws</b>: Nothing.
862 //!
863 //! <b>Complexity</b>: Logarithmic.
864 static bstree_impl &container_from_iterator(iterator it)
865 { return container_from_end_iterator(it.end_iterator_from_it()); }
866
867 //! <b>Precondition</b>: it must be a valid end const_iterator
868 //! of container.
869 //!
870 //! <b>Effects</b>: Returns a const reference to the container associated to the end iterator
871 //!
872 //! <b>Throws</b>: Nothing.
873 //!
874 //! <b>Complexity</b>: Logarithmic.
875 static const bstree_impl &container_from_iterator(const_iterator it)
876 { return container_from_end_iterator(it.end_iterator_from_it()); }
877
878 #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
879
880 //! <b>Effects</b>: Returns the key_compare object used by the container.
881 //!
882 //! <b>Complexity</b>: Constant.
883 //!
884 //! <b>Throws</b>: If key_compare copy-constructor throws.
885 key_compare key_comp() const;
886
887 //! <b>Effects</b>: Returns the value_compare object used by the container.
888 //!
889 //! <b>Complexity</b>: Constant.
890 //!
891 //! <b>Throws</b>: If value_compare copy-constructor throws.
892 value_compare value_comp() const;
893
894 #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
895
896 //! <b>Effects</b>: Returns true if the container is empty.
897 //!
898 //! <b>Complexity</b>: Constant.
899 //!
900 //! <b>Throws</b>: Nothing.
901 bool empty() const
902 {
903 if(ConstantTimeSize){
904 return !this->data_type::sz_traits().get_size();
905 }
906 else{
907 return algo_type::unique(this->header_ptr());
908 }
909 }
910
911 //! <b>Effects</b>: Returns the number of elements stored in the container.
912 //!
913 //! <b>Complexity</b>: Linear to elements contained in *this
914 //! if constant-time size option is disabled. Constant time otherwise.
915 //!
916 //! <b>Throws</b>: Nothing.
917 size_type size() const
918 {
919 if(constant_time_size)
920 return this->sz_traits().get_size();
921 else{
922 return (size_type)node_algorithms::size(this->header_ptr());
923 }
924 }
925
926 //! <b>Effects</b>: Swaps the contents of two containers.
927 //!
928 //! <b>Complexity</b>: Constant.
929 //!
930 //! <b>Throws</b>: If the comparison functor's swap call throws.
931 void swap(bstree_impl& other)
932 {
933 //This can throw
934 ::boost::adl_move_swap(this->comp(), this->comp());
935 //These can't throw
936 node_algorithms::swap_tree(this->header_ptr(), node_ptr(other.header_ptr()));
937 if(constant_time_size){
938 size_type backup = this->sz_traits().get_size();
939 this->sz_traits().set_size(other.sz_traits().get_size());
940 other.sz_traits().set_size(backup);
941 }
942 }
943
944 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
945 //! Cloner should yield to nodes equivalent to the original nodes.
946 //!
947 //! <b>Effects</b>: Erases all the elements from *this
948 //! calling Disposer::operator()(pointer), clones all the
949 //! elements from src calling Cloner::operator()(const_reference )
950 //! and inserts them on *this. Copies the predicate from the source container.
951 //!
952 //! If cloner throws, all cloned elements are unlinked and disposed
953 //! calling Disposer::operator()(pointer).
954 //!
955 //! <b>Complexity</b>: Linear to erased plus inserted elements.
956 //!
957 //! <b>Throws</b>: If cloner throws or predicate copy assignment throws. Basic guarantee.
958 template <class Cloner, class Disposer>
959 void clone_from(const bstree_impl &src, Cloner cloner, Disposer disposer)
960 {
961 this->clear_and_dispose(disposer);
962 if(!src.empty()){
963 detail::exception_disposer<bstree_impl, Disposer>
964 rollback(*this, disposer);
965 node_algorithms::clone
966 (src.header_ptr()
967 ,this->header_ptr()
968 ,detail::node_cloner <Cloner, value_traits, AlgoType>(cloner, &this->get_value_traits())
969 ,detail::node_disposer<Disposer, value_traits, AlgoType>(disposer, &this->get_value_traits()));
970 this->sz_traits().set_size(src.sz_traits().get_size());
971 this->comp() = src.comp();
972 rollback.release();
973 }
974 }
975
976 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
977 //! Cloner should yield to nodes equivalent to the original nodes.
978 //!
979 //! <b>Effects</b>: Erases all the elements from *this
980 //! calling Disposer::operator()(pointer), clones all the
981 //! elements from src calling Cloner::operator()(reference)
982 //! and inserts them on *this. Copies the predicate from the source container.
983 //!
984 //! If cloner throws, all cloned elements are unlinked and disposed
985 //! calling Disposer::operator()(pointer).
986 //!
987 //! <b>Complexity</b>: Linear to erased plus inserted elements.
988 //!
989 //! <b>Throws</b>: If cloner throws or predicate copy assignment throws. Basic guarantee.
990 //!
991 //! <b>Note</b>: This version can modify the source container, useful to implement
992 //! move semantics.
993 template <class Cloner, class Disposer>
994 void clone_from(BOOST_RV_REF(bstree_impl) src, Cloner cloner, Disposer disposer)
995 {
996 this->clear_and_dispose(disposer);
997 if(!src.empty()){
998 detail::exception_disposer<bstree_impl, Disposer>
999 rollback(*this, disposer);
1000 node_algorithms::clone
1001 (src.header_ptr()
1002 ,this->header_ptr()
1003 ,detail::node_cloner <Cloner, value_traits, AlgoType, false>(cloner, &this->get_value_traits())
1004 ,detail::node_disposer<Disposer, value_traits, AlgoType>(disposer, &this->get_value_traits()));
1005 this->sz_traits().set_size(src.sz_traits().get_size());
1006 this->comp() = src.comp();
1007 rollback.release();
1008 }
1009 }
1010
1011 //! <b>Requires</b>: value must be an lvalue
1012 //!
1013 //! <b>Effects</b>: Inserts value into the container before the upper bound.
1014 //!
1015 //! <b>Complexity</b>: Average complexity for insert element is at
1016 //! most logarithmic.
1017 //!
1018 //! <b>Throws</b>: If the internal key_compare ordering function throws. Strong guarantee.
1019 //!
1020 //! <b>Note</b>: Does not affect the validity of iterators and references.
1021 //! No copy-constructors are called.
1022 iterator insert_equal(reference value)
1023 {
1024 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1025 if(safemode_or_autounlink)
1026 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1027 iterator ret(node_algorithms::insert_equal_upper_bound
1028 (this->header_ptr(), to_insert, this->key_node_comp(this->key_comp())), this->priv_value_traits_ptr());
1029 this->sz_traits().increment();
1030 return ret;
1031 }
1032
1033 //! <b>Requires</b>: value must be an lvalue, and "hint" must be
1034 //! a valid iterator.
1035 //!
1036 //! <b>Effects</b>: Inserts x into the container, using "hint" as a hint to
1037 //! where it will be inserted. If "hint" is the upper_bound
1038 //! the insertion takes constant time (two comparisons in the worst case)
1039 //!
1040 //! <b>Complexity</b>: Logarithmic in general, but it is amortized
1041 //! constant time if t is inserted immediately before hint.
1042 //!
1043 //! <b>Throws</b>: If the internal key_compare ordering function throws. Strong guarantee.
1044 //!
1045 //! <b>Note</b>: Does not affect the validity of iterators and references.
1046 //! No copy-constructors are called.
1047 iterator insert_equal(const_iterator hint, reference value)
1048 {
1049 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1050 if(safemode_or_autounlink)
1051 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1052 iterator ret(node_algorithms::insert_equal
1053 (this->header_ptr(), hint.pointed_node(), to_insert, this->key_node_comp(this->key_comp())), this->priv_value_traits_ptr());
1054 this->sz_traits().increment();
1055 return ret;
1056 }
1057
1058 //! <b>Requires</b>: Dereferencing iterator must yield an lvalue
1059 //! of type value_type.
1060 //!
1061 //! <b>Effects</b>: Inserts a each element of a range into the container
1062 //! before the upper bound of the key of each element.
1063 //!
1064 //! <b>Complexity</b>: Insert range is in general O(N * log(N)), where N is the
1065 //! size of the range. However, it is linear in N if the range is already sorted
1066 //! by value_comp().
1067 //!
1068 //! <b>Throws</b>: Nothing.
1069 //!
1070 //! <b>Note</b>: Does not affect the validity of iterators and references.
1071 //! No copy-constructors are called.
1072 template<class Iterator>
1073 void insert_equal(Iterator b, Iterator e)
1074 {
1075 iterator iend(this->end());
1076 for (; b != e; ++b)
1077 this->insert_equal(iend, *b);
1078 }
1079
1080 //! <b>Requires</b>: value must be an lvalue
1081 //!
1082 //! <b>Effects</b>: Inserts value into the container if the value
1083 //! is not already present.
1084 //!
1085 //! <b>Complexity</b>: Average complexity for insert element is at
1086 //! most logarithmic.
1087 //!
1088 //! <b>Throws</b>: Nothing.
1089 //!
1090 //! <b>Note</b>: Does not affect the validity of iterators and references.
1091 //! No copy-constructors are called.
1092 std::pair<iterator, bool> insert_unique(reference value)
1093 {
1094 insert_commit_data commit_data;
1095 std::pair<node_ptr, bool> ret =
1096 (node_algorithms::insert_unique_check
1097 (this->header_ptr(), key_of_value()(value), this->key_node_comp(this->key_comp()), commit_data));
1098 return std::pair<iterator, bool>
1099 ( ret.second ? this->insert_unique_commit(value, commit_data)
1100 : iterator(ret.first, this->priv_value_traits_ptr())
1101 , ret.second);
1102 }
1103
1104 //! <b>Requires</b>: value must be an lvalue, and "hint" must be
1105 //! a valid iterator
1106 //!
1107 //! <b>Effects</b>: Tries to insert x into the container, using "hint" as a hint
1108 //! to where it will be inserted.
1109 //!
1110 //! <b>Complexity</b>: Logarithmic in general, but it is amortized
1111 //! constant time (two comparisons in the worst case)
1112 //! if t is inserted immediately before hint.
1113 //!
1114 //! <b>Throws</b>: Nothing.
1115 //!
1116 //! <b>Note</b>: Does not affect the validity of iterators and references.
1117 //! No copy-constructors are called.
1118 iterator insert_unique(const_iterator hint, reference value)
1119 {
1120 insert_commit_data commit_data;
1121 std::pair<node_ptr, bool> ret =
1122 (node_algorithms::insert_unique_check
1123 (this->header_ptr(), hint.pointed_node(), key_of_value()(value), this->key_node_comp(this->key_comp()), commit_data));
1124 return ret.second ? this->insert_unique_commit(value, commit_data)
1125 : iterator(ret.first, this->priv_value_traits_ptr());
1126 }
1127
1128 //! <b>Requires</b>: Dereferencing iterator must yield an lvalue
1129 //! of type value_type.
1130 //!
1131 //! <b>Effects</b>: Tries to insert each element of a range into the container.
1132 //!
1133 //! <b>Complexity</b>: Insert range is in general O(N * log(N)), where N is the
1134 //! size of the range. However, it is linear in N if the range is already sorted
1135 //! by value_comp().
1136 //!
1137 //! <b>Throws</b>: Nothing.
1138 //!
1139 //! <b>Note</b>: Does not affect the validity of iterators and references.
1140 //! No copy-constructors are called.
1141 template<class Iterator>
1142 void insert_unique(Iterator b, Iterator e)
1143 {
1144 if(this->empty()){
1145 iterator iend(this->end());
1146 for (; b != e; ++b)
1147 this->insert_unique(iend, *b);
1148 }
1149 else{
1150 for (; b != e; ++b)
1151 this->insert_unique(*b);
1152 }
1153 }
1154
1155 #ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
1156
1157 //! <b>Requires</b>: comp must be a comparison function that induces
1158 //! the same strict weak ordering as key_compare. The difference is that
1159 //! comp compares an arbitrary key with the contained values.
1160 //!
1161 //! <b>Effects</b>: Checks if a value can be inserted in the container, using
1162 //! a user provided key instead of the value itself.
1163 //!
1164 //! <b>Returns</b>: If there is an equivalent value
1165 //! returns a pair containing an iterator to the already present value
1166 //! and false. If the value can be inserted returns true in the returned
1167 //! pair boolean and fills "commit_data" that is meant to be used with
1168 //! the "insert_commit" function.
1169 //!
1170 //! <b>Complexity</b>: Average complexity is at most logarithmic.
1171 //!
1172 //! <b>Throws</b>: If the comp ordering function throws. Strong guarantee.
1173 //!
1174 //! <b>Notes</b>: This function is used to improve performance when constructing
1175 //! a value_type is expensive: if there is an equivalent value
1176 //! the constructed object must be discarded. Many times, the part of the
1177 //! node that is used to impose the order is much cheaper to construct
1178 //! than the value_type and this function offers the possibility to use that
1179 //! part to check if the insertion will be successful.
1180 //!
1181 //! If the check is successful, the user can construct the value_type and use
1182 //! "insert_commit" to insert the object in constant-time. This gives a total
1183 //! logarithmic complexity to the insertion: check(O(log(N)) + commit(O(1)).
1184 //!
1185 //! "commit_data" remains valid for a subsequent "insert_commit" only if no more
1186 //! objects are inserted or erased from the container.
1187 template<class KeyType, class KeyTypeKeyCompare>
1188 std::pair<iterator, bool> insert_unique_check
1189 (const KeyType &key, KeyTypeKeyCompare comp, insert_commit_data &commit_data);
1190
1191 //! <b>Requires</b>: comp must be a comparison function that induces
1192 //! the same strict weak ordering as key_compare. The difference is that
1193 //! comp compares an arbitrary key with the contained values.
1194 //!
1195 //! <b>Effects</b>: Checks if a value can be inserted in the container, using
1196 //! a user provided key instead of the value itself, using "hint"
1197 //! as a hint to where it will be inserted.
1198 //!
1199 //! <b>Returns</b>: If there is an equivalent value
1200 //! returns a pair containing an iterator to the already present value
1201 //! and false. If the value can be inserted returns true in the returned
1202 //! pair boolean and fills "commit_data" that is meant to be used with
1203 //! the "insert_commit" function.
1204 //!
1205 //! <b>Complexity</b>: Logarithmic in general, but it's amortized
1206 //! constant time if t is inserted immediately before hint.
1207 //!
1208 //! <b>Throws</b>: If the comp ordering function throws. Strong guarantee.
1209 //!
1210 //! <b>Notes</b>: This function is used to improve performance when constructing
1211 //! a value_type is expensive: if there is an equivalent value
1212 //! the constructed object must be discarded. Many times, the part of the
1213 //! constructing that is used to impose the order is much cheaper to construct
1214 //! than the value_type and this function offers the possibility to use that key
1215 //! to check if the insertion will be successful.
1216 //!
1217 //! If the check is successful, the user can construct the value_type and use
1218 //! "insert_commit" to insert the object in constant-time. This can give a total
1219 //! constant-time complexity to the insertion: check(O(1)) + commit(O(1)).
1220 //!
1221 //! "commit_data" remains valid for a subsequent "insert_commit" only if no more
1222 //! objects are inserted or erased from the container.
1223 template<class KeyType, class KeyTypeKeyCompare>
1224 std::pair<iterator, bool> insert_unique_check
1225 (const_iterator hint, const KeyType &key
1226 ,KeyTypeKeyCompare comp, insert_commit_data &commit_data);
1227
1228 #endif //#ifdef BOOST_INTRUSIVE_DOXYGEN_INVOKED
1229
1230 //! <b>Requires</b>: value must be an lvalue of type value_type. commit_data
1231 //! must have been obtained from a previous call to "insert_check".
1232 //! No objects should have been inserted or erased from the container between
1233 //! the "insert_check" that filled "commit_data" and the call to "insert_commit".
1234 //!
1235 //! <b>Effects</b>: Inserts the value in the container using the information obtained
1236 //! from the "commit_data" that a previous "insert_check" filled.
1237 //!
1238 //! <b>Returns</b>: An iterator to the newly inserted object.
1239 //!
1240 //! <b>Complexity</b>: Constant time.
1241 //!
1242 //! <b>Throws</b>: Nothing.
1243 //!
1244 //! <b>Notes</b>: This function has only sense if a "insert_check" has been
1245 //! previously executed to fill "commit_data". No value should be inserted or
1246 //! erased between the "insert_check" and "insert_commit" calls.
1247 iterator insert_unique_commit(reference value, const insert_commit_data &commit_data)
1248 {
1249 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1250 if(safemode_or_autounlink)
1251 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1252
1253 #if !(defined(BOOST_DISABLE_ASSERTS) || ( defined(BOOST_ENABLE_ASSERT_DEBUG_HANDLER) && defined(NDEBUG) ))
1254 //Test insertion position is correct
1255 iterator p(commit_data.node, this->priv_value_traits_ptr());
1256 if(!commit_data.link_left){
1257 ++p;
1258 }
1259 //Check if the insertion point is correct to detect wrong
1260 //uses insert_unique_check
1261 BOOST_ASSERT(( p == this->end() || !this->comp()(*p, value) ));
1262 BOOST_ASSERT(( p == this->begin() || !this->comp()(value, *--p) ));
1263 #endif
1264
1265 node_algorithms::insert_unique_commit
1266 (this->header_ptr(), to_insert, commit_data);
1267 this->sz_traits().increment();
1268 return iterator(to_insert, this->priv_value_traits_ptr());
1269 }
1270
1271 //! <b>Requires</b>: value must be an lvalue, "pos" must be
1272 //! a valid iterator (or end) and must be the succesor of value
1273 //! once inserted according to the predicate
1274 //!
1275 //! <b>Effects</b>: Inserts x into the container before "pos".
1276 //!
1277 //! <b>Complexity</b>: Constant time.
1278 //!
1279 //! <b>Throws</b>: Nothing.
1280 //!
1281 //! <b>Note</b>: This function does not check preconditions so if "pos" is not
1282 //! the successor of "value" container ordering invariant will be broken.
1283 //! This is a low-level function to be used only for performance reasons
1284 //! by advanced users.
1285 iterator insert_before(const_iterator pos, reference value)
1286 {
1287 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1288 if(safemode_or_autounlink)
1289 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1290 this->sz_traits().increment();
1291 return iterator(node_algorithms::insert_before
1292 (this->header_ptr(), pos.pointed_node(), to_insert), this->priv_value_traits_ptr());
1293 }
1294
1295 //! <b>Requires</b>: value must be an lvalue, and it must be no less
1296 //! than the greatest inserted key
1297 //!
1298 //! <b>Effects</b>: Inserts x into the container in the last position.
1299 //!
1300 //! <b>Complexity</b>: Constant time.
1301 //!
1302 //! <b>Throws</b>: Nothing.
1303 //!
1304 //! <b>Note</b>: This function does not check preconditions so if value is
1305 //! less than the greatest inserted key container ordering invariant will be broken.
1306 //! This function is slightly more efficient than using "insert_before".
1307 //! This is a low-level function to be used only for performance reasons
1308 //! by advanced users.
1309 void push_back(reference value)
1310 {
1311 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1312 if(safemode_or_autounlink)
1313 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1314 this->sz_traits().increment();
1315 node_algorithms::push_back(this->header_ptr(), to_insert);
1316 }
1317
1318 //! <b>Requires</b>: value must be an lvalue, and it must be no greater
1319 //! than the minimum inserted key
1320 //!
1321 //! <b>Effects</b>: Inserts x into the container in the first position.
1322 //!
1323 //! <b>Complexity</b>: Constant time.
1324 //!
1325 //! <b>Throws</b>: Nothing.
1326 //!
1327 //! <b>Note</b>: This function does not check preconditions so if value is
1328 //! greater than the minimum inserted key container ordering invariant will be broken.
1329 //! This function is slightly more efficient than using "insert_before".
1330 //! This is a low-level function to be used only for performance reasons
1331 //! by advanced users.
1332 void push_front(reference value)
1333 {
1334 node_ptr to_insert(this->get_value_traits().to_node_ptr(value));
1335 if(safemode_or_autounlink)
1336 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(node_algorithms::unique(to_insert));
1337 this->sz_traits().increment();
1338 node_algorithms::push_front(this->header_ptr(), to_insert);
1339 }
1340
1341 //! <b>Effects</b>: Erases the element pointed to by i.
1342 //!
1343 //! <b>Complexity</b>: Average complexity for erase element is constant time.
1344 //!
1345 //! <b>Throws</b>: Nothing.
1346 //!
1347 //! <b>Note</b>: Invalidates the iterators (but not the references)
1348 //! to the erased elements. No destructors are called.
1349 iterator erase(const_iterator i)
1350 {
1351 const_iterator ret(i);
1352 ++ret;
1353 node_ptr to_erase(i.pointed_node());
1354 if(safemode_or_autounlink)
1355 BOOST_INTRUSIVE_SAFE_HOOK_DEFAULT_ASSERT(!node_algorithms::unique(to_erase));
1356 node_algorithms::erase(this->header_ptr(), to_erase);
1357 this->sz_traits().decrement();
1358 if(safemode_or_autounlink)
1359 node_algorithms::init(to_erase);
1360 return ret.unconst();
1361 }
1362
1363 //! <b>Effects</b>: Erases the range pointed to by b end e.
1364 //!
1365 //! <b>Complexity</b>: Average complexity for erase range is at most
1366 //! O(log(size() + N)), where N is the number of elements in the range.
1367 //!
1368 //! <b>Throws</b>: Nothing.
1369 //!
1370 //! <b>Note</b>: Invalidates the iterators (but not the references)
1371 //! to the erased elements. No destructors are called.
1372 iterator erase(const_iterator b, const_iterator e)
1373 { size_type n; return this->private_erase(b, e, n); }
1374
1375 //! <b>Effects</b>: Erases all the elements with the given value.
1376 //!
1377 //! <b>Returns</b>: The number of erased elements.
1378 //!
1379 //! <b>Complexity</b>: O(log(size() + N).
1380 //!
1381 //! <b>Throws</b>: Nothing.
1382 //!
1383 //! <b>Note</b>: Invalidates the iterators (but not the references)
1384 //! to the erased elements. No destructors are called.
1385 size_type erase(const key_type &key)
1386 { return this->erase(key, this->key_comp()); }
1387
1388 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1389 //! comp(nk, key) and !comp(key, nk), with comp(nk, key) implying !comp(key, nk),
1390 //! with nk the key_type of a value_type inserted into `*this`.
1391 //!
1392 //! <b>Effects</b>: Erases all the elements with the given key.
1393 //! according to the comparison functor "comp".
1394 //!
1395 //! <b>Returns</b>: The number of erased elements.
1396 //!
1397 //! <b>Complexity</b>: O(log(size() + N).
1398 //!
1399 //! <b>Throws</b>: Nothing.
1400 //!
1401 //! <b>Note</b>: Invalidates the iterators (but not the references)
1402 //! to the erased elements. No destructors are called.
1403 template<class KeyType, class KeyTypeKeyCompare>
1404 BOOST_INTRUSIVE_DOC1ST(size_type
1405 , typename detail::disable_if_convertible<KeyTypeKeyCompare BOOST_INTRUSIVE_I const_iterator BOOST_INTRUSIVE_I size_type>::type)
1406 erase(const KeyType& key, KeyTypeKeyCompare comp)
1407 {
1408 std::pair<iterator,iterator> p = this->equal_range(key, comp);
1409 size_type n;
1410 this->private_erase(p.first, p.second, n);
1411 return n;
1412 }
1413
1414 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
1415 //!
1416 //! <b>Effects</b>: Erases the element pointed to by i.
1417 //! Disposer::operator()(pointer) is called for the removed element.
1418 //!
1419 //! <b>Complexity</b>: Average complexity for erase element is constant time.
1420 //!
1421 //! <b>Throws</b>: Nothing.
1422 //!
1423 //! <b>Note</b>: Invalidates the iterators
1424 //! to the erased elements.
1425 template<class Disposer>
1426 iterator erase_and_dispose(const_iterator i, Disposer disposer)
1427 {
1428 node_ptr to_erase(i.pointed_node());
1429 iterator ret(this->erase(i));
1430 disposer(this->get_value_traits().to_value_ptr(to_erase));
1431 return ret;
1432 }
1433
1434 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
1435 //!
1436 //! <b>Effects</b>: Erases all the elements with the given value.
1437 //! Disposer::operator()(pointer) is called for the removed elements.
1438 //!
1439 //! <b>Returns</b>: The number of erased elements.
1440 //!
1441 //! <b>Complexity</b>: O(log(size() + N).
1442 //!
1443 //! <b>Throws</b>: Nothing.
1444 //!
1445 //! <b>Note</b>: Invalidates the iterators (but not the references)
1446 //! to the erased elements. No destructors are called.
1447 template<class Disposer>
1448 size_type erase_and_dispose(const key_type &key, Disposer disposer)
1449 {
1450 std::pair<iterator,iterator> p = this->equal_range(key);
1451 size_type n;
1452 this->private_erase(p.first, p.second, n, disposer);
1453 return n;
1454 }
1455
1456 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
1457 //!
1458 //! <b>Effects</b>: Erases the range pointed to by b end e.
1459 //! Disposer::operator()(pointer) is called for the removed elements.
1460 //!
1461 //! <b>Complexity</b>: Average complexity for erase range is at most
1462 //! O(log(size() + N)), where N is the number of elements in the range.
1463 //!
1464 //! <b>Throws</b>: Nothing.
1465 //!
1466 //! <b>Note</b>: Invalidates the iterators
1467 //! to the erased elements.
1468 template<class Disposer>
1469 iterator erase_and_dispose(const_iterator b, const_iterator e, Disposer disposer)
1470 { size_type n; return this->private_erase(b, e, n, disposer); }
1471
1472 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1473 //! comp(nk, key) and !comp(key, nk), with comp(nk, key) implying !comp(key, nk)
1474 //! and nk the key_type of a value_type inserted into `*this`.
1475 //!
1476 //! <b>Requires</b>: Disposer::operator()(pointer) shouldn't throw.
1477 //!
1478 //! <b>Effects</b>: Erases all the elements with the given key.
1479 //! according to the comparison functor "comp".
1480 //! Disposer::operator()(pointer) is called for the removed elements.
1481 //!
1482 //! <b>Returns</b>: The number of erased elements.
1483 //!
1484 //! <b>Complexity</b>: O(log(size() + N).
1485 //!
1486 //! <b>Throws</b>: Nothing.
1487 //!
1488 //! <b>Note</b>: Invalidates the iterators
1489 //! to the erased elements.
1490 template<class KeyType, class KeyTypeKeyCompare, class Disposer>
1491 BOOST_INTRUSIVE_DOC1ST(size_type
1492 , typename detail::disable_if_convertible<KeyTypeKeyCompare BOOST_INTRUSIVE_I const_iterator BOOST_INTRUSIVE_I size_type>::type)
1493 erase_and_dispose(const KeyType& key, KeyTypeKeyCompare comp, Disposer disposer)
1494 {
1495 std::pair<iterator,iterator> p = this->equal_range(key, comp);
1496 size_type n;
1497 this->private_erase(p.first, p.second, n, disposer);
1498 return n;
1499 }
1500
1501 //! <b>Effects</b>: Erases all of the elements.
1502 //!
1503 //! <b>Complexity</b>: Linear to the number of elements on the container.
1504 //! if it's a safe-mode or auto-unlink value_type. Constant time otherwise.
1505 //!
1506 //! <b>Throws</b>: Nothing.
1507 //!
1508 //! <b>Note</b>: Invalidates the iterators (but not the references)
1509 //! to the erased elements. No destructors are called.
1510 void clear()
1511 {
1512 if(safemode_or_autounlink){
1513 this->clear_and_dispose(detail::null_disposer());
1514 }
1515 else{
1516 node_algorithms::init_header(this->header_ptr());
1517 this->sz_traits().set_size(0);
1518 }
1519 }
1520
1521 //! <b>Effects</b>: Erases all of the elements calling disposer(p) for
1522 //! each node to be erased.
1523 //! <b>Complexity</b>: Average complexity for is at most O(log(size() + N)),
1524 //! where N is the number of elements in the container.
1525 //!
1526 //! <b>Throws</b>: Nothing.
1527 //!
1528 //! <b>Note</b>: Invalidates the iterators (but not the references)
1529 //! to the erased elements. Calls N times to disposer functor.
1530 template<class Disposer>
1531 void clear_and_dispose(Disposer disposer)
1532 {
1533 node_algorithms::clear_and_dispose(this->header_ptr()
1534 , detail::node_disposer<Disposer, value_traits, AlgoType>(disposer, &this->get_value_traits()));
1535 node_algorithms::init_header(this->header_ptr());
1536 this->sz_traits().set_size(0);
1537 }
1538
1539 //! <b>Effects</b>: Returns the number of contained elements with the given value
1540 //!
1541 //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal
1542 //! to number of objects with the given value.
1543 //!
1544 //! <b>Throws</b>: If `key_compare` throws.
1545 size_type count(const key_type &key) const
1546 { return size_type(this->count(key, this->key_comp())); }
1547
1548 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1549 //! comp(nk, key) and !comp(key, nk), with comp(nk, key) implying !comp(key, nk),
1550 //! and nk the key_type of a value_type inserted into `*this`.
1551 //!
1552 //! <b>Effects</b>: Returns the number of contained elements with the given key
1553 //!
1554 //! <b>Complexity</b>: Logarithmic to the number of elements contained plus lineal
1555 //! to number of objects with the given key.
1556 //!
1557 //! <b>Throws</b>: If `comp` throws.
1558 template<class KeyType, class KeyTypeKeyCompare>
1559 size_type count(const KeyType &key, KeyTypeKeyCompare comp) const
1560 {
1561 std::pair<const_iterator, const_iterator> ret = this->equal_range(key, comp);
1562 size_type n = 0;
1563 for(; ret.first != ret.second; ++ret.first){ ++n; }
1564 return n;
1565 }
1566
1567 #if !defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
1568
1569 //Add non-const overloads to theoretically const members
1570 //as some algorithms have different behavior when non-const versions are used (like splay trees).
1571 size_type count(const key_type &key)
1572 { return size_type(this->count(key, this->key_comp())); }
1573
1574 template<class KeyType, class KeyTypeKeyCompare>
1575 size_type count(const KeyType &key, KeyTypeKeyCompare comp)
1576 {
1577 std::pair<const_iterator, const_iterator> ret = this->equal_range(key, comp);
1578 size_type n = 0;
1579 for(; ret.first != ret.second; ++ret.first){ ++n; }
1580 return n;
1581 }
1582
1583 #else //defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
1584
1585 //! <b>Effects</b>: Returns an iterator to the first element whose
1586 //! key is not less than k or end() if that element does not exist.
1587 //!
1588 //! <b>Complexity</b>: Logarithmic.
1589 //!
1590 //! <b>Throws</b>: If `key_compare` throws.
1591 iterator lower_bound(const key_type &key);
1592
1593 //! <b>Effects</b>: Returns an iterator to the first element whose
1594 //! key is not less than k or end() if that element does not exist.
1595 //!
1596 //! <b>Complexity</b>: Logarithmic.
1597 //!
1598 //! <b>Throws</b>: If `key_compare` throws.
1599 const_iterator lower_bound(const key_type &key) const;
1600
1601 //! @copydoc ::boost::intrusive::bstree::lower_bound(const key_type &)
1602 template<class KeyType, class KeyTypeKeyCompare>
1603 iterator lower_bound(const KeyType &key, KeyTypeKeyCompare comp);
1604
1605 //! @copydoc ::boost::intrusive::bstree::lower_bound(const KeyType&,KeyTypeKeyCompare)
1606 template<class KeyType, class KeyTypeKeyCompare>
1607 const_iterator lower_bound(const KeyType &key, KeyTypeKeyCompare comp) const;
1608
1609 //! <b>Effects</b>: Returns an iterator to the first element whose
1610 //! key is greater than k or end() if that element does not exist.
1611 //!
1612 //! <b>Complexity</b>: Logarithmic.
1613 //!
1614 //! <b>Throws</b>: If `key_compare` throws.
1615 iterator upper_bound(const key_type &key);
1616
1617 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1618 //! !comp(key, nk), with nk the key_type of a value_type inserted into `*this`.
1619 //!
1620 //! <b>Effects</b>: Returns an iterator to the first element whose
1621 //! key is greater than k according to comp or end() if that element
1622 //! does not exist.
1623 //!
1624 //! <b>Complexity</b>: Logarithmic.
1625 //!
1626 //! <b>Throws</b>: If `comp` throws.
1627 template<class KeyType, class KeyTypeKeyCompare>
1628 iterator upper_bound(const KeyType &key, KeyTypeKeyCompare comp);
1629
1630 //! @copydoc ::boost::intrusive::bstree::upper_bound(const key_type &)
1631 const_iterator upper_bound(const key_type &key) const;
1632
1633 //! @copydoc ::boost::intrusive::bstree::upper_bound(const KeyType&,KeyTypeKeyCompare)
1634 template<class KeyType, class KeyTypeKeyCompare>
1635 const_iterator upper_bound(const KeyType &key, KeyTypeKeyCompare comp) const;
1636
1637 //! <b>Effects</b>: Finds an iterator to the first element whose key is
1638 //! k or end() if that element does not exist.
1639 //!
1640 //! <b>Complexity</b>: Logarithmic.
1641 //!
1642 //! <b>Throws</b>: If `key_compare` throws.
1643 iterator find(const key_type &key);
1644
1645 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1646 //! comp(nk, key) and !comp(key, nk), with comp(nk, key) implying !comp(key, nk),
1647 //! and nk the key_type of a value_type inserted into `*this`.
1648 //!
1649 //! <b>Effects</b>: Finds an iterator to the first element whose key is
1650 //! k or end() if that element does not exist.
1651 //!
1652 //! <b>Complexity</b>: Logarithmic.
1653 //!
1654 //! <b>Throws</b>: If `comp` throws.
1655 template<class KeyType, class KeyTypeKeyCompare>
1656 iterator find(const KeyType &key, KeyTypeKeyCompare comp);
1657
1658 //! @copydoc ::boost::intrusive::bstree::find(const key_type &)
1659 const_iterator find(const key_type &key) const;
1660
1661 //! @copydoc ::boost::intrusive::bstree::find(const KeyType&,KeyTypeKeyCompare)
1662 template<class KeyType, class KeyTypeKeyCompare>
1663 const_iterator find(const KeyType &key, KeyTypeKeyCompare comp) const;
1664
1665 //! <b>Effects</b>: Finds a range containing all elements whose key is k or
1666 //! an empty range that indicates the position where those elements would be
1667 //! if they there is no elements with key k.
1668 //!
1669 //! <b>Complexity</b>: Logarithmic.
1670 //!
1671 //! <b>Throws</b>: If `key_compare` throws.
1672 std::pair<iterator,iterator> equal_range(const key_type &key);
1673
1674 //! <b>Requires</b>: key is a value such that `*this` is partitioned with respect to
1675 //! comp(nk, key) and !comp(key, nk), with comp(nk, key) implying !comp(key, nk),
1676 //! with nk the key_type of a value_type inserted into `*this`.
1677 //!
1678 //! <b>Effects</b>: Finds a range containing all elements whose key is k or
1679 //! an empty range that indicates the position where those elements would be
1680 //! if they there is no elements with key k.
1681 //!
1682 //! <b>Complexity</b>: Logarithmic.
1683 //!
1684 //! <b>Throws</b>: If `comp` throws.
1685 template<class KeyType, class KeyTypeKeyCompare>
1686 std::pair<iterator,iterator> equal_range(const KeyType &key, KeyTypeKeyCompare comp);
1687
1688 //! @copydoc ::boost::intrusive::bstree::equal_range(const key_type &)
1689 std::pair<const_iterator, const_iterator> equal_range(const key_type &key) const;
1690
1691 //! @copydoc ::boost::intrusive::bstree::equal_range(const KeyType&,KeyTypeKeyCompare)
1692 template<class KeyType, class KeyTypeKeyCompare>
1693 std::pair<const_iterator, const_iterator>
1694 equal_range(const KeyType &key, KeyTypeKeyCompare comp) const;
1695
1696 //! <b>Requires</b>:
1697 //! `upper_key` shall not precede `lower_key` according to key_compare.
1698 //! [key_comp()(upper_key, lower_key) shall be false]
1699 //!
1700 //! If `lower_key` is equivalent to `upper_key`
1701 //! [!key_comp()(upper_key, lower_key) && !key_comp()(lower_key, upper_key)] then
1702 //! ('left_closed' || 'right_closed') must be false.
1703 //!
1704 //! <b>Effects</b>: Returns an a pair with the following criteria:
1705 //!
1706 //! first = lower_bound(lower_key) if left_closed, upper_bound(lower_key) otherwise
1707 //!
1708 //! second = upper_bound(upper_key) if right_closed, lower_bound(upper_key) otherwise
1709 //!
1710 //! <b>Complexity</b>: Logarithmic.
1711 //!
1712 //! <b>Throws</b>: If `key_compare` throws.
1713 //!
1714 //! <b>Note</b>: This function can be more efficient than calling upper_bound
1715 //! and lower_bound for lower_value and upper_value.
1716 //!
1717 //! <b>Note</b>: Experimental function, the interface might change in future releases.
1718 std::pair<iterator,iterator> bounded_range
1719 (const key_type &lower_key, const key_type &upper_value, bool left_closed, bool right_closed);
1720
1721 //! <b>Requires</b>:
1722 //! `lower_key` is a value such that `*this` is partitioned with respect to
1723 //! comp(nk, lower_key) if left_closed is true, with respect to !comp(lower_key, nk) otherwise.
1724 //!
1725 //! `upper_key` is a value such that `*this` is partitioned with respect to
1726 //! !comp(upper_key, nk) if right_closed is true, with respect to comp(nk, upper_key) otherwise.
1727 //!
1728 //! `upper_key` shall not precede `lower_key` according to comp
1729 //! [comp(upper_key, lower_key) shall be false]
1730 //!
1731 //! If `lower_key` is equivalent to `upper_key`
1732 //! [!comp(upper_key, lower_key) && !comp(lower_key, upper_key)] then
1733 //! ('left_closed' || 'right_closed') must be false.
1734 //!
1735 //! <b>Effects</b>: Returns an a pair with the following criteria:
1736 //!
1737 //! first = lower_bound(lower_key, comp) if left_closed, upper_bound(lower_key, comp) otherwise
1738 //!
1739 //! second = upper_bound(upper_key, comp) if right_closed, lower_bound(upper_key, comp) otherwise
1740 //!
1741 //! <b>Complexity</b>: Logarithmic.
1742 //!
1743 //! <b>Throws</b>: If `comp` throws.
1744 //!
1745 //! <b>Note</b>: This function can be more efficient than calling upper_bound
1746 //! and lower_bound for lower_key and upper_key.
1747 //!
1748 //! <b>Note</b>: Experimental function, the interface might change in future releases.
1749 template<class KeyType, class KeyTypeKeyCompare>
1750 std::pair<iterator,iterator> bounded_range
1751 (const KeyType &lower_key, const KeyType &upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed);
1752
1753 //! @copydoc ::boost::intrusive::bstree::bounded_range(const key_type &,const key_type &,bool,bool)
1754 std::pair<const_iterator,const_iterator> bounded_range
1755 (const key_type &lower_key, const key_type &upper_key, bool left_closed, bool right_closed) const;
1756
1757 //! @copydoc ::boost::intrusive::bstree::bounded_range(const KeyType&,const KeyType&,KeyTypeKeyCompare,bool,bool)
1758 template<class KeyType, class KeyTypeKeyCompare>
1759 std::pair<const_iterator,const_iterator> bounded_range
1760 (const KeyType &lower_key, const KeyType &upper_key, KeyTypeKeyCompare comp, bool left_closed, bool right_closed) const;
1761
1762 //! <b>Requires</b>: value must be an lvalue and shall be in a set of
1763 //! appropriate type. Otherwise the behavior is undefined.
1764 //!
1765 //! <b>Effects</b>: Returns: a valid iterator i belonging to the set
1766 //! that points to the value
1767 //!
1768 //! <b>Complexity</b>: Constant.
1769 //!
1770 //! <b>Throws</b>: Nothing.
1771 //!
1772 //! <b>Note</b>: This static function is available only if the <i>value traits</i>
1773 //! is stateless.
1774 static iterator s_iterator_to(reference value);
1775
1776 //! <b>Requires</b>: value must be an lvalue and shall be in a set of
1777 //! appropriate type. Otherwise the behavior is undefined.
1778 //!
1779 //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the
1780 //! set that points to the value
1781 //!
1782 //! <b>Complexity</b>: Constant.
1783 //!
1784 //! <b>Throws</b>: Nothing.
1785 //!
1786 //! <b>Note</b>: This static function is available only if the <i>value traits</i>
1787 //! is stateless.
1788 static const_iterator s_iterator_to(const_reference value);
1789
1790 //! <b>Requires</b>: value must be an lvalue and shall be in a set of
1791 //! appropriate type. Otherwise the behavior is undefined.
1792 //!
1793 //! <b>Effects</b>: Returns: a valid iterator i belonging to the set
1794 //! that points to the value
1795 //!
1796 //! <b>Complexity</b>: Constant.
1797 //!
1798 //! <b>Throws</b>: Nothing.
1799 iterator iterator_to(reference value);
1800
1801 //! <b>Requires</b>: value must be an lvalue and shall be in a set of
1802 //! appropriate type. Otherwise the behavior is undefined.
1803 //!
1804 //! <b>Effects</b>: Returns: a valid const_iterator i belonging to the
1805 //! set that points to the value
1806 //!
1807 //! <b>Complexity</b>: Constant.
1808 //!
1809 //! <b>Throws</b>: Nothing.
1810 const_iterator iterator_to(const_reference value) const;
1811
1812 //! <b>Requires</b>: value shall not be in a container.
1813 //!
1814 //! <b>Effects</b>: init_node puts the hook of a value in a well-known default
1815 //! state.
1816 //!
1817 //! <b>Throws</b>: Nothing.
1818 //!
1819 //! <b>Complexity</b>: Constant time.
1820 //!
1821 //! <b>Note</b>: This function puts the hook in the well-known default state
1822 //! used by auto_unlink and safe hooks.
1823 static void init_node(reference value);
1824
1825 #endif //#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
1826
1827 //! <b>Effects</b>: Unlinks the leftmost node from the container.
1828 //!
1829 //! <b>Complexity</b>: Average complexity is constant time.
1830 //!
1831 //! <b>Throws</b>: Nothing.
1832 //!
1833 //! <b>Notes</b>: This function breaks the container and the container can
1834 //! only be used for more unlink_leftmost_without_rebalance calls.
1835 //! This function is normally used to achieve a step by step
1836 //! controlled destruction of the container.
1837 pointer unlink_leftmost_without_rebalance()
1838 {
1839 node_ptr to_be_disposed(node_algorithms::unlink_leftmost_without_rebalance
1840 (this->header_ptr()));
1841 if(!to_be_disposed)
1842 return 0;
1843 this->sz_traits().decrement();
1844 if(safemode_or_autounlink)//If this is commented does not work with normal_link
1845 node_algorithms::init(to_be_disposed);
1846 return this->get_value_traits().to_value_ptr(to_be_disposed);
1847 }
1848
1849 #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
1850
1851 //! <b>Requires</b>: replace_this must be a valid iterator of *this
1852 //! and with_this must not be inserted in any container.
1853 //!
1854 //! <b>Effects</b>: Replaces replace_this in its position in the
1855 //! container with with_this. The container does not need to be rebalanced.
1856 //!
1857 //! <b>Complexity</b>: Constant.
1858 //!
1859 //! <b>Throws</b>: Nothing.
1860 //!
1861 //! <b>Note</b>: This function will break container ordering invariants if
1862 //! with_this is not equivalent to *replace_this according to the
1863 //! ordering rules. This function is faster than erasing and inserting
1864 //! the node, since no rebalancing or comparison is needed.
1865 void replace_node(iterator replace_this, reference with_this);
1866
1867 //! <b>Effects</b>: Rebalances the tree.
1868 //!
1869 //! <b>Throws</b>: Nothing.
1870 //!
1871 //! <b>Complexity</b>: Linear.
1872 void rebalance();
1873
1874 //! <b>Requires</b>: old_root is a node of a tree.
1875 //!
1876 //! <b>Effects</b>: Rebalances the subtree rooted at old_root.
1877 //!
1878 //! <b>Returns</b>: The new root of the subtree.
1879 //!
1880 //! <b>Throws</b>: Nothing.
1881 //!
1882 //! <b>Complexity</b>: Linear to the elements in the subtree.
1883 iterator rebalance_subtree(iterator root);
1884
1885 #endif //#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
1886
1887 //! <b>Effects</b>: removes "value" from the container.
1888 //!
1889 //! <b>Throws</b>: Nothing.
1890 //!
1891 //! <b>Complexity</b>: Logarithmic time.
1892 //!
1893 //! <b>Note</b>: This static function is only usable with non-constant
1894 //! time size containers that have stateless comparison functors.
1895 //!
1896 //! If the user calls
1897 //! this function with a constant time size container or stateful comparison
1898 //! functor a compilation error will be issued.
1899 static void remove_node(reference value)
1900 {
1901 BOOST_STATIC_ASSERT((!constant_time_size));
1902 node_ptr to_remove(value_traits::to_node_ptr(value));
1903 node_algorithms::unlink(to_remove);
1904 if(safemode_or_autounlink)
1905 node_algorithms::init(to_remove);
1906 }
1907
1908 //! <b>Effects</b>: Asserts the integrity of the container with additional checks provided by the user.
1909 //!
1910 //! <b>Complexity</b>: Linear time.
1911 //!
1912 //! <b>Note</b>: The method might not have effect when asserts are turned off (e.g., with NDEBUG).
1913 //! Experimental function, interface might change in future versions.
1914 template <class ExtraChecker>
1915 void check(ExtraChecker extra_checker) const
1916 {
1917 typedef detail::key_nodeptr_comp<key_compare, value_traits, key_of_value> nodeptr_comp_t;
1918 nodeptr_comp_t nodeptr_comp(this->key_comp(), &this->get_value_traits());
1919 typedef typename get_node_checker<AlgoType, ValueTraits, nodeptr_comp_t, ExtraChecker>::type node_checker_t;
1920 typename node_checker_t::return_type checker_return;
1921 node_algorithms::check(this->header_ptr(), node_checker_t(nodeptr_comp, extra_checker), checker_return);
1922 if (constant_time_size)
1923 BOOST_INTRUSIVE_INVARIANT_ASSERT(this->sz_traits().get_size() == checker_return.node_count);
1924 }
1925
1926 //! <b>Effects</b>: Asserts the integrity of the container.
1927 //!
1928 //! <b>Complexity</b>: Linear time.
1929 //!
1930 //! <b>Note</b>: The method has no effect when asserts are turned off (e.g., with NDEBUG).
1931 //! Experimental function, interface might change in future versions.
1932 void check() const
1933 {
1934 check(detail::empty_node_checker<ValueTraits>());
1935 }
1936
1937 friend bool operator==(const bstree_impl &x, const bstree_impl &y)
1938 {
1939 if(constant_time_size && x.size() != y.size()){
1940 return false;
1941 }
1942 return boost::intrusive::algo_equal(x.cbegin(), x.cend(), y.cbegin(), y.cend());
1943 }
1944
1945 friend bool operator!=(const bstree_impl &x, const bstree_impl &y)
1946 { return !(x == y); }
1947
1948 friend bool operator<(const bstree_impl &x, const bstree_impl &y)
1949 { return ::boost::intrusive::algo_lexicographical_compare(x.begin(), x.end(), y.begin(), y.end()); }
1950
1951 friend bool operator>(const bstree_impl &x, const bstree_impl &y)
1952 { return y < x; }
1953
1954 friend bool operator<=(const bstree_impl &x, const bstree_impl &y)
1955 { return !(x > y); }
1956
1957 friend bool operator>=(const bstree_impl &x, const bstree_impl &y)
1958 { return !(x < y); }
1959
1960 friend void swap(bstree_impl &x, bstree_impl &y)
1961 { x.swap(y); }
1962
1963 /// @cond
1964 private:
1965 template<class Disposer>
1966 iterator private_erase(const_iterator b, const_iterator e, size_type &n, Disposer disposer)
1967 {
1968 for(n = 0; b != e; ++n)
1969 this->erase_and_dispose(b++, disposer);
1970 return b.unconst();
1971 }
1972
1973 iterator private_erase(const_iterator b, const_iterator e, size_type &n)
1974 {
1975 for(n = 0; b != e; ++n)
1976 this->erase(b++);
1977 return b.unconst();
1978 }
1979 /// @endcond
1980};
1981
1982//! Helper metafunction to define a \c bstree that yields to the same type when the
1983//! same options (either explicitly or implicitly) are used.
1984#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) || defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
1985template<class T, class ...Options>
1986#else
1987template<class T, class O1 = void, class O2 = void
1988 , class O3 = void, class O4 = void
1989 , class O5 = void, class O6 = void>
1990#endif
1991struct make_bstree
1992{
1993 /// @cond
1994 typedef typename pack_options
1995 < bstree_defaults,
1996 #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
1997 O1, O2, O3, O4, O5, O6
1998 #else
1999 Options...
2000 #endif
2001 >::type packed_options;
2002
2003 typedef typename detail::get_value_traits
2004 <T, typename packed_options::proto_value_traits>::type value_traits;
2005
2006 typedef bstree_impl
2007 < value_traits
2008 , typename packed_options::key_of_value
2009 , typename packed_options::compare
2010 , typename packed_options::size_type
2011 , packed_options::constant_time_size
2012 , BsTreeAlgorithms
2013 , typename packed_options::header_holder_type
2014 > implementation_defined;
2015 /// @endcond
2016 typedef implementation_defined type;
2017};
2018
2019
2020#ifndef BOOST_INTRUSIVE_DOXYGEN_INVOKED
2021
2022#if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
2023template<class T, class O1, class O2, class O3, class O4, class O5, class O6>
2024#else
2025template<class T, class ...Options>
2026#endif
2027class bstree
2028 : public make_bstree<T,
2029 #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
2030 O1, O2, O3, O4, O5, O6
2031 #else
2032 Options...
2033 #endif
2034 >::type
2035{
2036 typedef typename make_bstree
2037 <T,
2038 #if !defined(BOOST_INTRUSIVE_VARIADIC_TEMPLATES)
2039 O1, O2, O3, O4, O5, O6
2040 #else
2041 Options...
2042 #endif
2043 >::type Base;
2044 BOOST_MOVABLE_BUT_NOT_COPYABLE(bstree)
2045
2046 public:
2047 typedef typename Base::key_compare key_compare;
2048 typedef typename Base::value_traits value_traits;
2049 typedef typename Base::iterator iterator;
2050 typedef typename Base::const_iterator const_iterator;
2051
2052 //Assert if passed value traits are compatible with the type
2053 BOOST_STATIC_ASSERT((detail::is_same<typename value_traits::value_type, T>::value));
2054
2055 bstree( const key_compare &cmp = key_compare()
2056 , const value_traits &v_traits = value_traits())
2057 : Base(cmp, v_traits)
2058 {}
2059
2060 template<class Iterator>
2061 bstree( bool unique, Iterator b, Iterator e
2062 , const key_compare &cmp = key_compare()
2063 , const value_traits &v_traits = value_traits())
2064 : Base(unique, b, e, cmp, v_traits)
2065 {}
2066
2067 bstree(BOOST_RV_REF(bstree) x)
2068 : Base(BOOST_MOVE_BASE(Base, x))
2069 {}
2070
2071 bstree& operator=(BOOST_RV_REF(bstree) x)
2072 { return static_cast<bstree &>(this->Base::operator=(BOOST_MOVE_BASE(Base, x))); }
2073
2074 template <class Cloner, class Disposer>
2075 void clone_from(const bstree &src, Cloner cloner, Disposer disposer)
2076 { Base::clone_from(src, cloner, disposer); }
2077
2078 template <class Cloner, class Disposer>
2079 void clone_from(BOOST_RV_REF(bstree) src, Cloner cloner, Disposer disposer)
2080 { Base::clone_from(BOOST_MOVE_BASE(Base, src), cloner, disposer); }
2081
2082 static bstree &container_from_end_iterator(iterator end_iterator)
2083 { return static_cast<bstree &>(Base::container_from_end_iterator(end_iterator)); }
2084
2085 static const bstree &container_from_end_iterator(const_iterator end_iterator)
2086 { return static_cast<const bstree &>(Base::container_from_end_iterator(end_iterator)); }
2087
2088 static bstree &container_from_iterator(iterator it)
2089 { return static_cast<bstree &>(Base::container_from_iterator(it)); }
2090
2091 static const bstree &container_from_iterator(const_iterator it)
2092 { return static_cast<const bstree &>(Base::container_from_iterator(it)); }
2093};
2094
2095#endif
2096} //namespace intrusive
2097} //namespace boost
2098
2099#include <boost/intrusive/detail/config_end.hpp>
2100
2101#endif //BOOST_INTRUSIVE_BSTREE_HPP
2102

source code of boost/boost/intrusive/bstree.hpp