3 #ifndef __CDS_CONTAINER_ELLEN_BINTREE_SET_IMPL_H
4 #define __CDS_CONTAINER_ELLEN_BINTREE_SET_IMPL_H
7 #include <cds/container/ellen_bintree_base.h>
8 #include <cds/intrusive/ellen_bintree_impl.h>
9 #include <cds/container/details/guarded_ptr_cast.h>
11 namespace cds { namespace container {
13 /// Set based on Ellen's et al binary search tree
14 /** @ingroup cds_nonintrusive_set
15 @ingroup cds_nonintrusive_tree
16 @anchor cds_container_EllenBinTreeSet
19 - [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"
21 %EllenBinTreeSet is an unbalanced leaf-oriented binary search tree that implements the <i>set</i>
22 abstract data type. Nodes maintains child pointers but not parent pointers.
23 Every internal node has exactly two children, and all data of type \p T currently in
24 the tree are stored in the leaves. Internal nodes of the tree are used to direct \p find
25 operation along the path to the correct leaf. The keys (of \p Key type) stored in internal nodes
26 may or may not be in the set. \p Key type is a subset of \p T type.
27 There should be exactly defined a key extracting functor for converting object of type \p T to
28 object of type \p Key.
30 Due to \p extract_min and \p extract_max member functions the \p %EllenBinTreeSet can act as
31 a <i>priority queue</i>. In this case you should provide unique compound key, for example,
32 the priority value plus some uniformly distributed random value.
34 @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
35 for uniformly distributed random keys, but in worst case the complexity is <tt>O(N)</tt>.
37 @note In the current implementation we do not use helping technique described in original paper.
38 So, the current implementation is near to fine-grained lock-based tree.
39 Helping will be implemented in future release
41 <b>Template arguments</b> :
42 - \p GC - safe memory reclamation (i.e. light-weight garbage collector) type, like cds::gc::HP, cds::gc::PTB
43 Note that cds::gc::HRC is not supported.
44 - \p Key - key type, a subset of \p T
45 - \p T - type to be stored in tree's leaf nodes.
46 - \p Traits - type traits. See ellen_bintree::type_traits for explanation.
48 It is possible to declare option-based tree with ellen_bintree::make_set_traits metafunction
49 instead of \p Traits template argument.
50 Template argument list \p Options of ellen_bintree::make_set_traits metafunction are:
51 - ellen_bintree::key_extractor - key extracting functor, mandatory option. The functor has the following prototype:
53 struct key_extractor {
54 void operator ()( Key& dest, T const& src );
57 It should initialize \p dest key from \p src data. The functor is used to initialize internal nodes.
58 - opt::compare - key compare functor. No default functor is provided.
59 If the option is not specified, \p %opt::less is used.
60 - opt::less - specifies binary predicate used for key compare. At least \p %opt::compare or \p %opt::less should be defined.
61 - opt::item_counter - the type of item counting feature. Default is \ref atomicity::empty_item_counter that is no item counting.
62 - opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default)
63 or opt::v::sequential_consistent (sequentially consisnent memory model).
64 - opt::allocator - the allocator used for \ref ellen_bintree::node "leaf nodes" which contains data.
65 Default is \ref CDS_DEFAULT_ALLOCATOR.
66 - opt::node_allocator - the allocator used for internal nodes. Default is \ref CDS_DEFAULT_ALLOCATOR.
67 - ellen_bintree::update_desc_allocator - an allocator of \ref ellen_bintree::update_desc "update descriptors",
68 default is \ref CDS_DEFAULT_ALLOCATOR.
69 Note that update descriptor is helping data structure with short lifetime and it is good candidate for pooling.
70 The number of simultaneously existing descriptors is a relatively small number limited the number of threads
71 working with the tree and GC buffer size.
72 Therefore, a bounded lock-free container like \p cds::container::VyukovMPMCCycleQueue is good choice for the free-list
73 of update descriptors, see cds::memory::vyukov_queue_pool free-list implementation.
74 Also notice that size of update descriptor is not dependent on the type of data
75 stored in the tree so single free-list object can be used for several EllenBinTree-based object.
76 - opt::stat - internal statistics. Available types: ellen_bintree::stat, ellen_bintree::empty_stat (the default)
78 @note Do not include <tt><cds/container/ellen_bintree_set_impl.h></tt> header file directly.
79 There are header file for each GC type:
80 - <tt><cds/container/ellen_bintree_set_hp.h></tt> - for Hazard Pointer GC cds::gc::HP
81 - <tt><cds/container/ellen_bintree_set_ptb.h></tt> - for Pass-the-Buck GC cds::gc::PTB
82 - <tt><cds/container/ellen_bintree_set_rcu.h></tt> - for RCU GC
83 (see \ref cds_container_EllenBinTreeSet_rcu "RCU-based EllenBinTreeSet")
85 @anchor cds_container_EllenBinTreeSet_less
86 <b>Predicate requirements</b>
88 opt::less, opt::compare and other predicates using with member fuctions should accept at least parameters
89 of type \p T and \p Key in any combination.
90 For example, for \p Foo struct with \p std::string key field the appropiate \p less functor is:
99 bool operator()( Foo const& v1, Foo const& v2 ) const
100 { return v1.m_strKey < v2.m_strKey ; }
102 bool operator()( Foo const& v, std::string const& s ) const
103 { return v.m_strKey < s ; }
105 bool operator()( std::string const& s, Foo const& v ) const
106 { return s < v.m_strKey ; }
108 // Support comparing std::string and char const *
109 bool operator()( std::string const& s, char const * p ) const
110 { return s.compare(p) < 0 ; }
112 bool operator()( Foo const& v, char const * p ) const
113 { return v.m_strKey.compare(p) < 0 ; }
115 bool operator()( char const * p, std::string const& s ) const
116 { return s.compare(p) > 0; }
118 bool operator()( char const * p, Foo const& v ) const
119 { return v.m_strKey.compare(p) > 0; }
127 #ifdef CDS_DOXYGEN_INVOKED
128 class Traits = ellen_bintree::type_traits
133 class EllenBinTreeSet
134 #ifdef CDS_DOXYGEN_INVOKED
135 : public cds::intrusive::EllenBinTree< GC, Key, T, Traits >
137 : public ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits >::type
141 typedef ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits > maker;
142 typedef typename maker::type base_class;
146 typedef GC gc ; ///< Garbage collector
147 typedef Key key_type ; ///< type of a key stored in internal nodes; key is a part of \p value_type
148 typedef T value_type ; ///< type of value stored in the binary tree
149 typedef Traits options ; ///< Traits template parameter
151 # ifdef CDS_DOXYGEN_INVOKED
152 typedef implementation_defined key_comparator ; ///< key compare functor based on opt::compare and opt::less option setter.
154 typedef typename maker::intrusive_type_traits::compare key_comparator;
156 typedef typename base_class::item_counter item_counter ; ///< Item counting policy used
157 typedef typename base_class::memory_model memory_model ; ///< Memory ordering. See cds::opt::memory_model option
158 typedef typename base_class::stat stat ; ///< internal statistics type
159 typedef typename options::key_extractor key_extractor ; ///< key extracting functor
161 typedef typename options::allocator allocator_type ; ///< Allocator for leaf nodes
162 typedef typename base_class::node_allocator node_allocator ; ///< Internal node allocator
163 typedef typename base_class::update_desc_allocator update_desc_allocator ; ///< Update descriptor allocator
167 typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
168 typedef typename base_class::value_type leaf_node;
169 typedef typename base_class::internal_node internal_node;
171 typedef std::unique_ptr< leaf_node, typename maker::leaf_deallocator > scoped_node_ptr;
176 typedef cds::gc::guarded_ptr< gc, leaf_node, value_type, details::guarded_ptr_cast_set<leaf_node, value_type> > guarded_ptr;
180 # ifndef CDS_CXX11_LAMBDA_SUPPORT
181 template <typename Func>
182 struct insert_functor
186 insert_functor ( Func f )
190 void operator()( leaf_node& node )
192 cds::unref(m_func)( node.m_Value );
196 template <typename Q, typename Func>
197 struct ensure_functor
202 ensure_functor( Q const& arg, Func f )
207 void operator ()( bool bNew, leaf_node& node, leaf_node& )
209 cds::unref(m_func)( bNew, node.m_Value, m_arg );
213 template <typename Func>
218 erase_functor( Func f )
222 void operator()( leaf_node const& node )
224 cds::unref(m_func)( node.m_Value );
228 template <typename Func>
233 find_functor( Func f )
237 template <typename Q>
238 void operator ()( leaf_node& node, Q& val )
240 cds::unref(m_func)( node.m_Value, val );
247 /// Default constructor
251 //static_assert( (std::is_same<gc, cds::gc::HP>::value || std::is_same<gc, cds::gc::PTB>::value), "GC must be cds::gc::HP or cds:gc::PTB" );
260 The function creates a node with copy of \p val value
261 and then inserts the node created into the set.
263 The type \p Q should contain at least the complete key for the node.
264 The object of \ref value_type should be constructible from a value of type \p Q.
265 In trivial case, \p Q is equal to \ref value_type.
267 Returns \p true if \p val is inserted into the set, \p false otherwise.
269 template <typename Q>
270 bool insert( Q const& val )
272 scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
273 if ( base_class::insert( *sp.get() )) {
282 The function allows to split creating of new item into two part:
283 - create item with key only
284 - insert new item into the set
285 - if inserting is success, calls \p f functor to initialize value-fields of \p val.
287 The functor signature is:
289 void func( value_type& val );
291 where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
292 \p val no any other changes could be made on this set's item by concurrent threads.
293 The user-defined functor is called only if the inserting is success. It may be passed by reference
294 using <tt>boost::ref</tt>
296 template <typename Q, typename Func>
297 bool insert( Q const& val, Func f )
299 scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
300 # ifdef CDS_CXX11_LAMBDA_SUPPORT
301 if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { cds::unref(f)( val.m_Value ); } ))
303 insert_functor<Func> wrapper(f);
304 if ( base_class::insert( *sp, cds::ref(wrapper) ))
313 /// Ensures that the item exists in the set
315 The operation performs inserting or changing data with lock-free manner.
317 If the \p val key not found in the set, then the new item created from \p val
318 is inserted into the set. Otherwise, the functor \p func is called with the item found.
319 The functor \p Func should be a function with signature:
321 void func( bool bNew, value_type& item, const Q& val );
326 void operator()( bool bNew, value_type& item, const Q& val );
331 - \p bNew - \p true if the item has been inserted, \p false otherwise
332 - \p item - item of the set
333 - \p val - argument \p key passed into the \p ensure function
335 The functor may change non-key fields of the \p item; however, \p func must guarantee
336 that during changing no any other modifications could be made on this item by concurrent threads.
338 You may pass \p func argument by reference using <tt>boost::ref</tt>.
340 Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
341 \p second is true if new item has been added or \p false if the item with \p key
342 already is in the set.
344 template <typename Q, typename Func>
345 std::pair<bool, bool> ensure( const Q& val, Func func )
347 scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
348 # ifdef CDS_CXX11_LAMBDA_SUPPORT
349 std::pair<bool, bool> bRes = base_class::ensure( *sp,
350 [&func, &val](bool bNew, leaf_node& node, leaf_node&){ cds::unref(func)( bNew, node.m_Value, val ); });
352 ensure_functor<Q, Func> wrapper( val, func );
353 std::pair<bool, bool> bRes = base_class::ensure( *sp, cds::ref(wrapper));
355 if ( bRes.first && bRes.second )
360 /// Inserts data of type \ref value_type constructed with <tt>std::forward<Args>(args)...</tt>
362 Returns \p true if inserting successful, \p false otherwise.
364 template <typename... Args>
365 bool emplace( Args&&... args )
367 scoped_node_ptr sp( cxx_leaf_node_allocator().New( std::forward<Args>(args)... ));
368 if ( base_class::insert( *sp.get() )) {
375 /// Delete \p key from the set
376 /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_val
378 The item comparator should be able to compare the type \p value_type
381 Return \p true if key is found and deleted, \p false otherwise
383 template <typename Q>
384 bool erase( Q const& key )
386 return base_class::erase( key );
389 /// Deletes the item from the set using \p pred predicate for searching
391 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_val "erase(Q const&)"
392 but \p pred is used for key comparing.
393 \p Less functor has the interface like \p std::less.
394 \p Less must imply the same element order as the comparator used for building the set.
396 template <typename Q, typename Less>
397 bool erase_with( Q const& key, Less pred )
399 return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
402 /// Delete \p key from the set
403 /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_func
405 The function searches an item with key \p key, calls \p f functor
406 and deletes the item. If \p key is not found, the functor is not called.
408 The functor \p Func interface:
411 void operator()(value_type const& val);
414 The functor may be passed by reference using <tt>boost:ref</tt>
416 Since the key of MichaelHashSet's \p value_type is not explicitly specified,
417 template parameter \p Q defines the key type searching in the list.
418 The list item comparator should be able to compare the type \p T of list item
421 Return \p true if key is found and deleted, \p false otherwise
423 template <typename Q, typename Func>
424 bool erase( Q const& key, Func f )
426 # ifdef CDS_CXX11_LAMBDA_SUPPORT
427 return base_class::erase( key, [&f]( leaf_node const& node) { cds::unref(f)( node.m_Value ); } );
429 erase_functor<Func> wrapper(f);
430 return base_class::erase( key, cds::ref(wrapper));
434 /// Deletes the item from the set using \p pred predicate for searching
436 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_func "erase(Q const&, Func)"
437 but \p pred is used for key comparing.
438 \p Less functor has the interface like \p std::less.
439 \p Less must imply the same element order as the comparator used for building the set.
441 template <typename Q, typename Less, typename Func>
442 bool erase_with( Q const& key, Less pred, Func f )
444 # ifdef CDS_CXX11_LAMBDA_SUPPORT
445 return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
446 [&f]( leaf_node const& node) { cds::unref(f)( node.m_Value ); } );
448 erase_functor<Func> wrapper(f);
449 return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(), cds::ref(wrapper));
453 /// Extracts an item with minimal key from the set
455 If the set is not empty, the function returns \p true, \p result contains a pointer to minimum value.
456 If the set is empty, the function returns \p false, \p result is left unchanged.
458 @note Due the concurrent nature of the set, the function extracts <i>nearly</i> minimum key.
459 It means that the function gets leftmost leaf of the tree and tries to unlink it.
460 During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
461 So, the function returns the item with minimum key at the moment of tree traversing.
463 The guarded pointer \p dest prevents deallocation of returned item,
464 see cds::gc::guarded_ptr for explanation.
465 @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
467 bool extract_min( guarded_ptr& result )
469 return base_class::extract_min_( result.guard() );
472 /// Extracts an item with maximal key from the set
474 If the set is not empty, the function returns \p true, \p result contains a pointer to maximal value.
475 If the set is empty, the function returns \p false, \p result is left unchanged.
477 @note Due the concurrent nature of the set, the function extracts <i>nearly</i> maximal key.
478 It means that the function gets rightmost leaf of the tree and tries to unlink it.
479 During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
480 So, the function returns the item with maximum key at the moment of tree traversing.
482 The guarded pointer \p dest prevents deallocation of returned item,
483 see cds::gc::guarded_ptr for explanation.
484 @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
486 bool extract_max( guarded_ptr& result )
488 return base_class::extract_max_( result.guard() );
491 /// Extracts an item from the tree
492 /** \anchor cds_nonintrusive_EllenBinTreeSet_extract
493 The function searches an item with key equal to \p key in the tree,
494 unlinks it, and returns pointer to an item found in \p result parameter.
495 If the item is not found the function returns \p false.
497 The guarded pointer \p dest prevents deallocation of returned item,
498 see cds::gc::guarded_ptr for explanation.
499 @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
501 template <typename Q>
502 bool extract( guarded_ptr& result, Q const& key )
504 return base_class::extract_( result.guard(), key );
507 /// Extracts an item from the set using \p pred for searching
509 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_extract "extract(guarded_ptr& dest, Q const&)"
510 but \p pred is used for key compare.
511 \p Less has the interface like \p std::less.
512 \p pred must imply the same element order as the comparator used for building the set.
514 template <typename Q, typename Less>
515 bool extract_with( guarded_ptr& result, Q const& key, Less pred )
517 return base_class::extract_with_( result.guard(), key,
518 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
521 /// Find the key \p val
523 @anchor cds_nonintrusive_EllenBinTreeSet_find_func
525 The function searches the item with key equal to \p val and calls the functor \p f for item found.
526 The interface of \p Func functor is:
529 void operator()( value_type& item, Q& val );
532 where \p item is the item found, \p val is the <tt>find</tt> function argument.
534 You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
536 The functor may change non-key fields of \p item. Note that the functor is only guarantee
537 that \p item cannot be disposed during functor is executing.
538 The functor does not serialize simultaneous access to the set's \p item. If such access is
539 possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
541 The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
542 can modify both arguments.
544 Note the hash functor specified for class \p Traits template parameter
545 should accept a parameter of type \p Q that may be not the same as \p value_type.
547 The function returns \p true if \p val is found, \p false otherwise.
549 template <typename Q, typename Func>
550 bool find( Q& val, Func f )
552 # ifdef CDS_CXX11_LAMBDA_SUPPORT
553 return base_class::find( val, [&f]( leaf_node& node, Q& v ) { cds::unref(f)( node.m_Value, v ); });
555 find_functor<Func> wrapper(f);
556 return base_class::find( val, cds::ref(wrapper));
560 /// Finds the key \p val using \p pred predicate for searching
562 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_func "find(Q&, Func)"
563 but \p pred is used for key comparing.
564 \p Less functor has the interface like \p std::less.
565 \p Less must imply the same element order as the comparator used for building the set.
567 template <typename Q, typename Less, typename Func>
568 bool find_with( Q& val, Less pred, Func f )
570 # ifdef CDS_CXX11_LAMBDA_SUPPORT
571 return base_class::find_with( val, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
572 [&f]( leaf_node& node, Q& v ) { cds::unref(f)( node.m_Value, v ); } );
574 find_functor<Func> wrapper(f);
575 return base_class::find_with( val, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
580 /// Find the key \p val
581 /** @anchor cds_nonintrusive_EllenBinTreeSet_find_cfunc
583 The function searches the item with key equal to \p val and calls the functor \p f for item found.
584 The interface of \p Func functor is:
587 void operator()( value_type& item, Q const& val );
590 where \p item is the item found, \p val is the <tt>find</tt> function argument.
592 You may pass \p f argument by reference using <tt>boost::ref</tt> or cds::ref.
594 The functor may change non-key fields of \p item. Note that the functor is only guarantee
595 that \p item cannot be disposed during functor is executing.
596 The functor does not serialize simultaneous access to the set's \p item. If such access is
597 possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
599 Note the hash functor specified for class \p Traits template parameter
600 should accept a parameter of type \p Q that may be not the same as \p value_type.
602 The function returns \p true if \p val is found, \p false otherwise.
604 template <typename Q, typename Func>
605 bool find( Q const& val, Func f )
607 # ifdef CDS_CXX11_LAMBDA_SUPPORT
608 return base_class::find( val, [&f]( leaf_node& node, Q const& v ) { cds::unref(f)( node.m_Value, v ); });
610 find_functor<Func> wrapper(f);
611 return base_class::find( val, cds::ref(wrapper));
615 /// Finds the key \p val using \p pred predicate for searching
617 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_cfunc "find(Q const&, Func)"
618 but \p pred is used for key comparing.
619 \p Less functor has the interface like \p std::less.
620 \p Less must imply the same element order as the comparator used for building the set.
622 template <typename Q, typename Less, typename Func>
623 bool find_with( Q const& val, Less pred, Func f )
625 # ifdef CDS_CXX11_LAMBDA_SUPPORT
626 return base_class::find_with( val, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
627 [&f]( leaf_node& node, Q const& v ) { cds::unref(f)( node.m_Value, v ); } );
629 find_functor<Func> wrapper(f);
630 return base_class::find_with( val, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
635 /// Find the key \p val
636 /** @anchor cds_nonintrusive_EllenBinTreeSet_find_val
638 The function searches the item with key equal to \p val
639 and returns \p true if it is found, and \p false otherwise.
641 Note the hash functor specified for class \p Traits template parameter
642 should accept a parameter of type \p Q that may be not the same as \ref value_type.
644 template <typename Q>
645 bool find( Q const & val )
647 return base_class::find( val );
650 /// Finds the key \p val using \p pred predicate for searching
652 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_val "find(Q const&)"
653 but \p pred is used for key comparing.
654 \p Less functor has the interface like \p std::less.
655 \p Less must imply the same element order as the comparator used for building the set.
657 template <typename Q, typename Less>
658 bool find_with( Q const& val, Less pred )
660 return base_class::find_with( val, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
663 /// Finds \p key and returns the item found
664 /** @anchor cds_nonintrusive_EllenBinTreeSet_get
665 The function searches the item with key equal to \p key and returns the item found in \p result parameter.
666 The function returns \p true if \p key is found, \p false otherwise.
668 The guarded pointer \p dest prevents deallocation of returned item,
669 see cds::gc::guarded_ptr for explanation.
670 @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
672 template <typename Q>
673 bool get( guarded_ptr& result, Q const& key )
675 return base_class::get_( result.guard(), key );
678 /// Finds \p key with predicate \p pred and returns the item found
680 The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_get "get(guarded_ptr&, Q const&)"
681 but \p pred is used for key comparing.
682 \p Less functor has the interface like \p std::less.
683 \p pred must imply the same element order as the comparator used for building the set.
685 template <typename Q, typename Less>
686 bool get_with( guarded_ptr& result, Q const& key, Less pred )
688 return base_class::get_with_( result.guard(), key,
689 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() );
692 /// Clears the set (non-atomic)
694 The function unlink all items from the tree.
695 The function is not atomic, thus, in multi-threaded environment with parallel insertions
699 assert( set.empty() );
701 the assertion could be raised.
703 For each leaf the \ref disposer will be called after unlinking.
710 /// Checks if the set is empty
713 return base_class::empty();
716 /// Returns item count in the set
718 Only leaf nodes containing user data are counted.
720 The value returned depends on item counter type provided by \p Traits template parameter.
721 If it is atomicity::empty_item_counter this function always returns 0.
722 Therefore, the function is not suitable for checking the tree emptiness, use \ref empty
723 member function for this purpose.
727 return base_class::size();
730 /// Returns const reference to internal statistics
731 stat const& statistics() const
733 return base_class::statistics();
736 /// Checks internal consistency (not atomic, not thread-safe)
738 The debugging function to check internal consistency of the tree.
740 bool check_consistency() const
742 return base_class::check_consistency();
746 }} // namespace cds::container
748 #endif // #ifndef __CDS_CONTAINER_ELLEN_BINTREE_SET_IMPL_H