cds/container/ellen_bintree_set_rcu.h

   1 //$$CDS-header$$
   2
   3 #ifndef CDSLIB_CONTAINER_ELLEN_BINTREE_SET_RCU_H
   4 #define CDSLIB_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         typedef typename traits::back_off                   back_off;           ///< Back-off strategy
 128
 129
 130         typedef typename traits::allocator                  allocator_type;     ///< Allocator for leaf nodes
 131         typedef typename base_class::node_allocator         node_allocator;     ///< Internal node allocator
 132         typedef typename base_class::update_desc_allocator  update_desc_allocator; ///< Update descriptor allocator
 133
 134         static CDS_CONSTEXPR const bool c_bExtractLockExternal = base_class::c_bExtractLockExternal; ///< Group of \p extract_xxx functions do not require external locking
 135
 136     protected:
 137         //@cond
 138         typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
 139         typedef typename base_class::value_type         leaf_node;
 140         typedef typename base_class::internal_node      internal_node;
 141         typedef std::unique_ptr< leaf_node, typename maker::intrusive_traits::disposer >    scoped_node_ptr;
 142         //@endcond
 143
 144     public:
 145         typedef typename gc::scoped_lock    rcu_lock;  ///< RCU scoped lock
 146
 147         /// pointer to extracted node
 148         using exempt_ptr = cds::urcu::exempt_ptr < gc, leaf_node, value_type, typename maker::intrusive_traits::disposer,
 149             cds::urcu::details::conventional_exempt_member_cast < leaf_node, value_type >
 150         >;
 151
 152     public:
 153         /// Default constructor
 154         EllenBinTreeSet()
 155             : base_class()
 156         {}
 157
 158         /// Clears the set
 159         ~EllenBinTreeSet()
 160         {}
 161
 162         /// Inserts new node
 163         /**
 164             The function creates a node with copy of \p val value
 165             and then inserts the node created into the set.
 166
 167             The type \p Q should contain at least the complete key for the node.
 168             The object of \ref value_type should be constructible from a value of type \p Q.
 169             In trivial case, \p Q is equal to \ref value_type.
 170
 171             RCU \p synchronize() method can be called. RCU should not be locked.
 172
 173             Returns \p true if \p val is inserted into the set, \p false otherwise.
 174         */
 175         template <typename Q>
 176         bool insert( Q const& val )
 177         {
 178             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 179             if ( base_class::insert( *sp.get() )) {
 180                 sp.release();
 181                 return true;
 182             }
 183             return false;
 184         }
 185
 186         /// Inserts new node
 187         /**
 188             The function allows to split creating of new item into two part:
 189             - create item with key only
 190             - insert new item into the set
 191             - if inserting is success, calls  \p f functor to initialize value-fields of \p val.
 192
 193             The functor signature is:
 194             \code
 195                 void func( value_type& val );
 196             \endcode
 197             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
 198             \p val no any other changes could be made on this set's item by concurrent threads.
 199             The user-defined functor is called only if the inserting is success.
 200
 201             RCU \p synchronize() can be called. RCU should not be locked.
 202         */
 203         template <typename Q, typename Func>
 204         bool insert( Q const& val, Func f )
 205         {
 206             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 207             if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { f( val.m_Value ); } )) {
 208                 sp.release();
 209                 return true;
 210             }
 211             return false;
 212         }
 213
 214         /// Updates the node
 215         /**
 216             The operation performs inserting or changing data with lock-free manner.
 217
 218             If the item \p val is not found in the set, then \p val is inserted into the set
 219             iff \p bAllowInsert is \p true.
 220             Otherwise, the functor \p func is called with item found.
 221             The functor \p func signature is:
 222             \code
 223                 void func( bool bNew, value_type& item, value_type& val );
 224             \endcode
 225             with arguments:
 226             - \p bNew - \p true if the item has been inserted, \p false otherwise
 227             - \p item - item of the set
 228             - \p val - argument \p val passed into the \p %update() function
 229
 230             The functor can change non-key fields of the \p item; however, \p func must guarantee
 231             that during changing no any other modifications could be made on this item by concurrent threads.
 232
 233             RCU \p synchronize method can be called. RCU should not be locked.
 234
 235             Returns std::pair<bool, bool> where \p first is \p true if operation is successfull,
 236             i.e. the node has been inserted or updated,
 237             \p second is \p true if new item has been added or \p false if the item with \p key
 238             already exists.
 239
 240             @warning See \ref cds_intrusive_item_creating "insert item troubleshooting"
 241         */
 242         template <typename Q, typename Func>
 243         std::pair<bool, bool> update( Q const& val, Func func, bool bAllowInsert = true )
 244         {
 245             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
 246             std::pair<bool, bool> bRes = base_class::update( *sp,
 247                 [&func, &val](bool bNew, leaf_node& node, leaf_node&){ func( bNew, node.m_Value, val ); },
 248                 bAllowInsert );
 249             if ( bRes.first && bRes.second )
 250                 sp.release();
 251             return bRes;
 252         }
 253         //@cond
 254         template <typename Q, typename Func>
 255         CDS_DEPRECATED("ensure() is deprecated, use update()")
 256         std::pair<bool, bool> ensure( const Q& val, Func func )
 257         {
 258             return update( val, func, true );
 259         }
 260         //@endcond
 261
 262         /// Inserts data of type \p value_type created in-place from \p args
 263         /**
 264             Returns \p true if inserting successful, \p false otherwise.
 265
 266             RCU \p synchronize method can be called. RCU should not be locked.
 267         */
 268         template <typename... Args>
 269         bool emplace( Args&&... args )
 270         {
 271             scoped_node_ptr sp( cxx_leaf_node_allocator().New( std::forward<Args>(args)... ));
 272             if ( base_class::insert( *sp.get() )) {
 273                 sp.release();
 274                 return true;
 275             }
 276             return false;
 277         }
 278
 279         /// Delete \p key from the set
 280         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_erase_val
 281
 282             The item comparator should be able to compare the type \p value_type
 283             and the type \p Q.
 284
 285             RCU \p synchronize method can be called. RCU should not be locked.
 286
 287             Return \p true if key is found and deleted, \p false otherwise
 288         */
 289         template <typename Q>
 290         bool erase( Q const& key )
 291         {
 292             return base_class::erase( key );
 293         }
 294
 295         /// Deletes the item from the set using \p pred predicate for searching
 296         /**
 297             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_erase_val "erase(Q const&)"
 298             but \p pred is used for key comparing.
 299             \p Less functor has the interface like \p std::less.
 300             \p Less must imply the same element order as the comparator used for building the set.
 301         */
 302         template <typename Q, typename Less>
 303         bool erase_with( Q const& key, Less pred )
 304         {
 305             CDS_UNUSED( pred );
 306             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 307         }
 308
 309         /// Delete \p key from the set
 310         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_erase_func
 311
 312             The function searches an item with key \p key, calls \p f functor
 313             and deletes the item. If \p key is not found, the functor is not called.
 314
 315             The functor \p Func interface:
 316             \code
 317             struct extractor {
 318                 void operator()(value_type const& val);
 319             };
 320             \endcode
 321
 322             Since the key of MichaelHashSet's \p value_type is not explicitly specified,
 323             template parameter \p Q defines the key type searching in the list.
 324             The list item comparator should be able to compare the type \p T of list item
 325             and the type \p Q.
 326
 327             RCU \p synchronize method can be called. RCU should not be locked.
 328
 329             Return \p true if key is found and deleted, \p false otherwise
 330
 331             See also: \ref erase
 332         */
 333         template <typename Q, typename Func>
 334         bool erase( Q const& key, Func f )
 335         {
 336             return base_class::erase( key, [&f]( leaf_node const& node) { f( node.m_Value ); } );
 337         }
 338
 339         /// Deletes the item from the set using \p pred predicate for searching
 340         /**
 341             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_erase_func "erase(Q const&, Func)"
 342             but \p pred is used for key comparing.
 343             \p Less functor has the interface like \p std::less.
 344             \p Less must imply the same element order as the comparator used for building the set.
 345         */
 346         template <typename Q, typename Less, typename Func>
 347         bool erase_with( Q const& key, Less pred, Func f )
 348         {
 349             CDS_UNUSED( pred );
 350             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 351                 [&f]( leaf_node const& node) { f( node.m_Value ); } );
 352         }
 353
 354         /// Extracts an item with minimal key from the set
 355         /**
 356             Returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to the leftmost item.
 357             If the set is empty, returns empty \p exempt_ptr.
 358
 359             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> minimum key.
 360             It means that the function gets leftmost leaf of the tree and tries to unlink it.
 361             During unlinking, a concurrent thread may insert an item with key less than leftmost item's key.
 362             So, the function returns the item with minimum key at the moment of tree traversing.
 363
 364             RCU \p synchronize method can be called. RCU should NOT be locked.
 365             The function does not free the item.
 366             The deallocator will be implicitly invoked when the returned object is destroyed or when
 367             its \p release() member function is called.
 368         */
 369         exempt_ptr extract_min()
 370         {
 371             return exempt_ptr( base_class::extract_min_());
 372         }
 373
 374         /// Extracts an item with maximal key from the set
 375         /**
 376             Returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to the rightmost item.
 377             If the set is empty, returns empty \p exempt_ptr.
 378
 379             @note Due the concurrent nature of the set, the function extracts <i>nearly</i> maximal key.
 380             It means that the function gets rightmost leaf of the tree and tries to unlink it.
 381             During unlinking, a concurrent thread may insert an item with key great than leftmost item's key.
 382             So, the function returns the item with maximum key at the moment of tree traversing.
 383
 384             RCU \p synchronize method can be called. RCU should NOT be locked.
 385             The function does not free the item.
 386             The deallocator will be implicitly invoked when the returned object is destroyed or when
 387             its \p release() member function is called.
 388         */
 389         exempt_ptr extract_max()
 390         {
 391             return exempt_ptr( base_class::extract_max_());
 392         }
 393
 394         /// Extracts an item from the set
 395         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_extract
 396             The function searches an item with key equal to \p key in the tree,
 397             unlinks it, and returns \ref cds::urcu::exempt_ptr "exempt_ptr" pointer to an item found.
 398             If \p key is not found the function returns an empty \p exempt_ptr.
 399
 400             RCU \p synchronize method can be called. RCU should NOT be locked.
 401             The function does not destroy the item found.
 402             The dealloctor will be implicitly invoked when the returned object is destroyed or when
 403             its release() member function is called.
 404         */
 405         template <typename Q>
 406         exempt_ptr extract( Q const& key )
 407         {
 408             return exempt_ptr( base_class::extract_( key, typename base_class::node_compare()));
 409         }
 410
 411         /// Extracts an item from the set using \p pred for searching
 412         /**
 413             The function is an analog of \p extract(Q const&) but \p pred is used for key compare.
 414             \p Less has the interface like \p std::less and should meet \ref cds_container_EllenBinTreeSet_rcu_less
 415             "predicate requirements".
 416             \p pred must imply the same element order as the comparator used for building the set.
 417         */
 418         template <typename Q, typename Less>
 419         exempt_ptr extract_with( Q const& key, Less pred )
 420         {
 421             CDS_UNUSED( pred );
 422             return exempt_ptr( base_class::extract_with_( key,
 423                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() ));
 424         }
 425
 426         /// Find the key \p key
 427         /**
 428             @anchor cds_nonintrusive_EllenBinTreeSet_rcu_find_func
 429
 430             The function searches the item with key equal to \p key and calls the functor \p f for item found.
 431             The interface of \p Func functor is:
 432             \code
 433             struct functor {
 434                 void operator()( value_type& item, Q& key );
 435             };
 436             \endcode
 437             where \p item is the item found, \p key is the <tt>find</tt> function argument.
 438
 439             The functor may change non-key fields of \p item. Note that the functor is only guarantee
 440             that \p item cannot be disposed during functor is executing.
 441             The functor does not serialize simultaneous access to the set's \p item. If such access is
 442             possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
 443
 444             The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
 445             can modify both arguments.
 446
 447             Note the hash functor specified for class \p Traits template parameter
 448             should accept a parameter of type \p Q that may be not the same as \p value_type.
 449
 450             The function applies RCU lock internally.
 451
 452             The function returns \p true if \p key is found, \p false otherwise.
 453         */
 454         template <typename Q, typename Func>
 455         bool find( Q& key, Func f ) const
 456         {
 457             return base_class::find( key, [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); });
 458         }
 459         //@cond
 460         template <typename Q, typename Func>
 461         bool find( Q const& key, Func f ) const
 462         {
 463             return base_class::find( key, [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 464         }
 465         //@endcond
 466
 467         /// Finds the key \p key using \p pred predicate for searching
 468         /**
 469             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_find_func "find(Q&, Func)"
 470             but \p pred is used for key comparing.
 471             \p Less functor has the interface like \p std::less.
 472             \p Less must imply the same element order as the comparator used for building the set.
 473         */
 474         template <typename Q, typename Less, typename Func>
 475         bool find_with( Q& key, Less pred, Func f ) const
 476         {
 477             CDS_UNUSED( pred );
 478             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 479                 [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); } );
 480         }
 481         //@cond
 482         template <typename Q, typename Less, typename Func>
 483         bool find_with( Q const& key, Less pred, Func f ) const
 484         {
 485             CDS_UNUSED( pred );
 486             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
 487                                           [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
 488         }
 489         //@endcond
 490
 491         /// Checks whether the set contains \p key
 492         /**
 493             The function searches the item with key equal to \p key
 494             and returns \p true if it is found, and \p false otherwise.
 495
 496             The function applies RCU lock internally.
 497         */
 498         template <typename Q>
 499         bool contains( Q const& key ) const
 500         {
 501             return base_class::contains( key );
 502         }
 503         //@cond
 504         template <typename Q>
 505         CDS_DEPRECATED("deprecated, use contains()")
 506         bool find( Q const& key ) const
 507         {
 508             return contains( key );
 509         }
 510         //@endcond
 511
 512         /// Checks whether the set contains \p key using \p pred predicate for searching
 513         /**
 514             The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
 515             \p Less functor has the interface like \p std::less and should meet \ref cds_intrusive_EllenBinTree_rcu_less
 516             "Predicate requirements".
 517             \p Less must imply the same element order as the comparator used for building the set.
 518             \p pred should accept arguments of type \p Q, \p key_type, \p value_type in any combination.
 519         */
 520         template <typename Q, typename Less>
 521         bool contains( Q const& key, Less pred ) const
 522         {
 523             CDS_UNUSED( pred );
 524             return base_class::contains( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 525         }
 526         //@cond
 527         template <typename Q, typename Less>
 528         CDS_DEPRECATED("deprecated, use contains()")
 529         bool find_with( Q const& key, Less pred ) const
 530         {
 531             return contains( key, pred );
 532         }
 533         //@endcond
 534
 535         /// Finds \p key and return the item found
 536         /** \anchor cds_nonintrusive_EllenBinTreeSet_rcu_get
 537             The function searches the item with key equal to \p key and returns the pointer to item found.
 538             If \p key is not found it returns \p nullptr.
 539
 540             RCU should be locked before call the function.
 541             Returned pointer is valid while RCU is locked.
 542         */
 543         template <typename Q>
 544         value_type * get( Q const& key ) const
 545         {
 546             leaf_node * pNode = base_class::get( key );
 547             return pNode ? &pNode->m_Value : nullptr;
 548         }
 549
 550         /// Finds \p key with \p pred predicate and return the item found
 551         /**
 552             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_rcu_get "get(Q const&)"
 553             but \p pred is used for comparing the keys.
 554
 555             \p Less functor has the semantics like \p std::less but should take arguments of type \ref value_type
 556             and \p Q in any order.
 557             \p pred must imply the same element order as the comparator used for building the set.
 558         */
 559         template <typename Q, typename Less>
 560         value_type * get_with( Q const& key, Less pred ) const
 561         {
 562             CDS_UNUSED( pred );
 563             leaf_node * pNode = base_class::get_with( key,
 564                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
 565             return pNode ? &pNode->m_Value : nullptr;
 566         }
 567
 568         /// Clears the set (non-atomic)
 569         /**
 570             The function unlink all items from the tree.
 571             The function is not atomic, thus, in multi-threaded environment with parallel insertions
 572             this sequence
 573             \code
 574             set.clear();
 575             assert( set.empty() );
 576             \endcode
 577             the assertion could be raised.
 578
 579             For each leaf the \ref disposer will be called after unlinking.
 580
 581             RCU \p synchronize method can be called. RCU should not be locked.
 582         */
 583         void clear()
 584         {
 585             base_class::clear();
 586         }
 587
 588         /// Checks if the set is empty
 589         bool empty() const
 590         {
 591             return base_class::empty();
 592         }
 593
 594         /// Returns item count in the set
 595         /**
 596             Only leaf nodes containing user data are counted.
 597
 598             The value returned depends on item counter type provided by \p Traits template parameter.
 599             If it is \p atomicity::empty_item_counter \p %size() always returns 0.
 600             Therefore, the function is not suitable for checking the tree emptiness, use \p empty()
 601             member function for this purpose.
 602         */
 603         size_t size() const
 604         {
 605             return base_class::size();
 606         }
 607
 608         /// Returns const reference to internal statistics
 609         stat const& statistics() const
 610         {
 611             return base_class::statistics();
 612         }
 613
 614         /// Checks internal consistency (not atomic, not thread-safe)
 615         /**
 616             The debugging function to check internal consistency of the tree.
 617         */
 618         bool check_consistency() const
 619         {
 620             return base_class::check_consistency();
 621         }
 622     };
 623 }}  // namespace cds::container
 624
 625 #endif // #ifndef CDSLIB_CONTAINER_ELLEN_BINTREE_SET_RCU_H