EllenBinTreeMap, EllenBinTreeSet:
[libcds.git] / cds / container / impl / ellen_bintree_set.h
1 //$$CDS-header$$
2
3 #ifndef CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
4 #define CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H
5
6 #include <type_traits>
7 #include <cds/container/details/ellen_bintree_base.h>
8 #include <cds/intrusive/impl/ellen_bintree.h>
9 #include <cds/container/details/guarded_ptr_cast.h>
10
11 namespace cds { namespace container {
12
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
17
18         Source:
19             - [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"
20
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.
29
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.
33
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>.
36
37         @note In the current implementation we do not use helping technique described in the original paper.
38         In Hazard Pointer schema helping is too complicated and does not give any observable benefits.
39         Instead of helping, when a thread encounters a concurrent operation it just spins waiting for
40         the operation done. Such solution allows greatly simplify the implementation of tree.
41
42         <b>Template arguments</b> :
43         - \p GC - safe memory reclamation (i.e. light-weight garbage collector) type, like \p cds::gc::HP, cds::gc::DHP
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 - set traits, default is \p ellen_bintree::traits
47             It is possible to declare option-based tree with \p ellen_bintree::make_set_traits metafunction
48             instead of \p Traits template argument.
49
50         @note Do not include <tt><cds/container/impl/ellen_bintree_set.h></tt> header file directly.
51         There are header file for each GC type:
52         - <tt><cds/container/ellen_bintree_set_hp.h></tt> - for \p cds::gc::HP
53         - <tt><cds/container/ellen_bintree_set_dhp.h></tt> - for \p cds::gc::DHP
54         - <tt><cds/container/ellen_bintree_set_rcu.h></tt> - for RCU GC
55             (see \ref cds_container_EllenBinTreeSet_rcu "RCU-based EllenBinTreeSet")
56
57         @anchor cds_container_EllenBinTreeSet_less
58         <b>Predicate requirements</b>
59
60         \p Traits::less, \p Traits::compare and other predicates using with member fuctions should accept at least parameters
61         of type \p T and \p Key in any combination.
62         For example, for \p Foo struct with \p std::string key field the appropiate \p less functor is:
63         \code
64         struct Foo
65         {
66             std::string m_strKey;
67             ...
68         };
69
70         struct less {
71             bool operator()( Foo const& v1, Foo const& v2 ) const
72             { return v1.m_strKey < v2.m_strKey ; }
73
74             bool operator()( Foo const& v, std::string const& s ) const
75             { return v.m_strKey < s ; }
76
77             bool operator()( std::string const& s, Foo const& v ) const
78             { return s < v.m_strKey ; }
79
80             // Support comparing std::string and char const *
81             bool operator()( std::string const& s, char const * p ) const
82             { return s.compare(p) < 0 ; }
83
84             bool operator()( Foo const& v, char const * p ) const
85             { return v.m_strKey.compare(p) < 0 ; }
86
87             bool operator()( char const * p, std::string const& s ) const
88             { return s.compare(p) > 0; }
89
90             bool operator()( char const * p, Foo const& v ) const
91             { return v.m_strKey.compare(p) > 0; }
92         };
93         \endcode
94     */
95     template <
96         class GC,
97         typename Key,
98         typename T,
99 #ifdef CDS_DOXYGEN_INVOKED
100         class Traits = ellen_bintree::traits
101 #else
102         class Traits
103 #endif
104     >
105     class EllenBinTreeSet
106 #ifdef CDS_DOXYGEN_INVOKED
107         : public cds::intrusive::EllenBinTree< GC, Key, T, Traits >
108 #else
109         : public ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits >::type
110 #endif
111     {
112         //@cond
113         typedef ellen_bintree::details::make_ellen_bintree_set< GC, Key, T, Traits > maker;
114         typedef typename maker::type base_class;
115         //@endcond
116
117     public:
118         typedef GC      gc;         ///< Garbage collector
119         typedef Key     key_type;   ///< type of a key to be stored in internal nodes; key is a part of \p value_type
120         typedef T       value_type; ///< type of value to be stored in the binary tree
121         typedef Traits  traits;    ///< Traits template parameter
122
123 #   ifdef CDS_DOXYGEN_INVOKED
124         typedef implementation_defined key_comparator  ;    ///< key compare functor based on opt::compare and opt::less option setter.
125 #   else
126         typedef typename maker::intrusive_traits::compare   key_comparator;
127 #   endif
128         typedef typename base_class::item_counter           item_counter;  ///< Item counting policy used
129         typedef typename base_class::memory_model           memory_model;  ///< Memory ordering. See cds::opt::memory_model option
130         typedef typename base_class::stat                   stat;          ///< internal statistics type
131         typedef typename traits::key_extractor              key_extractor; ///< key extracting functor
132         typedef typename traits::back_off                   back_off;      ///< Back-off strategy
133
134         typedef typename traits::allocator                  allocator_type;   ///< Allocator for leaf nodes
135         typedef typename base_class::node_allocator         node_allocator;   ///< Internal node allocator
136         typedef typename base_class::update_desc_allocator  update_desc_allocator; ///< Update descriptor allocator
137
138         //@cond
139         typedef cds::container::ellen_bintree::implementation_tag implementation_tag;
140         //@endcond
141
142     protected:
143         //@cond
144         typedef typename maker::cxx_leaf_node_allocator cxx_leaf_node_allocator;
145         typedef typename base_class::value_type         leaf_node;
146         typedef typename base_class::internal_node      internal_node;
147
148         typedef std::unique_ptr< leaf_node, typename maker::leaf_deallocator > scoped_node_ptr;
149         //@endcond
150
151     public:
152         /// Guarded pointer
153         typedef typename gc::template guarded_ptr< leaf_node, value_type, details::guarded_ptr_cast_set<leaf_node, value_type> > guarded_ptr;
154
155     public:
156         /// Default constructor
157         EllenBinTreeSet()
158             : base_class()
159         {}
160
161         /// Clears the set
162         ~EllenBinTreeSet()
163         {}
164
165         /// Inserts new node
166         /**
167             The function creates a node with copy of \p val value
168             and then inserts the node created into the set.
169
170             The type \p Q should contain at least the complete key for the node.
171             The object of \ref value_type should be constructible from a value of type \p Q.
172             In trivial case, \p Q is equal to \ref value_type.
173
174             Returns \p true if \p val is inserted into the set, \p false otherwise.
175         */
176         template <typename Q>
177         bool insert( Q const& val )
178         {
179             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
180             if ( base_class::insert( *sp.get() )) {
181                 sp.release();
182                 return true;
183             }
184             return false;
185         }
186
187         /// Inserts new node
188         /**
189             The function allows to split creating of new item into two part:
190             - create item with key only
191             - insert new item into the set
192             - if inserting is success, calls  \p f functor to initialize value-fields of \p val.
193
194             The functor signature is:
195             \code
196                 void func( value_type& val );
197             \endcode
198             where \p val is the item inserted. User-defined functor \p f should guarantee that during changing
199             \p val no any other changes could be made on this set's item by concurrent threads.
200             The user-defined functor is called only if the inserting is success.
201         */
202         template <typename Q, typename Func>
203         bool insert( Q const& val, Func f )
204         {
205             scoped_node_ptr sp( cxx_leaf_node_allocator().New( val ));
206             if ( base_class::insert( *sp.get(), [&f]( leaf_node& val ) { f( val.m_Value ); } )) {
207                 sp.release();
208                 return true;
209             }
210             return false;
211         }
212
213         /// Updates the node
214         /**
215             The operation performs inserting or changing data with lock-free manner.
216
217             If the item \p val is not found in the set, then \p val is inserted into the set
218             iff \p bAllowInsert is \p true.
219             Otherwise, the functor \p func is called with item found.
220             The functor \p func signature is:
221             \code
222                 struct my_functor {
223                     void operator()( bool bNew, value_type& item, const Q& val );
224                 };
225             \endcode
226             with arguments:
227             with arguments:
228             - \p bNew - \p true if the item has been inserted, \p false otherwise
229             - \p item - item of the set
230             - \p val - argument \p key passed into the \p %update() function
231
232             The functor can change non-key fields of the \p item; however, \p func must guarantee
233             that during changing no any other modifications could be made on this item by concurrent threads.
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( const Q& 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         // Deprecated, use update()
255         template <typename Q, typename Func>
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         template <typename... Args>
267         bool emplace( Args&&... args )
268         {
269             scoped_node_ptr sp( cxx_leaf_node_allocator().New( std::forward<Args>(args)... ));
270             if ( base_class::insert( *sp.get() )) {
271                 sp.release();
272                 return true;
273             }
274             return false;
275         }
276
277         /// Delete \p key from the set
278         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_val
279
280             The item comparator should be able to compare the type \p value_type
281             and the type \p Q.
282
283             Return \p true if key is found and deleted, \p false otherwise
284         */
285         template <typename Q>
286         bool erase( Q const& key )
287         {
288             return base_class::erase( key );
289         }
290
291         /// Deletes the item from the set using \p pred predicate for searching
292         /**
293             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_val "erase(Q const&)"
294             but \p pred is used for key comparing.
295             \p Less functor has the interface like \p std::less.
296             \p Less must imply the same element order as the comparator used for building the set.
297         */
298         template <typename Q, typename Less>
299         bool erase_with( Q const& key, Less pred )
300         {
301             CDS_UNUSED( pred );
302             return base_class::erase_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
303         }
304
305         /// Delete \p key from the set
306         /** \anchor cds_nonintrusive_EllenBinTreeSet_erase_func
307
308             The function searches an item with key \p key, calls \p f functor
309             and deletes the item. If \p key is not found, the functor is not called.
310
311             The functor \p Func interface:
312             \code
313             struct extractor {
314                 void operator()(value_type const& val);
315             };
316             \endcode
317
318             Since the key of MichaelHashSet's \p value_type is not explicitly specified,
319             template parameter \p Q defines the key type searching in the list.
320             The list item comparator should be able to compare the type \p T of list item
321             and the type \p Q.
322
323             Return \p true if key is found and deleted, \p false otherwise
324         */
325         template <typename Q, typename Func>
326         bool erase( Q const& key, Func f )
327         {
328             return base_class::erase( key, [&f]( leaf_node const& node) { f( node.m_Value ); } );
329         }
330
331         /// Deletes the item from the set using \p pred predicate for searching
332         /**
333             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_erase_func "erase(Q const&, Func)"
334             but \p pred is used for key comparing.
335             \p Less functor has the interface like \p std::less.
336             \p Less must imply the same element order as the comparator used for building the set.
337         */
338         template <typename Q, typename Less, typename Func>
339         bool erase_with( Q const& key, Less pred, Func f )
340         {
341             CDS_UNUSED( pred );
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 a guarded pointer to minimum value.
349             If the set is empty, the function returns an empty \p guarded_ptr.
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             The guarded pointer prevents deallocation of returned item,
357             see \p cds::gc::guarded_ptr for explanation.
358             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
359         */
360         guarded_ptr extract_min()
361         {
362             guarded_ptr gp;
363             base_class::extract_min_( gp.guard() );
364             return gp;
365         }
366
367         /// Extracts an item with maximal key from the set
368         /**
369             If the set is not empty, the function returns a guarded pointer to maximal value.
370             If the set is empty, the function returns an empty \p guarded_ptr.
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             The guarded pointer prevents deallocation of returned item,
378             see \p cds::gc::guarded_ptr for explanation.
379             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
380         */
381         guarded_ptr extract_max()
382         {
383             guarded_ptr gp;
384             base_class::extract_max_( gp.guard() );
385             return gp;
386         }
387
388         /// Extracts an item from the tree
389         /** \anchor cds_nonintrusive_EllenBinTreeSet_extract
390             The function searches an item with key equal to \p key in the tree,
391             unlinks it, and returns an guarded pointer to it.
392             If the item  is not found the function returns an empty \p guarded_ptr.
393
394             The guarded pointer prevents deallocation of returned item,
395             see \p cds::gc::guarded_ptr for explanation.
396             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
397         */
398         template <typename Q>
399         guarded_ptr extract( Q const& key )
400         {
401             guarded_ptr gp;
402             base_class::extract_( gp.guard(), key );
403             return gp;
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_extract "extract(Q const&)"
409             but \p pred is used for key compare.
410             \p Less has the interface like \p std::less.
411             \p pred must imply the same element order as the comparator used for building the set.
412         */
413         template <typename Q, typename Less>
414         guarded_ptr extract_with( Q const& key, Less pred )
415         {
416             CDS_UNUSED( pred );
417             guarded_ptr gp;
418             base_class::extract_with_( gp.guard(), key,
419                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
420             return gp;
421         }
422
423         /// Find the key \p key
424         /**
425             @anchor cds_nonintrusive_EllenBinTreeSet_find_func
426
427             The function searches the item with key equal to \p key and calls the functor \p f for item found.
428             The interface of \p Func functor is:
429             \code
430             struct functor {
431                 void operator()( value_type& item, Q& key );
432             };
433             \endcode
434             where \p item is the item found, \p key is the <tt>find</tt> function argument.
435
436             The functor may change non-key fields of \p item. Note that the functor is only guarantee
437             that \p item cannot be disposed during functor is executing.
438             The functor does not serialize simultaneous access to the set's \p item. If such access is
439             possible you must provide your own synchronization schema on item level to exclude unsafe item modifications.
440
441             The \p key argument is non-const since it can be used as \p f functor destination i.e., the functor
442             can modify both arguments.
443
444             Note the hash functor specified for class \p Traits template parameter
445             should accept a parameter of type \p Q that may be not the same as \p value_type.
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 )
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 )
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_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 )
471         {
472             CDS_UNUSED( pred );
473             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
474                 [&f]( leaf_node& node, Q& v ) { f( node.m_Value, v ); } );
475         }
476         //@cond
477         template <typename Q, typename Less, typename Func>
478         bool find_with( Q const& key, Less pred, Func f )
479         {
480             CDS_UNUSED( pred );
481             return base_class::find_with( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >(),
482                                           [&f]( leaf_node& node, Q const& v ) { f( node.m_Value, v ); } );
483         }
484         //@endcond
485
486         /// Checks whether the set contains \p key
487         /**
488             The function searches the item with key equal to \p key
489             and returns \p true if it is found, and \p false otherwise.
490         */
491         template <typename Q>
492         bool contains( Q const & key )
493         {
494             return base_class::contains( key );
495         }
496         //@cond
497         // Deprecated, use contains()
498         template <typename Q>
499         bool find( Q const & key )
500         {
501             return contains( key );
502         }
503         //@endcond
504
505         /// Checks whether the set contains \p key using \p pred predicate for searching
506         /**
507             The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
508             \p Less functor has the interface like \p std::less.
509             \p Less must imply the same element order as the comparator used for building the set.
510         */
511         template <typename Q, typename Less>
512         bool contains( Q const& key, Less pred )
513         {
514             CDS_UNUSED( pred );
515             return base_class::contains( key, cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >());
516         }
517         //@cond
518         // Deprecated, use contains()
519         template <typename Q, typename Less>
520         bool find_with( Q const& key, Less pred )
521         {
522             return contains( key, pred );
523         }
524         //@endcond
525
526         /// Finds \p key and returns the item found
527         /** @anchor cds_nonintrusive_EllenBinTreeSet_get
528             The function searches the item with key equal to \p key and returns the item found as an guarded pointer.
529             The function returns \p true if \p key is found, \p false otherwise.
530
531             The guarded pointer prevents deallocation of returned item,
532             see \p cds::gc::guarded_ptr for explanation.
533             @note Each \p guarded_ptr object uses the GC's guard that can be limited resource.
534         */
535         template <typename Q>
536         guarded_ptr get( Q const& key )
537         {
538             guarded_ptr gp;
539             base_class::get_( gp.guard(), key );
540             return gp;
541         }
542
543         /// Finds \p key with predicate \p pred and returns the item found
544         /**
545             The function is an analog of \ref cds_nonintrusive_EllenBinTreeSet_get "get(Q const&)"
546             but \p pred is used for key comparing.
547             \p Less functor has the interface like \p std::less.
548             \p pred must imply the same element order as the comparator used for building the set.
549         */
550         template <typename Q, typename Less>
551         guarded_ptr get_with( Q const& key, Less pred )
552         {
553             CDS_UNUSED(pred);
554             guarded_ptr gp;
555             base_class::get_with_( gp.guard(), key,
556                 cds::details::predicate_wrapper< leaf_node, Less, typename maker::value_accessor >() );
557             return gp;
558         }
559
560         /// Clears the set (not atomic)
561         /**
562             The function unlink all items from the tree.
563             The function is not atomic, thus, in multi-threaded environment with parallel insertions
564             this sequence
565             \code
566             set.clear();
567             assert( set.empty() );
568             \endcode
569             the assertion could be raised.
570
571             For each leaf the \ref disposer will be called after unlinking.
572         */
573         void clear()
574         {
575             base_class::clear();
576         }
577
578         /// Checks if the set is empty
579         bool empty() const
580         {
581             return base_class::empty();
582         }
583
584         /// Returns item count in the set
585         /**
586             Only leaf nodes containing user data are counted.
587
588             The value returned depends on item counter type provided by \p Traits template parameter.
589             If it is \p atomicity::empty_item_counter this function always returns 0.
590
591             The function is not suitable for checking the tree emptiness, use \p empty()
592             member function for this purpose.
593         */
594         size_t size() const
595         {
596             return base_class::size();
597         }
598
599         /// Returns const reference to internal statistics
600         stat const& statistics() const
601         {
602             return base_class::statistics();
603         }
604
605         /// Checks internal consistency (not atomic, not thread-safe)
606         /**
607             The debugging function to check internal consistency of the tree.
608         */
609         bool check_consistency() const
610         {
611             return base_class::check_consistency();
612         }
613     };
614
615 }} // namespace cds::container
616
617 #endif // #ifndef CDSLIB_CONTAINER_IMPL_ELLEN_BINTREE_SET_H