GCC-7 64bit does not support lock-free wide (128-bit) atomics
[libcds.git] / cds / container / impl / ellen_bintree_set.h
1 /*
2     This file is a part of libcds - Concurrent Data Structures library
3
4     (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2017
5
6     Source code repo: http://github.com/khizmax/libcds/
7     Download: http://sourceforge.net/projects/libcds/files/
8
9     Redistribution and use in source and binary forms, with or without
10     modification, are permitted provided that the following conditions are met:
11
12     * Redistributions of source code must retain the above copyright notice, this
13       list of conditions and the following disclaimer.
14
15     * Redistributions in binary form must reproduce the above copyright notice,
16       this list of conditions and the following disclaimer in the documentation
17       and/or other materials provided with the distribution.
18
19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23     FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24     DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27     OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
32 #define CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
33
34 #include <type_traits>
35 #include <cds/container/details/ellen_bintree_base.h>
36 #include <cds/intrusive/impl/ellen_bintree.h>
37 #include <cds/container/details/guarded_ptr_cast.h>
38
39 namespace cds { namespace container {
40
41     /// Set based on Ellen's et al binary search tree
42     /** @ingroup cds_nonintrusive_set
43         @ingroup cds_nonintrusive_tree
44         @anchor cds_container_EllenBinTreeSet
45
46         Source:
47             - [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"
48
49         %EllenBinTreeSet is an unbalanced leaf-oriented binary search tree that implements the <i>set</i>
50         abstract data type. Nodes maintains child pointers but not parent pointers.
51         Every internal node has exactly two children, and all data of type \p T currently in
52         the tree are stored in the leaves. Internal nodes of the tree are used to direct \p find
53         operation along the path to the correct leaf. The keys (of \p Key type) stored in internal nodes
54         may or may not be in the set. \p Key type is a subset of \p T type.
55         There should be exactly defined a key extracting functor for converting object of type \p T to
56         object of type \p Key.
57
58         Due to \p extract_min and \p extract_max member functions the \p %EllenBinTreeSet can act as
59         a <i>priority queue</i>. In this case you should provide unique compound key, for example,
60         the priority value plus some uniformly distributed random value.
61
62         @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
63         for uniformly distributed random keys, but in the worst case the complexity is <tt>O(N)</tt>.
64
65         @note In the current implementation we do not use helping technique described in the original paper.
66         In Hazard Pointer schema helping is too complicated and does not give any observable benefits.
67         Instead of helping, when a thread encounters a concurrent operation it just spins waiting for
68         the operation done. Such solution allows greatly simplify the implementation of tree.
69
70         <b>Template arguments</b> :
71         - \p GC - safe memory reclamation (i.e. light-weight garbage collector) type, like \p cds::gc::HP, cds::gc::DHP
72         - \p Key - key type, a subset of \p T
73         - \p T - type to be stored in tree's leaf nodes.
74         - \p Traits - set traits, default is \p ellen_bintree::traits
75             It is possible to declare option-based tree with \p ellen_bintree::make_set_traits metafunction
76             instead of \p Traits template argument.
77
78         @note Do not include <tt><cds/container/impl/ellen_bintree_set.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 \p cds::gc::HP
81         - <tt><cds/container/ellen_bintree_set_dhp.h></tt> - for \p cds::gc::DHP
82         - <tt><cds/container/ellen_bintree_set_rcu.h></tt> - for RCU GC
83             (see \ref cds_container_EllenBinTreeSet_rcu "RCU-based EllenBinTreeSet")
84
85         @anchor cds_container_EllenBinTreeSet_less
86         <b>Predicate requirements</b>
87
88         \p Traits::less, \p Traits::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:
91         \code
92         struct Foo
93         {
94             std::string m_strKey;
95             ...
96         };
97
98         struct less {
99             bool operator()( Foo const& v1, Foo const& v2 ) const
100             { return v1.m_strKey < v2.m_strKey ; }
101
102             bool operator()( Foo const& v, std::string const& s ) const
103             { return v.m_strKey < s ; }
104
105             bool operator()( std::string const& s, Foo const& v ) const
106             { return s < v.m_strKey ; }
107
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 ; }
111
112             bool operator()( Foo const& v, char const * p ) const
113             { return v.m_strKey.compare(p) < 0 ; }
114
115             bool operator()( char const * p, std::string const& s ) const
116             { return s.compare(p) > 0; }
117
118             bool operator()( char const * p, Foo const& v ) const
119             { return v.m_strKey.compare(p) > 0; }
120         };
121         \endcode
122     */
123     template <
124         class GC,
125         typename Key,
126         typename T,
127 #ifdef CDS_DOXYGEN_INVOKED
128         class Traits = ellen_bintree::traits
129 #else
130         class Traits
131 #endif
132     >
133     class EllenBinTreeSet
134 #ifdef CDS_DOXYGEN_INVOKED
135         : public cds::intrusive::EllenBinTree< GC, Key, T, Traits >
136 #else
137         : public ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits >::type
138 #endif
139     {
140         //@cond
141         typedef ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits > maker;
142         typedef typename maker::type base_class;
143         //@endcond
144
145     public:
146         typedef GC      gc;         ///< Garbage collector
147         typedef Key     key_type;   ///< type of a key to be stored in internal nodes; key is a part of \p value_type
148         typedef T       value_type; ///< type of value to be stored in the binary tree
149         typedef Traits  traits;    ///< Traits template parameter
150
151 #   ifdef CDS_DOXYGEN_INVOKED
152         typedef implementation_defined key_comparator  ;    ///< key compare functor based on opt::compare and opt::less option setter.
153 #   else
154         typedef typename maker::intrusive_traits::compare   key_comparator;
155 #   endif
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 traits::key_extractor              key_extractor; ///< key extracting functor
160         typedef typename traits::back_off                   back_off;      ///< Back-off strategy
161
162         typedef typename traits::allocator                  allocator_type;   ///< Allocator for leaf nodes
163         typedef typename base_class::node_allocator         node_allocator;   ///< Internal node allocator
164         typedef typename base_class::update_desc_allocator  update_desc_allocator; ///< Update descriptor allocator
165
166     protected:
167         //@cond
168         typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
169         typedef typename base_class::value_type         leaf_node;
170         typedef typename base_class::internal_node      internal_node;
171
172         typedef std::unique_ptr< leaf_node, typename maker::leaf_deallocator > scoped_node_ptr;
173         //@endcond
174
175     public:
176         /// Guarded pointer
177         typedef typename gc::template guarded_ptr< leaf_node, value_type, details::guarded_ptr_cast_set<leaf_node, value_type> > guarded_ptr;
178
179     public:
180         /// Default constructor
181         EllenBinTreeSet()
182             : base_class()
183         {}
184
185         /// Clears the set
186         ~EllenBinTreeSet()
187         {}
188
189         /// Inserts new node
190         /**
191             The function creates a node with copy of \p val value
192             and then inserts the node created into the set.
193
194             The type \p Q should contain at least the complete key for the node.
195             The object of \ref value_type should be constructible from a value of type \p Q.
196             In trivial case, \p Q is equal to \ref value_type.
197
198             Returns \p true if \p val is inserted into the set, \p false otherwise.
199         */
200         template <typename Q>
201         bool insert( Q const& val )
202         {
203             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
204             if ( base_class::insert( *sp.get())) {
205                 sp.release();
206                 return true;
207             }
208             return false;
209         }
210
211         /// Inserts new node
212         /**
213             The function allows to split creating of new item into two part:
214             - create item with key only
215             - insert new item into the set
216             - if inserting is success, calls  \p f functor to initialize value-fields of \p val.
217
218             The functor signature is:
219             \code
220                 void func( value_type& val );
221             \endcode
222             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
223             \p val no any other changes could be made on this set's item by concurrent threads.
224             The user-defined functor is called only if the inserting is success.
225         */
226         template <typename Q, typename Func>
227         bool insert( Q const& val, Func f )
228         {
229             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
230             if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { f( val.m_Value ); } )) {
231                 sp.release();
232                 return true;
233             }
234             return false;
235         }
236
237         /// Updates the node
238         /**
239             The operation performs inserting or changing data with lock-free manner.
240
241             If the item \p val is not found in the set, then \p val is inserted into the set
242             iff \p bAllowInsert is \p true.
243             Otherwise, the functor \p func is called with item found.
244             The functor \p func signature is:
245             \code
246                 struct my_functor {
247                     void operator()( bool bNew, value_type& item, const Q& val );
248                 };
249             \endcode
250             with arguments:
251             with arguments:
252             - \p bNew - \p true if the item has been inserted, \p false otherwise
253             - \p item - item of the set
254             - \p val - argument \p key passed into the \p %update() function
255
256             The functor can change non-key fields of the \p item; however, \p func must guarantee
257             that during changing no any other modifications could be made on this item by concurrent threads.
258
259             Returns std::pair<bool, bool> where \p first is \p true if operation is successful,
260             i.e. the node has been inserted or updated,
261             \p second is \p true if new item has been added or \p false if the item with \p key
262             already exists.
263
264             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
265         */
266         template <typename Q, typename Func>
267         std::pair<bool, bool> update( const Q& val, Func func, bool bAllowInsert = true )
268         {
269             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
270             std::pair<bool, bool> bRes = base_class::update( *sp,
271                 [&func, &val](bool bNew, leaf_node& node, leaf_node&){ func( bNew, node.m_Value, val ); },
272                 bAllowInsert );
273             if ( bRes.first && bRes.second )
274                 sp.release();
275             return bRes;
276         }
277         //@cond
278         template <typename Q, typename Func>
279         CDS_DEPRECATED("ensure() is deprecated, use update()")
280         std::pair<bool, bool> ensure( const Q& val, Func func )
281         {
282             return update( val, func, true );
283         }
284         //@endcond
285
286         /// Inserts data of type \p value_type created in-place from \p args
287         /**
288             Returns \p true if inserting successful, \p false otherwise.
289         */
290         template <typename... Args>
291         bool emplace( Args&&... args )
292         {
293             scoped_node_ptr sp( cxx_leaf_node_allocator().MoveNew( std::forward<Args>(args)... ));
294             if ( base_class::insert( *sp.get())) {
295                 sp.release();
296                 return true;
297             }
298             return false;
299         }
300
301         /// Delete \p key from the set
302         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_val
303
304             The item comparator should be able to compare the type \p value_type
305             and the type \p Q.
306
307             Return \p true if key is found and deleted, \p false otherwise
308         */
309         template <typename Q>
310         bool erase( Q const& key )
311         {
312             return base_class::erase( key );
313         }
314
315         /// Deletes the item from the set using \p pred predicate for searching
316         /**
317             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_val "erase(Q const&)"
318             but \p pred is used for key comparing.
319             \p Less functor has the interface like \p std::less.
320             \p Less must imply the same element order as the comparator used for building the set.
321         */
322         template <typename Q, typename Less>
323         bool erase_with( Q const& key, Less pred )
324         {
325             CDS_UNUSED( pred );
326             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
327         }
328
329         /// Delete \p key from the set
330         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_func
331
332             The function searches an item with key \p key, calls \p f functor
333             and deletes the item. If \p key is not found, the functor is not called.
334
335             The functor \p Func interface:
336             \code
337             struct extractor {
338                 void operator()(value_type const& val);
339             };
340             \endcode
341
342             Since the key of MichaelHashSet's \p value_type is not explicitly specified,
343             template parameter \p Q defines the key type searching in the list.
344             The list item comparator should be able to compare the type \p T of list item
345             and the type \p Q.
346
347             Return \p true if key is found and deleted, \p false otherwise
348         */
349         template <typename Q, typename Func>
350         bool erase( Q const& key, Func f )
351         {
352             return base_class::erase( key, [&f]( leaf_node const& node) { f( node.m_Value ); } );
353         }
354
355         /// Deletes the item from the set using \p pred predicate for searching
356         /**
357             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_func "erase(Q const&, Func)"
358             but \p pred is used for key comparing.
359             \p Less functor has the interface like \p std::less.
360             \p Less must imply the same element order as the comparator used for building the set.
361         */
362         template <typename Q, typename Less, typename Func>
363         bool erase_with( Q const& key, Less pred, Func f )
364         {
365             CDS_UNUSED( pred );
366             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
367                 [&f]( leaf_node const& node) { f( node.m_Value ); } );
368         }
369
370         /// Extracts an item with minimal key from the set
371         /**
372             If the set is not empty, the function returns a guarded pointer to minimum value.
373             If the set is empty, the function returns an empty \p guarded_ptr.
374
375             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> minimum key.
376             It means that the function gets leftmost leaf of the tree and tries to unlink it.
377             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
378             So, the function returns the item with minimum key at the moment of tree traversing.
379
380             The guarded pointer prevents deallocation of returned item,
381             see \p cds::gc::guarded_ptr for explanation.
382             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
383         */
384         guarded_ptr extract_min()
385         {
386             return guarded_ptr( base_class::extract_min_());
387         }
388
389         /// Extracts an item with maximal key from the set
390         /**
391             If the set is not empty, the function returns a guarded pointer to maximal value.
392             If the set is empty, the function returns an empty \p guarded_ptr.
393
394             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> maximal key.
395             It means that the function gets rightmost leaf of the tree and tries to unlink it.
396             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
397             So, the function returns the item with maximum key at the moment of tree traversing.
398
399             The guarded pointer prevents deallocation of returned item,
400             see \p cds::gc::guarded_ptr for explanation.
401             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
402         */
403         guarded_ptr extract_max()
404         {
405             return guarded_ptr( base_class::extract_max_());
406         }
407
408         /// Extracts an item from the tree
409         /** \anchor cds_nonintrusive_EllenBinTreeSet_extract
410             The function searches an item with key equal to \p key in the tree,
411             unlinks it, and returns an guarded pointer to it.
412             If the item  is not found the function returns an empty \p guarded_ptr.
413
414             The guarded pointer prevents deallocation of returned item,
415             see \p cds::gc::guarded_ptr for explanation.
416             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
417         */
418         template <typename Q>
419         guarded_ptr extract( Q const& key )
420         {
421             return base_class::extract_( key );
422         }
423
424         /// Extracts an item from the set using \p pred for searching
425         /**
426             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_extract "extract(Q const&)"
427             but \p pred is used for key compare.
428             \p Less has the interface like \p std::less.
429             \p pred must imply the same element order as the comparator used for building the set.
430         */
431         template <typename Q, typename Less>
432         guarded_ptr extract_with( Q const& key, Less pred )
433         {
434             CDS_UNUSED( pred );
435             return base_class::extract_with_( key,
436                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
437         }
438
439         /// Find the key \p key
440         /**
441             @anchor cds_nonintrusive_EllenBinTreeSet_find_func
442
443             The function searches the item with key equal to \p key and calls the functor \p f for item found.
444             The interface of \p Func functor is:
445             \code
446             struct functor {
447                 void operator()( value_type& item, Q& key );
448             };
449             \endcode
450             where \p item is the item found, \p key is the <tt>find</tt> function argument.
451
452             The functor may change non-key fields of \p item. Note that the functor is only guarantee
453             that \p item cannot be disposed during functor is executing.
454             The functor does not serialize simultaneous access to the set's \p item. If such access is
455             possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
456
457             The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
458             can modify both arguments.
459
460             Note the hash functor specified for class \p Traits template parameter
461             should accept a parameter of type \p Q that may be not the same as \p value_type.
462
463             The function returns \p true if \p key is found, \p false otherwise.
464         */
465         template <typename Q, typename Func>
466         bool find( Q& key, Func f )
467         {
468             return base_class::find( key, [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); });
469         }
470         //@cond
471         template <typename Q, typename Func>
472         bool find( Q const& key, Func f )
473         {
474             return base_class::find( key, [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
475         }
476         //@endcond
477
478         /// Finds the key \p key using \p pred predicate for searching
479         /**
480             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_find_func "find(Q&, Func)"
481             but \p pred is used for key comparing.
482             \p Less functor has the interface like \p std::less.
483             \p Less must imply the same element order as the comparator used for building the set.
484         */
485         template <typename Q, typename Less, typename Func>
486         bool find_with( Q& key, Less pred, Func f )
487         {
488             CDS_UNUSED( pred );
489             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
490                 [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); } );
491         }
492         //@cond
493         template <typename Q, typename Less, typename Func>
494         bool find_with( Q const& key, Less pred, Func f )
495         {
496             CDS_UNUSED( pred );
497             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
498                                           [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
499         }
500         //@endcond
501
502         /// Checks whether the set contains \p key
503         /**
504             The function searches the item with key equal to \p key
505             and returns \p true if it is found, and \p false otherwise.
506         */
507         template <typename Q>
508         bool contains( Q const & key )
509         {
510             return base_class::contains( key );
511         }
512         //@cond
513         template <typename Q>
514         CDS_DEPRECATED("deprecated, use contains()")
515         bool find( Q const & key )
516         {
517             return contains( key );
518         }
519         //@endcond
520
521         /// Checks whether the set contains \p key using \p pred predicate for searching
522         /**
523             The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
524             \p Less functor has the interface like \p std::less.
525             \p Less must imply the same element order as the comparator used for building the set.
526         */
527         template <typename Q, typename Less>
528         bool contains( Q const& key, Less pred )
529         {
530             CDS_UNUSED( pred );
531             return base_class::contains( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
532         }
533         //@cond
534         template <typename Q, typename Less>
535         CDS_DEPRECATED("deprecated, use contains()")
536         bool find_with( Q const& key, Less pred )
537         {
538             return contains( key, pred );
539         }
540         //@endcond
541
542         /// Finds \p key and returns the item found
543         /** @anchor cds_nonintrusive_EllenBinTreeSet_get
544             The function searches the item with key equal to \p key and returns the item found as an guarded pointer.
545             The function returns \p true if \p key is found, \p false otherwise.
546
547             The guarded pointer prevents deallocation of returned item,
548             see \p cds::gc::guarded_ptr for explanation.
549             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
550         */
551         template <typename Q>
552         guarded_ptr get( Q const& key )
553         {
554             return base_class::get_( key );
555         }
556
557         /// Finds \p key with predicate \p pred and returns the item found
558         /**
559             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_get "get(Q const&)"
560             but \p pred is used for key comparing.
561             \p Less functor has the interface like \p std::less.
562             \p pred must imply the same element order as the comparator used for building the set.
563         */
564         template <typename Q, typename Less>
565         guarded_ptr get_with( Q const& key, Less pred )
566         {
567             CDS_UNUSED(pred);
568             return base_class::get_with_( key,
569                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
570         }
571
572         /// Clears the set (not atomic)
573         /**
574             The function unlink all items from the tree.
575             The function is not atomic, thus, in multi-threaded environment with parallel insertions
576             this sequence
577             \code
578             set.clear();
579             assert( set.empty());
580             \endcode
581             the assertion could be raised.
582
583             For each leaf the \ref disposer will be called after unlinking.
584         */
585         void clear()
586         {
587             base_class::clear();
588         }
589
590         /// Checks if the set is empty
591         bool empty() const
592         {
593             return base_class::empty();
594         }
595
596         /// Returns item count in the set
597         /**
598             Only leaf nodes containing user data are counted.
599
600             The value returned depends on item counter type provided by \p Traits template parameter.
601             If it is \p atomicity::empty_item_counter this function always returns 0.
602
603             The function is not suitable for checking the tree emptiness, use \p empty()
604             member function for this purpose.
605         */
606         size_t size() const
607         {
608             return base_class::size();
609         }
610
611         /// Returns const reference to internal statistics
612         stat const& statistics() const
613         {
614             return base_class::statistics();
615         }
616
617         /// Checks internal consistency (not atomic, not thread-safe)
618         /**
619             The debugging function to check internal consistency of the tree.
620         */
621         bool check_consistency() const
622         {
623             return base_class::check_consistency();
624         }
625     };
626
627 }} // namespace cds::container
628
629 #endif // #ifndef CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H