3 #ifndef CDSLIB_CONTAINER_STRIPED_SET_H
4 #define CDSLIB_CONTAINER_STRIPED_SET_H
6 #include <cds/intrusive/striped_set.h>
7 #include <cds/container/striped_set/adapter.h>
9 namespace cds { namespace container {
12 /** @ingroup cds_nonintrusive_set
15 - [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
17 Lock striping is very simple technique.
18 The set consists of the bucket table and the array of locks.
19 Initially, the capacity of lock array and bucket table is the same.
20 When set is resized, bucket table capacity will be doubled but lock array will not.
21 The lock \p i protects each bucket \p j, where <tt> j = i mod L </tt>,
22 where \p L - the size of lock array.
25 - \p Container - the container class that is used as bucket table entry. The \p Container class should support
26 an uniform interface described below.
27 - \p Options - options
29 The \p %StripedSet class does not exactly dictate the type of container that should be used as a \p Container bucket.
30 Instead, the class supports different container type for the bucket, for exampe, \p std::list, \p std::set and others.
32 Remember that \p %StripedSet class algorithm ensures sequential blocking access to its bucket through the mutex type you specify
33 among \p Options template arguments.
36 - \p opt::mutex_policy - concurrent access policy.
37 Available policies: \p intrusive::striped_set::striping, \p intrusive::striped_set::refinable.
38 Default is \p %striped_set::striping.
39 - \p opt::hash - hash functor. Default option value see <tt>opt::v::hash_selector<opt::none> </tt>
40 which selects default hash functor for your compiler.
41 - \p opt::compare - key comparison functor. No default functor is provided.
42 If the option is not specified, the \p %opt::less is used.
43 - \p opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
44 - \p opt::item_counter - item counter type. Default is \p atomicity::item_counter since some operation on the counter is performed
45 without locks. Note that item counting is an essential part of the set algorithm, so dummy counter
46 like as \p atomicity::empty_item_counter is not suitable.
47 - \p opt::allocator - the allocator type using for memory allocation of bucket table and lock array. Default is \ref CDS_DEFAULT_ALLOCATOR.
48 - \p opt::resizing_policy - the resizing policy that is a functor that decides when to resize the hash set.
49 Default option value depends on bucket container type:
50 for sequential containers like \p std::list, \p std::vector the resizing policy is <tt>striped_set::load_factor_resizing<4> </tt>;
51 for other type of containers like \p std::set, \p std::unordered_set the resizing policy is \p striped_set::no_resizing.
52 See \ref cds_striped_resizing_policy "available resizing policy".
53 Note that the choose of resizing policy depends of \p Container type:
54 for sequential containers like \p std::list, \p std::vector and so on, right choosing of the policy can
55 significantly improve performance.
56 For other, non-sequential types of \p Container (like a \p std::set) the resizing policy is not so important.
57 - \p opt::copy_policy - the copy policy which is used to copy items from the old set to the new one when resizing.
58 The policy can be optionally used in adapted bucket container for performance reasons of resizing.
59 The detail of copy algorithm depends on type of bucket container and explains below.
61 \p %opt::compare or \p %opt::less options are used in some \p Container class for searching an item.
62 \p %opt::compare option has the highest priority: if \p %opt::compare is specified, \p %opt::less is not used.
64 You can pass other option that would be passed to <tt>adapt</tt> metafunction, see below.
66 <b>Internal details</b>
68 The \p %StripedSet class cannot utilize the \p Container container specified directly, but only its adapted variant which
69 supports an unified interface. Internally, the adaptation is made via striped_set::adapt metafunction that wraps bucket container
70 and provides the unified bucket interface suitable for \p %StripedSet. Such adaptation is completely transparent for you -
71 you don't need to call \p adapt metafunction directly, \p %StripedSet class's internal machinery itself invokes appropriate
72 \p adapt metafunction to adjust your \p Container container class to \p %StripedSet bucket's internal interface.
73 All you need is to include a right header before <tt>striped_hash_set.h</tt>.
75 By default, <tt>striped_set::adapt<AnyContainer, Options...> </tt> metafunction does not make any wrapping to \p AnyContainer,
76 so, the result <tt>striped_set::adapt<AnyContainer, Options...>::type </tt> is the same as \p AnyContainer.
77 However, there are a lot of specializations of <tt>striped_set::adapt</tt> for well-known containers, see table below.
78 Any of this specialization wraps corresponding container making it suitable for the set's bucket.
79 Remember, you should include the proper header file for \p adapt <b>before</b> including <tt>striped_hash_set.h</tt>.
83 <th>.h-file for \p adapt</th>
88 <td> \p std::list</td>
89 <td><tt><cds/container/striped_set/std_list.h></tt></td>
91 #include <cds/container/striped_set/std_list.h>
92 #include <cds/container/striped_hash_set.h>
93 typedef cds::container::StripedSet<
95 cds::opt::less< std::less<T> >
101 Template argument pack \p Options <b>must</b> contain cds::opt::less or cds::opt::compare for type \p T stored in the list
105 <td> \p std::vector</td>
106 <td><tt><cds/container/striped_set/std_vector.h></tt></td>
108 #include <cds/container/striped_set/std_vector.h>
109 #include <cds/container/striped_hash_set.h>
110 typedef cds::container::StripedSet<
112 cds::opt::less< std::less<T> >
117 The vector is ordered.
118 Template argument pack \p Options <b>must</b> contain \p cds::opt::less or \p cds::opt::compare for type \p T stored in the list
122 <td> \p std::set</td>
123 <td><tt><cds/container/striped_set/std_set.h></tt></td>
125 #include <cds/container/striped_set/std_set.h>
126 #include <cds/container/striped_hash_set.h>
127 typedef cds::container::StripedSet<
128 std::set< T, std::less<T> >
136 <td> \p std::unordered_set</td>
137 <td><tt><cds/container/striped_set/std_hash_set.h></tt></td>
139 #include <cds/container/striped_set/std_hash_set.h>
140 #include <cds/container/striped_hash_set.h>
141 typedef cds::container::StripedSet<
151 You should provide two different hash function \p h1 and \p h2 - one for \p std::unordered_set and other for \p %StripedSet.
152 For the best result, \p h1 and \p h2 must be orthogonal i.e. <tt> h1(X) != h2(X) </tt> for any value \p X.
156 <td> \p boost::container::slist</td>
157 <td><tt><cds/container/striped_set/boost_slist.h></tt></td>
159 #include <cds/container/striped_set/boost_slist.h>
160 #include <cds/container/striped_hash_set.h>
161 typedef cds::container::StripedSet<
162 boost::container::slist<T>
168 \p Options <b>must</b> contain \p cds::opt::less or \p cds::opt::compare.
172 <td> \p boost::container::list</td>
173 <td><tt><cds/container/striped_set/boost_list.h></tt></td>
175 #include <cds/container/striped_set/boost_list.h>
176 #include <cds/container/striped_hash_set.h>
177 typedef cds::container::StripedSet<
178 boost::container::list<T>
184 \p Options <b>must</b> contain \p cds::opt::less or \p cds::opt::compare.
188 <td> \p boost::container::vector</td>
189 <td><tt><cds/container/striped_set/boost_vector.h></tt></td>
191 #include <cds/container/striped_set/boost_vector.h>
192 #include <cds/container/striped_hash_set.h>
193 typedef cds::container::StripedSet<
194 boost::container::vector<T>,
195 cds::opt::less< std::less<T> >
200 The vector is ordered.
201 Template argument pack \p Options <b>must</b> contain \p cds::opt::less or \p cds::opt::compare for type \p T stored in the vector
205 <td> \p boost::container::stable_vector</td>
206 <td><tt><cds/container/striped_set/boost_stable_vector.h></tt></td>
208 #include <cds/container/striped_set/boost_stable_vector.h>
209 #include <cds/container/striped_hash_set.h>
210 typedef cds::container::StripedSet<
211 boost::container::stable_vector<T>,
212 cds::opt::less< std::less<T> >
217 The vector is ordered.
218 Template argument pack \p Options <b>must</b> contain \p cds::opt::less or \p cds::opt::compare for type \p T stored in the vector
222 <td> \p boost::container::set</td>
223 <td><tt><cds/container/striped_set/boost_set.h></tt></td>
225 #include <cds/container/striped_set/boost_set.h>
226 #include <cds/container/striped_hash_set.h>
227 typedef cds::container::StripedSet<
228 boost::container::set< T, std::less<T> >
236 <td> \p boost::container::flat_set</td>
237 <td><tt><cds/container/striped_set/boost_flat_set.h></tt></td>
239 #include <cds/container/striped_set/boost_flat_set.h>
240 #include <cds/container/striped_hash_set.h>
241 typedef cds::container::StripedSet<
242 boost::container::flat_set< T, std::less<T> >
250 <td> \p boost::unordered_set</td>
251 <td><tt><cds/container/striped_set/boost_unordered_set.h></tt></td>
253 #include <cds/container/striped_set/boost_unordered_set.h>
254 #include <cds/container/striped_hash_set.h>
255 typedef cds::container::StripedSet<
256 boost::unordered_set<
265 You should provide two different hash function \p h1 and \p h2 - one for \p boost::unordered_set and other for \p %StripedSet.
266 For the best result, \p h1 and \p h2 must be orthogonal i.e. <tt> h1(X) != h2(X) </tt> for any value \p X.
271 You can use another container type as set's bucket.
272 Suppose, you have a container class \p MyBestContainer and you want to integrate it with \p %StripedSet as bucket type.
273 There are two possibility:
274 - either your \p MyBestContainer class has native support of bucket's interface;
275 in this case, you can use default <tt>striped_set::adapt</tt> metafunction;
276 - or your \p MyBestContainer class does not support bucket's interface, which means, that you should develop a specialization
277 <tt>cds::container::striped_set::adapt<MyBestContainer> </tt> metafunction providing necessary interface.
279 The <tt>striped_set::adapt< Container, Options... ></tt> metafunction has two template argument:
280 - \p Container is the class that should be used as the bucket, for example, <tt>std::list< T ></tt>.
281 - \p Options pack is the options from \p %StripedSet declaration. The \p adapt metafunction can use
282 any option from \p Options for its internal use. For example, a \p compare option can be passed to \p adapt
283 metafunction via \p Options argument of \p %StripedSet declaration.
285 See striped_set::adapt metafunction for the description of interface that the bucket container must provide
286 to be %StripedSet compatible.
289 There are three predefined copy policy:
290 - \p cds::container::striped_set::copy_item - copy item from old bucket to new one when resizing using copy ctor. It is default policy for
291 any compiler that do not support move semantics
292 - \p cds::container::striped_set::move_item - move item from old bucket to new one when resizing using move semantics. It is default policy for
293 any compiler that support move semantics. If compiler does not support move semantics, the move policy is the same as \p copy_item
294 - \p cds::container::striped_set::swap_item - copy item from old bucket to new one when resizing using \p std::swap. Not all containers support
295 this copy policy, see details in table below.
297 You can define your own copy policy specifically for your case.
298 Note, right copy policy can significantly improve the performance of resizing.
311 - \p boost::stable_vector
315 void operator()( std::list<T>& list, std::list<T>::iterator itInsert, std::list<T>::iterator itWhat )
317 list.insert( itInsert, *itWhat );
322 // The type T stored in the list must be swappable
324 void operator()( std::list<T>& list, std::list<T>::iterator itInsert, std::list<T>::iterator itWhat )
326 std::swap( *list.insert( itInsert, T() ), *itWhat );
332 void operator()( std::list<T>& list, std::list<T>::iterator itInsert, std::list<T>::iterator itWhat )
334 list.insert( itInsert, std::move( *itWhat ) );
342 - \p std::unordered_set
346 void operator()( std::set<T>& set, std::set<T>::iterator itWhat )
348 set.insert( *itWhat );
351 \p swap_item is not applicable (same as \p copy_item)
355 void operator()( std::set<T>& set, std::set<T>::iterator itWhat )
357 set.insert( std::move( *itWhat ));
363 - \p boost::container::slist
367 void operator()( bc::slist<T>& list, bc::slist<T>::iterator itInsert, bc::slist<T>::iterator itWhat )
369 list.insert_after( itInsert, *itWhat );
374 // The type T stored in the list must be swappable
376 void operator()( bc::slist<T>& list, bc::slist<T>::iterator itInsert, bc::slist<T>::iterator itWhat )
378 std::swap( *list.insert_after( itInsert, T() ), *itWhat );
384 void operator()( bc::slist<T>& list, bc::slist<T>::iterator itInsert, bc::slist<T>::iterator itWhat )
386 list.insert_after( itInsert, std::move( *itWhat ) );
393 <b>Advanced functions</b>
395 <b>libcds</b> provides some advanced functions like \p erase_with(), \p find_with(),
396 that cannot be supported by all underlying containers.
397 The table below shows whether underlying container supports those functions
398 (the sign "+" means "container supports the function"):
403 <th>\p find_with</th>
404 <th>\p erse_with</th>
407 <td> \p std::list</td>
412 <td> \p std::vector</td>
417 <td> \p std::set</td>
422 <td> \p std::unordered_set</td>
427 <td> \p boost::container::slist</td>
432 <td> \p boost::container::list</td>
437 <td> \p boost::container::vector</td>
442 <td> \p boost::container::stable_vector</td>
447 <td> \p boost::container::set</td>
452 <td> \p boost::container::flat_set</td>
457 <td> \p boost::unordered_set</td>
463 template <class Container, typename... Options>
464 class StripedSet: protected intrusive::StripedSet<Container, Options...>
467 typedef intrusive::StripedSet<Container, Options...> base_class;
471 typedef typename base_class::default_options default_options;
472 typedef typename base_class::options options;
475 typedef Container underlying_container_type ; ///< original intrusive container type for the bucket
476 typedef typename base_class::bucket_type bucket_type ; ///< container type adapted for hash set
477 typedef typename bucket_type::value_type value_type ; ///< value type stored in the set
479 typedef typename base_class::hash hash ; ///< Hash functor
480 typedef typename base_class::item_counter item_counter ; ///< Item counter
481 typedef typename base_class::resizing_policy resizing_policy ; ///< Resizing policy
482 typedef typename base_class::allocator_type allocator_type ; ///< allocator type specified in options.
483 typedef typename base_class::mutex_policy mutex_policy ; ///< Mutex policy
487 typedef typename base_class::scoped_cell_lock scoped_cell_lock;
488 typedef typename base_class::scoped_full_lock scoped_full_lock;
489 typedef typename base_class::scoped_resize_lock scoped_resize_lock;
493 /// Default ctor. The initial capacity is 16.
498 /// Ctor with initial capacity specified
500 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
502 : base_class( nCapacity )
505 /// Ctor with resizing policy (copy semantics)
507 This constructor initializes m_ResizingPolicy member with copy of \p resizingPolicy parameter
510 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
511 ,resizing_policy const& resizingPolicy ///< Resizing policy
513 : base_class( nCapacity, resizingPolicy )
516 /// Ctor with resizing policy (move semantics)
518 This constructor initializes m_ResizingPolicy member moving \p resizingPolicy parameter
519 Move semantics is used. Available only for the compilers that supports C++11 rvalue reference.
522 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
523 ,resizing_policy&& resizingPolicy ///< Resizing policy
525 : base_class( nCapacity, std::forward<resizing_policy>(resizingPolicy) )
528 /// Destructor destroys internal data
535 The function creates a node with copy of \p val value
536 and then inserts the node created into the set.
538 The type \p Q should contain as minimum the complete key for the node.
539 The object of \p value_type should be constructible from a value of type \p Q.
540 In trivial case, \p Q is equal to \p value_type.
542 Returns \p true if \p val is inserted into the set, \p false otherwise.
544 template <typename Q>
545 bool insert( Q const& val )
547 return insert( val, []( value_type& ) {} );
552 The function allows to split creating of new item into two part:
553 - create item with key only
554 - insert new item into the set
555 - if inserting is success, calls \p f functor to initialize value-field of new item .
557 The functor signature is:
559 void func( value_type& item );
561 where \p item is the item inserted.
563 The type \p Q can differ from \p value_type of items storing in the set.
564 Therefore, the \p value_type should be constructible from type \p Q.
566 The user-defined functor is called only if the inserting is success.
568 template <typename Q, typename Func>
569 bool insert( Q const& val, Func f )
573 size_t nHash = base_class::hashing( val );
574 bucket_type * pBucket;
576 scoped_cell_lock sl( base_class::m_MutexPolicy, nHash );
577 pBucket = base_class::bucket( nHash );
578 bOk = pBucket->insert( val, f );
579 bResize = bOk && base_class::m_ResizingPolicy( ++base_class::m_ItemCounter, *this, *pBucket );
583 base_class::resize();
587 /// Inserts data of type \p %value_type constructed with <tt>std::forward<Args>(args)...</tt>
589 Returns \p true if inserting successful, \p false otherwise.
591 template <typename... Args>
592 bool emplace( Args&&... args )
596 size_t nHash = base_class::hashing( value_type( std::forward<Args>(args)...));
597 bucket_type * pBucket;
599 scoped_cell_lock sl( base_class::m_MutexPolicy, nHash );
600 pBucket = base_class::bucket( nHash );
602 bOk = pBucket->emplace( std::forward<Args>(args)...);
603 bResize = bOk && base_class::m_ResizingPolicy( ++base_class::m_ItemCounter, *this, *pBucket );
607 base_class::resize();
613 The operation performs inserting or changing data with lock-free manner.
615 If \p key is not found in the set, then \p key is inserted iff \p bAllowInsert is \p true.
616 Otherwise, the functor \p func is called with item found.
618 The functor signature is:
621 void operator()( bool bNew, value_type& item, const Q& val );
625 - \p bNew - \p true if the item has been inserted, \p false otherwise
626 - \p item - item of the set
627 - \p val - argument \p val passed into the \p %update() function
629 The functor may change non-key fields of the \p item.
631 Returns <tt> std::pair<bool, bool> </tt> where \p first is true if operation is successfull,
632 \p second is true if new item has been added or \p false if the item with \p key
633 already is in the map.
635 template <typename Q, typename Func>
636 std::pair<bool, bool> update( Q const& val, Func func, bool bAllowInsert = true )
638 std::pair<bool, bool> result;
640 size_t nHash = base_class::hashing( val );
641 bucket_type * pBucket;
643 scoped_cell_lock sl( base_class::m_MutexPolicy, nHash );
644 pBucket = base_class::bucket( nHash );
646 result = pBucket->update( val, func, bAllowInsert );
647 bResize = result.first && result.second && base_class::m_ResizingPolicy( ++base_class::m_ItemCounter, *this, *pBucket );
651 base_class::resize();
655 template <typename Q, typename Func>
656 CDS_DEPRECATED("ensure() is deprecated, use update()")
657 std::pair<bool, bool> ensure( Q const& val, Func func )
659 return update( val, func, true );
663 /// Delete \p key from the set
664 /** \anchor cds_nonintrusive_StripedSet_erase
666 The set item comparator should be able to compare the type \p value_type and the type \p Q.
667 Return \p true if key is found and deleted, \p false otherwise
669 template <typename Q>
670 bool erase( Q const& key )
672 return erase( key, [](value_type const&) {} );
675 /// Deletes the item from the set using \p pred predicate for searching
677 The function is an analog of \ref cds_nonintrusive_StripedSet_erase "erase(Q const&)"
678 but \p pred is used for key comparing.
679 \p Less functor has the interface like \p std::less.
680 \p pred must imply the same element order as the comparator used for building the set.
682 @note This function is enabled if the compiler supports C++11
683 default template arguments for function template <b>and</b> the underlying container
684 supports \p %erase_with feature.
686 template < typename Q, typename Less
687 ,typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_erase_with >::type >
688 bool erase_with( Q const& key, Less pred )
690 return erase_with( key, pred, [](value_type const&) {} );
693 /// Delete \p key from the set
694 /** \anchor cds_nonintrusive_StripedSet_erase_func
696 The function searches an item with key \p key, calls \p f functor with item found
697 and deletes it. If \p key is not found, the functor is not called.
699 The functor \p Func interface is:
702 void operator()(value_type const& val);
706 Return \p true if key is found and deleted, \p false otherwise
708 template <typename Q, typename Func>
709 bool erase( Q const& key, Func f )
712 size_t nHash = base_class::hashing( key );
714 scoped_cell_lock sl( base_class::m_MutexPolicy, nHash );
715 bucket_type * pBucket = base_class::bucket( nHash );
717 bOk = pBucket->erase( key, f );
721 --base_class::m_ItemCounter;
725 /// Deletes the item from the set using \p pred predicate for searching
727 The function is an analog of \ref cds_nonintrusive_StripedSet_erase_func "erase(Q const&, Func)"
728 but \p pred is used for key comparing.
729 \p Less functor has the interface like \p std::less.
730 \p pred must imply the same element order as the comparator used for building the set.
732 @note This function is enabled if the compiler supports C++11
733 default template arguments for function template <b>and</b> the underlying container
734 supports \p %erase_with feature.
736 template < typename Q, typename Less, typename Func
737 , typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_erase_with >::type >
738 bool erase_with( Q const& key, Less pred, Func f )
741 size_t nHash = base_class::hashing( key );
743 scoped_cell_lock sl( base_class::m_MutexPolicy, nHash );
744 bucket_type * pBucket = base_class::bucket( nHash );
746 bOk = pBucket->erase( key, pred, f );
750 --base_class::m_ItemCounter;
754 /// Find the key \p val
755 /** \anchor cds_nonintrusive_StripedSet_find_func
757 The function searches the item with key equal to \p val and calls the functor \p f for item found.
758 The interface of \p Func functor is:
761 void operator()( value_type& item, Q& val );
764 where \p item is the item found, \p val is the <tt>find</tt> function argument.
766 The functor can change non-key fields of \p item.
767 The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
768 can modify both arguments.
770 The type \p Q can differ from \p value_type of items storing in the container.
771 Therefore, the \p value_type should be comparable with type \p Q.
773 The function returns \p true if \p val is found, \p false otherwise.
775 template <typename Q, typename Func>
776 bool find( Q& val, Func f )
778 return base_class::find( val, f );
781 /// Find the key \p val using \p pred predicate
783 The function is an analog of \ref cds_nonintrusive_StripedSet_find_func "find(Q&, Func)"
784 but \p pred is used for key comparing
785 \p Less has the interface like \p std::less.
786 \p pred must imply the same element order as the comparator used for building the set.
788 @note This function is enabled if the compiler supports C++11
789 default template arguments for function template <b>and</b> the underlying container
790 supports \p %find_with feature.
792 template <typename Q, typename Less, typename Func
793 , typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_find_with >::type >
794 bool find_with( Q& val, Less pred, Func f )
796 return base_class::find_with( val, pred, f );
799 /// Find the key \p val
800 /** \anchor cds_nonintrusive_StripedSet_find_cfunc
802 The function searches the item with key equal to \p val and calls the functor \p f for item found.
803 The interface of \p Func functor is:
806 void operator()( value_type& item, Q const& val );
809 where \p item is the item found, \p val is the <tt>find</tt> function argument.
811 The functor can change non-key fields of \p item.
813 The type \p Q can differ from \p value_type of items storing in the container.
814 Therefore, the \p value_type should be comparable with type \p Q.
816 The function returns \p true if \p val is found, \p false otherwise.
818 template <typename Q, typename Func>
819 bool find( Q const& val, Func f )
821 return base_class::find( val, f );
824 /// Find the key \p val using \p pred predicate
826 The function is an analog of \ref cds_nonintrusive_StripedSet_find_cfunc "find(Q const&, Func)"
827 but \p pred is used for key comparing
828 \p Less has the interface like \p std::less.
829 \p pred must imply the same element order as the comparator used for building the set.
831 @note This function is enabled if the compiler supports C++11
832 default template arguments for function template <b>and</b> the underlying container
833 supports \p %find_with feature.
835 template <typename Q, typename Less, typename Func
836 , typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_find_with >::type >
837 bool find_with( Q const& val, Less pred, Func f )
839 return base_class::find_with( val, pred, f );
842 /// Checks whether the set contains \p key
844 The function searches the item with key equal to \p key
845 and returns \p true if it is found, and \p false otherwise.
847 Note the hash functor specified for class \p Traits template parameter
848 should accept a parameter of type \p Q that can be not the same as \p value_type.
849 Otherwise, you may use \p contains( Q const&, Less pred ) functions with explicit predicate for key comparing.
851 template <typename Q>
852 bool contains( Q const& key )
854 return base_class::contains( key );
857 template <typename Q>
858 CDS_DEPRECATED("use contains()")
859 bool find( Q const& key )
861 return contains( key );
865 /// Checks whether the map contains \p key using \p pred predicate for searching
867 The function is similar to <tt>contains( key )</tt> but \p pred is used for key comparing.
868 \p Less functor has the interface like \p std::less.
869 \p Less must imply the same element order as the comparator used for building the map.
871 template <typename Q, typename Less
872 , typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_find_with >::type >
873 bool contains( Q const& key, Less pred )
875 return base_class::contains( key, pred );
878 template <typename Q, typename Less
879 , typename Bucket = bucket_type, typename = typename std::enable_if< Bucket::has_find_with >::type >
880 CDS_DEPRECATED("use contains()")
881 bool find_with( Q const& val, Less pred )
883 return contains( val, pred );
889 The function erases all items from the set.
893 return base_class::clear();
896 /// Checks if the set is empty
898 Emptiness is checked by item counting: if item count is zero then the set is empty.
902 return base_class::empty();
905 /// Returns item count in the set
908 return base_class::size();
911 /// Returns the size of hash table
913 The hash table size is non-constant and can be increased via resizing.
915 size_t bucket_count() const
917 return base_class::bucket_count();
920 /// Returns lock array size
921 size_t lock_count() const
923 return base_class::lock_count();
926 /// Returns resizing policy object
927 resizing_policy& get_resizing_policy()
929 return base_class::get_resizing_policy();
932 /// Returns resizing policy (const version)
933 resizing_policy const& get_resizing_policy() const
935 return base_class::get_resizing_policy();
939 }} // namespace cds::container
942 #endif // #ifndef CDSLIB_CONTAINER_STRIPED_SET_H