cds/container/ellen_bintree_set_rcu.h

   1 //$$CDS-header$$
   2
   3 #ifndef __CDS_CONTAINER_ELLEN_BINTREE_SET_RCU_H
   4 #define __CDS_CONTAINER_ELLEN_BINTREE_SET_RCU_H
   5
   6 #include <cds/container/details/ellen_bintree_base.h>
   7 #include <cds/intrusive/ellen_bintree_rcu.h>
   8
   9 namespace cds { namespace container {
  10
  11     /// Set based on Ellen's et al binary search tree (RCU specialization)
  12     /** @ingroup cds_nonintrusive_set
  13         @ingroup cds_nonintrusive_tree
  14         @anchor cds_container_EllenBinTreeSet_rcu
  15
  16         Source:
  17             - [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"
  18
  19         %EllenBinTreeSet is an unbalanced leaf-oriented binary search tree that implements the <i>set</i>
  20         abstract data type. Nodes maintains child pointers but not parent pointers.
  21         Every internal node has exactly two children, and all data of type \p T currently in
  22         the tree are stored in the leaves. Internal nodes of the tree are used to direct \p find
  23         operation along the path to the correct leaf. The keys (of \p Key type) stored in internal nodes
  24         may or may not be in the set. \p Key type is a subset of \p T type.
  25         There should be exactly defined a key extracting functor for converting object of type \p T to
  26         object of type \p Key.
  27
  28         Due to \p extract_min and \p extract_max member functions the \p %EllenBinTreeSet can act as
  29         a <i>priority queue</i>. In this case you should provide unique compound key, for example,
  30         the priority value plus some uniformly distributed random value.
  31
  32         @warning Recall the tree is <b>unbalanced</b>. The complexity of operations is <tt>O(log N)</tt>
  33         for uniformly distributed random keys, but in worst case the complexity is <tt>O(N)</tt>.
  34
  35         @note In the current implementation we do not use helping technique described in original paper.
  36         So, the current implementation is near to fine-grained lock-based tree.
  37         Helping will be implemented in future release
  38
  39         <b>Template arguments</b> :
  40         - \p RCU - one of \ref cds_urcu_gc "RCU type"
  41         - \p Key - key type, a subset of \p T
  42         - \p T - type to be stored in tree's leaf nodes.
  43         - \p Traits - set traits, default is \p ellen_bintree::traits.
  44             It is possible to declare option-based tree with \p ellen_bintree::make_set_traits metafunction
  45             instead of \p Traits template argument.
  46
  47         @note Before including <tt><cds/container/ellen_bintree_set_rcu.h></tt> you should include appropriate RCU header file,
  48         see \ref cds_urcu_gc "RCU type" for list of existing RCU class and corresponding header files.
  49
  50         @anchor cds_container_EllenBinTreeSet_rcu_less
  51         <b>Predicate requirements</b>
  52
  53         opt::less, opt::compare and other predicates using with member fuctions should accept at least parameters
  54         of type \p T and \p Key in any combination.
  55         For example, for \p Foo struct with \p std::string key field the appropiate \p less functor is:
  56         \code
  57         struct Foo
  58         {
  59             std::string m_strKey;
  60             ...
  61         };
  62
  63         struct less {
  64             bool operator()( Foo const& v1, Foo const& v2 ) const
  65             { return v1.m_strKey < v2.m_strKey ; }
  66
  67             bool operator()( Foo const& v, std::string const& s ) const
  68             { return v.m_strKey < s ; }
  69
  70             bool operator()( std::string const& s, Foo const& v ) const
  71             { return s < v.m_strKey ; }
  72
  73             // Support comparing std::string and char const *
  74             bool operator()( std::string const& s, char const * p ) const
  75             { return s.compare(p) < 0 ; }
  76
  77             bool operator()( Foo const& v, char const * p ) const
  78             { return v.m_strKey.compare(p) < 0 ; }
  79
  80             bool operator()( char const * p, std::string const& s ) const
  81             { return s.compare(p) > 0; }
  82
  83             bool operator()( char const * p, Foo const& v ) const
  84             { return v.m_strKey.compare(p) > 0; }
  85         };
  86         \endcode
  87
  88     */
  89     template <
  90         class RCU,
  91         typename Key,
  92         typename T,
  93 #ifdef CDS_DOXYGEN_INVOKED
  94         class Traits = ellen_bintree::traits
  95 #else
  96         class Traits
  97 #endif
  98     >
  99     class EllenBinTreeSet< cds::urcu::gc<RCU>, Key, T, Traits >
 100 #ifdef CDS_DOXYGEN_INVOKED
 101         : public cds::intrusive::EllenBinTree< cds::urcu::gc<RCU>, Key, T, Traits >
 102 #else
 103         : public ellen_bintree::details::make_ellen_bintree_set< cds::urcu::gc<RCU>, Key, T, Traits >::type
 104 #endif
 105     {
 106         //@cond
 107         typedef ellen_bintree::details::make_ellen_bintree_set< cds::urcu::gc<RCU>, Key, T, Traits > maker;
 108         typedef typename maker::type base_class;
 109         //@endcond
 110
 111     public:
 112         typedef cds::urcu::gc<RCU>  gc;   ///< RCU Garbage collector
 113         typedef Key     key_type;   ///< type of a key stored in internal nodes; key is a part of \p value_type
 114         typedef T       value_type; ///< type of value stored in the binary tree
 115         typedef Traits  traits;     ///< Traits template parameter
 116
 117 #   ifdef CDS_DOXYGEN_INVOKED
 118         typedef implementation_defined key_comparator;    ///< key compare functor based on \p Traits::compare and \p Traits::less
 119 #   else
 120         typedef typename maker::intrusive_traits::compare   key_comparator;
 121 #   endif
 122         typedef typename base_class::item_counter           item_counter;       ///< Item counting policy
 123         typedef typename base_class::memory_model           memory_model;       ///< Memory ordering, see \p cds::opt::memory_model
 124         typedef typename base_class::stat                   stat;               ///< internal statistics type
 125         typedef typename base_class::rcu_check_deadlock     rcu_check_deadlock; ///< Deadlock checking policy
 126         typedef typename traits::key_extractor              key_extractor;      ///< key extracting functor
 127
 128         typedef typename traits::allocator                  allocator_type;     ///< Allocator for leaf nodes
 129         typedef typename base_class::node_allocator         node_allocator;     ///< Internal node allocator
 130         typedef typename base_class::update_desc_allocator  update_desc_allocator; ///< Update descriptor allocator
 131
 132         static CDS_CONSTEXPR const bool c_bExtractLockExternal = base_class::c_bExtractLockExternal; ///< Group of \p extract_xxx functions do not require external locking
 133
 134     protected:
 135         //@cond
 136         typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
 137         typedef typename base_class::value_type         leaf_node;
 138         typedef typename base_class::internal_node      internal_node;
 139         typedef std::unique_ptr< leaf_node, typename maker::intrusive_traits::disposer >    scoped_node_ptr;
 140         //@endcond
 141
 142     public:
 143         typedef typename gc::scoped_lock    rcu_lock;  ///< RCU scoped lock
 144
 145         /// pointer to extracted node
 146         typedef cds::urcu::exempt_ptr< gc, leaf_node, value_type, typename maker::intrusive_traits::disposer,
 147             cds::urcu::details::conventional_exempt_member_cast<leaf_node, value_type>
 148         > exempt_ptr;
 149
 150     public:
 151         /// Default constructor
 152         EllenBinTreeSet()
 153             : base_class()
 154         {}
 155
 156         /// Clears the set
 157         ~EllenBinTreeSet()
 158         {}
 159
 160         /// Inserts new node
 161         /**
 162             The function creates a node with copy of \p val value
 163             and then inserts the node created into the set.
 164
 165             The type \p Q should contain at least the complete key for the node.
 166             The object of \ref value_type should be constructible from a value of type \p Q.
 167             In trivial case, \p Q is equal to \ref value_type.
 168
 169             RCU \p synchronize() method can be called. RCU should not be locked.
 170
 171             Returns \p true if \p val is inserted into the set, \p false otherwise.
 172         */
 173         template <typename Q>
 174         bool insert( Q const& val )
 175         {
 176             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 177             if ( base_class::insert( *sp.get() )) {
 178                 sp.release();
 179                 return true;
 180             }
 181             return false;
 182         }
 183
 184         /// Inserts new node
 185         /**
 186             The function allows to split creating of new item into two part:
 187             - create item with key only
 188             - insert new item into the set
 189             - if inserting is success, calls  \p f functor to initialize value-fields of \p val.
 190
 191             The functor signature is:
 192             \code
 193                 void func( value_type& val );
 194             \endcode
 195             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
 196             \p val no any other changes could be made on this set's item by concurrent threads.
 197             The user-defined functor is called only if the inserting is success.
 198
 199             RCU \p synchronize() can be called. RCU should not be locked.
 200         */
 201         template <typename Q, typename Func>
 202         bool insert( Q const& val, Func f )
 203         {
 204             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 205             if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { f( val.m_Value ); } )) {
 206                 sp.release();
 207                 return true;
 208             }
 209             return false;
 210         }
 211
 212         /// Ensures that the item exists in the set
 213         /**
 214             The operation performs inserting or changing data with lock-free manner.
 215
 216             If the \p val key not found in the set, then the new item created from \p val
 217             is inserted into the set. Otherwise, the functor \p func is called with the item found.
 218             The functor \p Func should be a function with signature:
 219             \code
 220                 void func( bool bNew, value_type& item, const Q& val );
 221             \endcode
 222             or a functor:
 223             \code
 224                 struct my_functor {
 225                     void operator()( bool bNew, value_type& item, const Q& val );
 226                 };
 227             \endcode
 228
 229             with arguments:
 230             - \p bNew - \p true if the item has been inserted, \p false otherwise
 231             - \p item - item of the set
 232             - \p val - argument \p key passed into the \p ensure function
 233
 234             The functor may change non-key fields of the \p item; however, \p func must guarantee
 235             that during changing no any other modifications could be made on this item by concurrent threads.
 236
 237             RCU \p synchronize() can be called. RCU should not be locked.
 238
 239             Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
 240             \p second is true if new item has been added or \p false if the item with \p key
 241             already is in the set.
 242
 243             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
 244         */
 245         template <typename Q, typename Func>
 246         std::pair<bool, bool> ensure( const Q& val, Func func )
 247         {
 248             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 249             std::pair<bool, bool> bRes = base_class::ensure( *sp,
 250                 [&func, &val](bool bNew, leaf_node& node, leaf_node&){ func( bNew, node.m_Value, val ); });
 251             if ( bRes.first && bRes.second )
 252                 sp.release();
 253             return bRes;
 254         }
 255
 256         /// Inserts data of type \p value_type created in-place from \p args
 257         /**
 258             Returns \p true if inserting successful, \p false otherwise.
 259
 260             RCU \p synchronize method can be called. RCU should not be locked.
 261         */
 262         template <typename... Args>
 263         bool emplace( Args&&... args )
 264         {
 265             scoped_node_ptr sp( cxx_leaf_node_allocator().New( std::forward<Args>(args)... ));
 266             if ( base_class::insert( *sp.get() )) {
 267                 sp.release();
 268                 return true;
 269             }
 270             return false;
 271         }
 272
 273         /// Delete \p key from the set
 274         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_erase_val
 275
 276             The item comparator should be able to compare the type \p value_type
 277             and the type \p Q.
 278
 279             RCU \p synchronize method can be called. RCU should not be locked.
 280
 281             Return \p true if key is found and deleted, \p false otherwise
 282         */
 283         template <typename Q>
 284         bool erase( Q const& key )
 285         {
 286             return base_class::erase( key );
 287         }
 288
 289         /// Deletes the item from the set using \p pred predicate for searching
 290         /**
 291             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_erase_val "erase(Q const&)"
 292             but \p pred is used for key comparing.
 293             \p Less functor has the interface like \p std::less.
 294             \p Less must imply the same element order as the comparator used for building the set.
 295         */
 296         template <typename Q, typename Less>
 297         bool erase_with( Q const& key, Less pred )
 298         {
 299             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 300         }
 301
 302         /// Delete \p key from the set
 303         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_erase_func
 304
 305             The function searches an item with key \p key, calls \p f functor
 306             and deletes the item. If \p key is not found, the functor is not called.
 307
 308             The functor \p Func interface:
 309             \code
 310             struct extractor {
 311                 void operator()(value_type const& val);
 312             };
 313             \endcode
 314
 315             Since the key of MichaelHashSet's \p value_type is not explicitly specified,
 316             template parameter \p Q defines the key type searching in the list.
 317             The list item comparator should be able to compare the type \p T of list item
 318             and the type \p Q.
 319
 320             RCU \p synchronize method can be called. RCU should not be locked.
 321
 322             Return \p true if key is found and deleted, \p false otherwise
 323
 324             See also: \ref erase
 325         */
 326         template <typename Q, typename Func>
 327         bool erase( Q const& key, Func f )
 328         {
 329             return base_class::erase( key, [&f]( leaf_node const& node) { f( node.m_Value ); } );
 330         }
 331
 332         /// Deletes the item from the set using \p pred predicate for searching
 333         /**
 334             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_erase_func "erase(Q const&, Func)"
 335             but \p pred is used for key comparing.
 336             \p Less functor has the interface like \p std::less.
 337             \p Less must imply the same element order as the comparator used for building the set.
 338         */
 339         template <typename Q, typename Less, typename Func>
 340         bool erase_with( Q const& key, Less pred, Func f )
 341         {
 342             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 343                 [&f]( leaf_node const& node) { f( node.m_Value ); } );
 344         }
 345
 346         /// Extracts an item with minimal key from the set
 347         /**
 348             If the set is not empty, the function returns \p true, \p result contains a pointer to value.
 349             If the set is empty, the function returns \p false, \p result is left unchanged.
 350
 351             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> minimum key.
 352             It means that the function gets leftmost leaf of the tree and tries to unlink it.
 353             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
 354             So, the function returns the item with minimum key at the moment of tree traversing.
 355
 356             RCU \p synchronize method can be called. RCU should NOT be locked.
 357             The function does not free the item.
 358             The deallocator will be implicitly invoked when \p result object is destroyed or when
 359             <tt>result.release()</tt> is called, see cds::urcu::exempt_ptr for explanation.
 360             @note Before reusing \p result object you should call its \p release() method.
 361         */
 362         bool extract_min( exempt_ptr& result )
 363         {
 364             return base_class::extract_min_( result );
 365         }
 366
 367         /// Extracts an item with maximal key from the set
 368         /**
 369             If the set is not empty, the function returns \p true, \p result contains a pointer to extracted item.
 370             If the set is empty, the function returns \p false, \p result is left unchanged.
 371
 372             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> maximal key.
 373             It means that the function gets rightmost leaf of the tree and tries to unlink it.
 374             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
 375             So, the function returns the item with maximum key at the moment of tree traversing.
 376
 377             RCU \p synchronize method can be called. RCU should NOT be locked.
 378             The function does not free the item.
 379             The deallocator will be implicitly invoked when \p result object is destroyed or when
 380             <tt>result.release()</tt> is called, see cds::urcu::exempt_ptr for explanation.
 381             @note Before reusing \p result object you should call its \p release() method.
 382         */
 383         bool extract_max( exempt_ptr& result )
 384         {
 385             return base_class::extract_max_( result );
 386         }
 387
 388         /// Extracts an item from the set
 389         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_extract
 390             The function searches an item with key equal to \p key in the tree,
 391             unlinks it, and returns pointer to an item found in \p result parameter.
 392             If \p key is not found the function returns \p false.
 393
 394             RCU \p synchronize method can be called. RCU should NOT be locked.
 395             The function does not destroy the item found.
 396             The dealloctor will be implicitly invoked when \p result object is destroyed or when
 397             <tt>result.release()</tt> is called, see cds::urcu::exempt_ptr for explanation.
 398             @note Before reusing \p result object you should call its \p release() method.
 399         */
 400         template <typename Q>
 401         bool extract( exempt_ptr& result, Q const& key )
 402         {
 403             return base_class::extract_( result, key, typename base_class::node_compare());
 404         }
 405
 406         /// Extracts an item from the set using \p pred for searching
 407         /**
 408             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_extract "extract(exempt_ptr&, Q const&)"
 409             but \p pred is used for key compare.
 410             \p Less has the interface like \p std::less and should meet \ref cds_container_EllenBinTreeSet_rcu_less
 411             "predicate requirements".
 412             \p pred must imply the same element order as the comparator used for building the set.
 413         */
 414         template <typename Q, typename Less>
 415         bool extract_with( exempt_ptr& result,  Q const& val, Less pred )
 416         {
 417             return base_class::extract_with_( result, val,
 418                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() );
 419         }
 420
 421         /// Find the key \p key
 422         /**
 423             @anchor cds_nonintrusive_EllenBinTreeSet_rcu_find_func
 424
 425             The function searches the item with key equal to \p key and calls the functor \p f for item found.
 426             The interface of \p Func functor is:
 427             \code
 428             struct functor {
 429                 void operator()( value_type& item, Q& key );
 430             };
 431             \endcode
 432             where \p item is the item found, \p key is the <tt>find</tt> function argument.
 433
 434             The functor may change non-key fields of \p item. Note that the functor is only guarantee
 435             that \p item cannot be disposed during functor is executing.
 436             The functor does not serialize simultaneous access to the set's \p item. If such access is
 437             possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
 438
 439             The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
 440             can modify both arguments.
 441
 442             Note the hash functor specified for class \p Traits template parameter
 443             should accept a parameter of type \p Q that may be not the same as \p value_type.
 444
 445             The function applies RCU lock internally.
 446
 447             The function returns \p true if \p key is found, \p false otherwise.
 448         */
 449         template <typename Q, typename Func>
 450         bool find( Q& key, Func f ) const
 451         {
 452             return base_class::find( key, [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); });
 453         }
 454         //@cond
 455         template <typename Q, typename Func>
 456         bool find( Q const& key, Func f ) const
 457         {
 458             return base_class::find( key, [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 459         }
 460         //@endcond
 461
 462         /// Finds the key \p key using \p pred predicate for searching
 463         /**
 464             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_find_func "find(Q&, Func)"
 465             but \p pred is used for key comparing.
 466             \p Less functor has the interface like \p std::less.
 467             \p Less must imply the same element order as the comparator used for building the set.
 468         */
 469         template <typename Q, typename Less, typename Func>
 470         bool find_with( Q& key, Less pred, Func f ) const
 471         {
 472             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 473                 [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); } );
 474         }
 475         //@cond
 476         template <typename Q, typename Less, typename Func>
 477         bool find_with( Q const& key, Less pred, Func f ) const
 478         {
 479             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 480                                           [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 481         }
 482         //@endcond
 483
 484         /// Find the key \p key
 485         /** @anchor cds_nonintrusive_EllenBinTreeSet_rcu_find_val
 486
 487             The function searches the item with key equal to \p key
 488             and returns \p true if it is found, and \p false otherwise.
 489
 490             Note the hash functor specified for class \p Traits template parameter
 491             should accept a parameter of type \p Q that may be not the same as \ref value_type.
 492
 493             The function applies RCU lock internally.
 494         */
 495         template <typename Q>
 496         bool find( Q const& key ) const
 497         {
 498             return base_class::find( key );
 499         }
 500
 501         /// Finds the key \p key using \p pred predicate for searching
 502         /**
 503             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_find_val "find(Q const&)"
 504             but \p pred is used for key comparing.
 505             \p Less functor has the interface like \p std::less.
 506             \p Less must imply the same element order as the comparator used for building the set.
 507         */
 508         template <typename Q, typename Less>
 509         bool find_with( Q const& key, Less pred ) const
 510         {
 511             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 512         }
 513
 514         /// Finds \p key and return the item found
 515         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_get
 516             The function searches the item with key equal to \p key and returns the pointer to item found.
 517             If \p key is not found it returns \p nullptr.
 518
 519             RCU should be locked before call the function.
 520             Returned pointer is valid while RCU is locked.
 521         */
 522         template <typename Q>
 523         value_type * get( Q const& key ) const
 524         {
 525             leaf_node * pNode = base_class::get( key );
 526             return pNode ? &pNode->m_Value : nullptr;
 527         }
 528
 529         /// Finds \p key with \p pred predicate and return the item found
 530         /**
 531             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_get "get(Q const&)"
 532             but \p pred is used for comparing the keys.
 533
 534             \p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type
 535             and \p Q in any order.
 536             \p pred must imply the same element order as the comparator used for building the set.
 537         */
 538         template <typename Q, typename Less>
 539         value_type * get_with( Q const& key, Less pred ) const
 540         {
 541             leaf_node * pNode = base_class::get_with( key,
 542                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 543             return pNode ? &pNode->m_Value : nullptr;
 544         }
 545
 546         /// Clears the set (non-atomic)
 547         /**
 548             The function unlink all items from the tree.
 549             The function is not atomic, thus, in multi-threaded environment with parallel insertions
 550             this sequence
 551             \code
 552             set.clear();
 553             assert( set.empty() );
 554             \endcode
 555             the assertion could be raised.
 556
 557             For each leaf the \ref disposer will be called after unlinking.
 558
 559             RCU \p synchronize method can be called. RCU should not be locked.
 560         */
 561         void clear()
 562         {
 563             base_class::clear();
 564         }
 565
 566         /// Checks if the set is empty
 567         bool empty() const
 568         {
 569             return base_class::empty();
 570         }
 571
 572         /// Returns item count in the set
 573         /**
 574             Only leaf nodes containing user data are counted.
 575
 576             The value returned depends on item counter type provided by \p Traits template parameter.
 577             If it is \p atomicity::empty_item_counter \p %size() always returns 0.
 578             Therefore, the function is not suitable for checking the tree emptiness, use \p empty()
 579             member function for this purpose.
 580         */
 581         size_t size() const
 582         {
 583             return base_class::size();
 584         }
 585
 586         /// Returns const reference to internal statistics
 587         stat const& statistics() const
 588         {
 589             return base_class::statistics();
 590         }
 591
 592         /// Checks internal consistency (not atomic, not thread-safe)
 593         /**
 594             The debugging function to check internal consistency of the tree.
 595         */
 596         bool check_consistency() const
 597         {
 598             return base_class::check_consistency();
 599         }
 600     };
 601 }}  // namespace cds::container
 602
 603 #endif // #ifndef __CDS_CONTAINER_ELLEN_BINTREE_SET_RCU_H