2 This file is a part of libcds - Concurrent Data Structures library
4 (C) Copyright Maxim Khizhinsky (libcds.dev@gmail.com) 2006-2016
6 Source code repo: http://github.com/khizmax/libcds/
7 Download: http://sourceforge.net/projects/libcds/files/
9 Redistribution and use in source and binary forms, with or without
10 modification, are permitted provided that the following conditions are met:
12 * Redistributions of source code must retain the above copyright notice, this
13 list of conditions and the following disclaimer.
15 * Redistributions in binary form must reproduce the above copyright notice,
16 this list of conditions and the following disclaimer in the documentation
17 and/or other materials provided with the distribution.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
23 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #ifndef CDSLIB_INTRUSIVE_STRIPED_SET_H
32 #define CDSLIB_INTRUSIVE_STRIPED_SET_H
34 #include <cds/intrusive/details/base.h>
35 #include <cds/intrusive/striped_set/adapter.h>
36 #include <cds/intrusive/striped_set/striping_policy.h>
38 namespace cds { namespace intrusive {
39 /// StripedSet related definitions
40 namespace striped_set {
42 /** @defgroup cds_striped_resizing_policy Resizing policy for striped/refinable set/map
44 Resizing policy for \p intrusive::StripedSet, \p container::StripedSet and \p container::StripedMap.
47 } // namespace striped_set
50 /** @ingroup cds_intrusive_map
53 - [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
55 Lock striping is very simple technique.
56 The set consists of the bucket table and the array of locks.
57 Initially, the capacity of lock array and bucket table is the same.
58 When set is resized, bucket table capacity will be doubled but lock array will not.
59 The lock \p i protects each bucket \p j, where <tt> j = i mod L </tt>,
60 where \p L - the size of lock array.
63 - \p Container - the container class that is used as bucket table entry. The \p Container class should support
64 an uniform interface described below.
65 - \p Options - options
67 The \p %StripedSet class does not exactly dictate the type of container that should be used as a \p Container bucket.
68 Instead, the class supports different intrusive container type for the bucket, for exampe,
69 \p boost::intrusive::list, \p boost::intrusive::set and others.
71 Remember that \p %StripedSet class algorithm ensures sequential blocking access to its bucket through the mutex type you specify
72 among \p Options template arguments.
75 - \p opt::mutex_policy - concurrent access policy.
76 Available policies: \p striped_set::striping, \p striped_set::refinable.
77 Default is \p %striped_set::striping.
78 - \p cds::opt::hash - hash functor. Default option value see <tt>opt::v::hash_selector <opt::none></tt>
79 which selects default hash functor for your compiler.
80 - \p cds::opt::compare - key comparison functor. No default functor is provided.
81 If the option is not specified, the \p opt::less is used.
82 - \p cds::opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
83 - \p cds::opt::item_counter - item counter type. Default is \p atomicity::item_counter since some operation on the counter is performed
84 without locks. Note that item counting is an essential part of the set algorithm, so dummy counter like \p atomicity::empty_item_counter
86 - \p cds::opt::allocator - the allocator type using for memory allocation of bucket table and lock array. Default is \ref CDS_DEFAULT_ALLOCATOR.
87 - \p cds::opt::resizing_policy - the resizing policy - a functor that decides when to resize the hash set.
88 Default option value depends on bucket container type:
89 for sequential containers like \p boost::intrusive::list the resizing policy is <tt>cds::container::striped_set::load_factor_resizing<4> </tt>;
90 for other type of containers like \p boost::intrusive::set the resizing policy is cds::container::striped_set::no_resizing.
91 See \ref cds_striped_resizing_policy "available resizing policy".
92 Note that the choose of resizing policy depends of \p Container type:
93 for sequential containers like \p boost::intrusive::list the right policy can significantly improve performance.
94 For other, non-sequential types of \p Container (like a \p boost::intrusive::set) the resizing policy is not so important.
95 - \p cds::opt::buffer - a buffer type used only for \p boost::intrusive::unordered_set.
96 Default is <tt>cds::opt::v::static_buffer< cds::any_type, 256 > </tt>.
98 \p opt::compare or \p opt::less options are used in some \p Container class for ordering.
99 \p %opt::compare option has the highest priority: if \p %opt::compare is specified, \p %opt::less is not used.
101 You can pass other option that would be passed to \p adapt metafunction, see below.
103 <b>Internal details</b>
105 The \p %StripedSet class cannot utilize the \p Container specified directly, but only its adapted variant which
106 supports an unified interface. Internally, the adaptation is made via \p intrusive::striped_set::adapt metafunction that wraps bucket container
107 and provides the unified bucket interface suitable for \p %StripedSet. Such adaptation is completely transparent for you -
108 you don't need to call \p adapt metafunction directly, \p %StripedSet class's internal machinery itself invokes appropriate
109 \p adapt metafunction specialization to adjust your \p Container container class to \p %StripedSet bucket's internal interface.
110 All you need is to include a right header before <tt>striped_set.h</tt>.
112 By default, <tt>intrusive::striped_set::adapt<AnyContainer, OptionPack> </tt> metafunction does not make any wrapping to \p AnyContainer,
113 so, the result <tt>intrusive::striped_set::adapt<AnyContainer, OptionPack>::type </tt> is the same as \p AnyContainer.
114 However, there are a lot of specializations of \p %intrusive::striped_set::adapt for \p boost::intrusive containers, see table below.
115 Any of this specialization wraps corresponding container making it suitable for the set's bucket.
116 Remember, you should include the proper header file for \p adapt <b>before</b> including <tt>striped_set.h</tt>.
118 \note It is important to specify <tt>boost::intrusive::constant_time_size<true></tt> option
119 for all \p boost::intrusive container that supports this option. Fast item counting feature is essential part of
120 \p %StripedSet resizing algorithm.
125 <th>.h-file for \p adapt</th>
130 <td> \p boost::intrusive::list</td>
131 <td><tt><cds/intrusive/striped_set/boost_list.h></tt></td>
133 #include <cds/intrusive/striped_set/boost_list.h>
134 #include <cds/intrusive/striped_set.h>
135 typedef cds::intrusive::StripedSet<
136 boost::intrusive::list<T, boost::intrusive::constant_time_size<true> >,
137 cds::opt::less< std::less<T> >
143 Template argument pack \p Options <b>must</b> contain cds::opt::less or cds::opt::compare for type \p T stored in the list
147 <td> \p boost::intrusive::slist</td>
148 <td><tt><cds/intrusive/striped_set/boost_slist.h></tt></td>
150 #include <cds/intrusive/striped_set/boost_slist.h>
151 #include <cds/intrusive/striped_set.h>
152 typedef cds::intrusive::StripedSet<
153 boost::intrusive::slist<T, boost::intrusive::constant_time_size<true> >,
154 cds::opt::less< std::less<T> >
160 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
164 <td> \p boost::intrusive::set</td>
165 <td><tt><cds/intrusive/striped_set/boost_set.h></tt></td>
167 #include <cds/intrusive/striped_set/boost_set.h>
168 #include <cds/intrusive/striped_set.h>
169 typedef cds::intrusive::StripedSet<
170 boost::intrusive::set<T, boost::intrusive::constant_time_size<true> >
175 Note that \p boost::intrusive::compare option using in \p boost::intrusive::set
176 should support \p T type stored in the set and any type \p Q that you can use
177 in \p erase() and \p find() member functions.
181 <td> \p boost::intrusive::unordered_set</td>
182 <td><tt><cds/intrusive/striped_set/boost_unordered_set.h></tt></td>
184 #include <cds/intrusive/striped_set/boost_unordered_set.h>
185 #include <cds/intrusive/striped_set.h>
186 typedef cds::intrusive::StripedSet<
187 boost::intrusive::unordered_set<T
188 ,boost::intrusive::constant_time_size<true>
189 ,boost::intrusive::hash< user_provided_hash_functor >
195 You should provide two different hash function \p h1 and \p h2 - one for \p boost::intrusive::unordered_set
196 and other for \p %StripedSet. 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
198 The option \p opt::buffer is used for \p boost::intrusive::bucket_traits. Default is <tt> cds::opt::v::static_buffer< cds::any_type, 256 > </tt>.
199 The resizing policy should correlate with the buffer capacity.
200 The default resizing policy is <tt>cds::container::striped_set::load_factor_resizing<256> </tt> what gives load factor 1 for
201 default bucket buffer that is the best for \p boost::intrusive::unordered_set.
205 <td> \p boost::intrusive::avl_set</td>
206 <td><tt><cds/intrusive/striped_set/boost_avl_set.h></tt></td>
208 #include <cds/intrusive/striped_set/boost_avl_set.h>
209 #include <cds/intrusive/striped_set.h>
210 typedef cds::intrusive::StripedSet<
211 boost::intrusive::avl_set<T, boost::intrusive::constant_time_size<true> >
216 Note that \p boost::intrusive::compare option using in \p boost::intrusive::avl_set
217 should support \p T type stored in the set and any type \p Q that you can use
218 in \p erase() and \p find() member functions.
222 <td> \p boost::intrusive::sg_set</td>
223 <td><tt><cds/intrusive/striped_set/boost_sg_set.h></tt></td>
225 #include <cds/intrusive/striped_set/boost_sg_set.h>
226 #include <cds/intrusive/striped_set.h>
227 typedef cds::intrusive::StripedSet<
228 boost::intrusive::sg_set<T, boost::intrusive::constant_time_size<true> >
233 Note that \p boost::intrusive::compare option using in \p boost::intrusive::sg_set
234 should support \p T type stored in the set and any type \p Q that you can use
235 in \p erase() and \p find() member functions.
239 <td> \p boost::intrusive::splay_set</td>
240 <td><tt><cds/intrusive/striped_set/boost_splay_set.h></tt></td>
242 #include <cds/intrusive/striped_set/boost_splay_set.h>
243 #include <cds/intrusive/striped_set.h>
244 typedef cds::intrusive::StripedSet<
245 boost::intrusive::splay_set<T, boost::intrusive::constant_time_size<true> >
250 Note that \p boost::intrusive::compare option using in \p boost::intrusive::splay_set
251 should support \p T type stored in the set and any type \p Q that you can use
252 in \p erase() and \p find() member functions.
256 <td> \p boost::intrusive::treap_set</td>
257 <td><tt><cds/intrusive/striped_set/boost_treap_set.h></tt></td>
259 #include <cds/intrusive/striped_set/boost_treap_set.h>
260 #include <cds/intrusive/striped_set.h>
261 typedef cds::intrusive::StripedSet<
262 boost::intrusive::treap_set<T, boost::intrusive::constant_time_size<true> >
267 Note that \p boost::intrusive::compare option using in \p boost::intrusive::treap_set
268 should support \p T type stored in the set and any type \p Q that you can use
269 in \p erase() and \p find() member functions.
274 You can use another intrusive container type as striped set's bucket.
275 Suppose, you have a container class \p MyBestContainer and you want to integrate it with \p StripedSet as bucket type.
276 There are two possibility:
277 - either your \p MyBestContainer class has native support of bucket's interface;
278 in this case, you can use default \p intrusive::striped_set::adapt metafunction;
279 - or your \p MyBestContainer class does not support bucket's interface, which means, that you should create a specialization of
280 <tt>cds::intrusive::striped_set::adapt<MyBestContainer> </tt> metafunction providing necessary interface.
282 The <tt>intrusive::striped_set::adapt< Container, OptionPack ></tt> metafunction has two template argument:
283 - \p Container is the class that should be used as the bucket, for example, <tt>boost::intrusive::list< T ></tt>.
284 - \p OptionPack is the packed options from \p %StripedSet declaration. The \p adapt metafunction can use
285 any option from \p OptionPack for its internal use. For example, a \p compare option can be passed to \p adapt
286 metafunction via \p OptionPack argument of \p %StripedSet declaration.
288 See \p intrusive::striped_set::adapt metafunction for the description of interface that the bucket container must provide
289 to be \p %StripedSet compatible.
291 template <class Container, typename... Options>
296 struct default_options {
297 typedef striped_set::striping<> mutex_policy;
298 typedef typename cds::opt::v::hash_selector< cds::opt::none >::type hash;
299 typedef cds::atomicity::item_counter item_counter;
300 typedef CDS_DEFAULT_ALLOCATOR allocator;
301 typedef cds::opt::none resizing_policy;
302 typedef cds::opt::none compare;
303 typedef cds::opt::none less;
306 typedef typename cds::opt::make_options<
307 typename cds::opt::find_type_traits< default_options, Options... >::type
312 typedef Container underlying_container_type ; ///< original intrusive container type for the bucket
313 typedef typename cds::intrusive::striped_set::adapt< underlying_container_type, Options... >::type bucket_type ; ///< container type adapted for hash set
314 typedef typename bucket_type::value_type value_type ; ///< value type stored in the set
316 typedef typename options::hash hash ; ///< Hash functor
317 typedef typename options::item_counter item_counter ; ///< Item counter
318 typedef typename cds::opt::select_default<
319 typename options::resizing_policy,
320 typename bucket_type::default_resizing_policy
321 >::type resizing_policy ; ///< Resizing policy
322 typedef typename options::allocator allocator_type ; ///< allocator type specified in options.
323 typedef typename options::mutex_policy mutex_policy ; ///< Mutex policy
325 typedef cds::details::Allocator< bucket_type, allocator_type > bucket_allocator; ///< bucket allocator type based on allocator_type
328 bucket_type * m_Buckets ; ///< Bucket table
329 size_t m_nBucketMask ; ///< Bucket table size - 1. m_nBucketMask + 1 should be power of two.
330 item_counter m_ItemCounter ; ///< Item counter
331 hash m_Hash ; ///< Hash functor
333 mutex_policy m_MutexPolicy ; ///< Mutex policy
334 resizing_policy m_ResizingPolicy; ///< Resizing policy
336 static const size_t c_nMinimalCapacity = 16 ; ///< Minimal capacity
340 typedef typename mutex_policy::scoped_cell_lock scoped_cell_lock;
341 typedef typename mutex_policy::scoped_full_lock scoped_full_lock;
342 typedef typename mutex_policy::scoped_resize_lock scoped_resize_lock;
347 static size_t calc_init_capacity( size_t nCapacity )
349 nCapacity = cds::beans::ceil2( nCapacity );
350 return nCapacity < c_nMinimalCapacity ? c_nMinimalCapacity : nCapacity;
353 void alloc_bucket_table( size_t nSize )
355 assert( cds::beans::is_power2( nSize ));
356 m_nBucketMask = nSize - 1;
357 m_Buckets = bucket_allocator().NewArray( nSize );
360 static void free_bucket_table( bucket_type * pBuckets, size_t nSize )
362 bucket_allocator().Delete( pBuckets, nSize );
365 template <typename Q>
366 size_t hashing( Q const& v ) const
371 bucket_type * bucket( size_t nHash ) const CDS_NOEXCEPT
373 return m_Buckets + (nHash & m_nBucketMask);
376 template <typename Q, typename Func>
377 bool find_( Q& val, Func f )
379 size_t nHash = hashing( val );
381 scoped_cell_lock sl( m_MutexPolicy, nHash );
382 return bucket( nHash )->find( val, f );
385 template <typename Q, typename Less, typename Func>
386 bool find_with_( Q& val, Less pred, Func f )
388 size_t nHash = hashing( val );
389 scoped_cell_lock sl( m_MutexPolicy, nHash );
390 return bucket( nHash )->find( val, pred, f );
393 void internal_resize( size_t nNewCapacity )
395 // All locks are already locked!
396 m_MutexPolicy.resize( nNewCapacity );
398 size_t nOldCapacity = bucket_count();
399 bucket_type * pOldBuckets = m_Buckets;
401 alloc_bucket_table( nNewCapacity );
403 typedef typename bucket_type::iterator bucket_iterator;
404 bucket_type * pEnd = pOldBuckets + nOldCapacity;
405 for ( bucket_type * pCur = pOldBuckets; pCur != pEnd; ++pCur ) {
406 bucket_iterator itEnd = pCur->end();
407 bucket_iterator itNext;
408 for ( bucket_iterator it = pCur->begin(); it != itEnd; it = itNext ) {
411 bucket( m_Hash( *it ) )->move_item( *pCur, it );
416 free_bucket_table( pOldBuckets, nOldCapacity );
418 m_ResizingPolicy.reset();
423 size_t nOldCapacity = bucket_count();
424 size_t volatile& refBucketMask = m_nBucketMask;
426 scoped_resize_lock al( m_MutexPolicy );
427 if ( al.success() ) {
428 if ( nOldCapacity != refBucketMask + 1 ) {
429 // someone resized already
433 internal_resize( nOldCapacity * 2 );
440 /// Default ctor. The initial capacity is 16.
442 : m_Buckets( nullptr )
443 , m_nBucketMask( c_nMinimalCapacity - 1 )
444 , m_MutexPolicy( c_nMinimalCapacity )
446 alloc_bucket_table( m_nBucketMask + 1 );
449 /// Ctor with initial capacity specified
451 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
453 : m_Buckets( nullptr )
454 , m_nBucketMask( calc_init_capacity(nCapacity) - 1 )
455 , m_MutexPolicy( m_nBucketMask + 1 )
457 alloc_bucket_table( m_nBucketMask + 1 );
460 /// Ctor with resizing policy (copy semantics)
462 This constructor initializes m_ResizingPolicy member with copy of \p resizingPolicy parameter
465 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
466 ,resizing_policy const& resizingPolicy ///< Resizing policy
468 : m_Buckets( nullptr )
469 , m_nBucketMask( ( nCapacity ? calc_init_capacity(nCapacity) : c_nMinimalCapacity ) - 1 )
470 , m_MutexPolicy( m_nBucketMask + 1 )
471 , m_ResizingPolicy( resizingPolicy )
473 alloc_bucket_table( m_nBucketMask + 1 );
476 /// Ctor with resizing policy (move semantics)
478 This constructor initializes m_ResizingPolicy member moving \p resizingPolicy parameter
479 Move semantics is used.
482 size_t nCapacity ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
483 ,resizing_policy&& resizingPolicy ///< Resizing policy
485 : m_Buckets( nullptr )
486 , m_nBucketMask( ( nCapacity ? calc_init_capacity(nCapacity) : c_nMinimalCapacity ) - 1 )
487 , m_MutexPolicy( m_nBucketMask + 1 )
488 , m_ResizingPolicy( std::forward<resizing_policy>( resizingPolicy ) )
490 alloc_bucket_table( m_nBucketMask + 1 );
493 /// Destructor destroys internal data
496 free_bucket_table( m_Buckets, m_nBucketMask + 1 );
502 The function inserts \p val in the set if it does not contain
503 an item with key equal to \p val.
505 Returns \p true if \p val is placed into the set, \p false otherwise.
507 bool insert( value_type& val )
509 return insert( val, []( value_type& ) {} );
514 The function allows to split creating of new item into two part:
515 - create item with key only
516 - insert new item into the set
517 - if inserting is success, calls \p f functor to initialize value-field of \p val.
519 The functor signature is:
521 void func( value_type& val );
523 where \p val is the item inserted.
525 template <typename Func>
526 bool insert( value_type& val, Func f )
530 size_t nHash = hashing( val );
531 bucket_type * pBucket;
533 scoped_cell_lock sl( m_MutexPolicy, nHash );
534 pBucket = bucket( nHash );
535 bOk = pBucket->insert( val, f );
536 bResize = bOk && m_ResizingPolicy( ++m_ItemCounter, *this, *pBucket );
546 The operation performs inserting or changing data with lock-free manner.
548 If the item \p val is not found in the set, then \p val is inserted
549 iff \p bAllowInsert is \p true.
550 Otherwise, the functor \p func is called with item found.
551 The functor signature is:
553 void func( bool bNew, value_type& item, value_type& val );
556 - \p bNew - \p true if the item has been inserted, \p false otherwise
557 - \p item - item of the set
558 - \p val - argument \p val passed into the \p update() function
559 If new item has been inserted (i.e. \p bNew is \p true) then \p item and \p val arguments
560 refers to the same thing.
562 The functor may change non-key fields of the \p item.
564 Returns std::pair<bool, bool> where \p first is \p true if operation is successfull,
565 \p second is \p true if new item has been added or \p false if the item with \p val
566 already is in the set.
568 template <typename Func>
569 std::pair<bool, bool> update( value_type& val, Func func, bool bAllowInsert = true )
571 std::pair<bool, bool> result;
573 size_t nHash = hashing( val );
574 bucket_type * pBucket;
576 scoped_cell_lock sl( m_MutexPolicy, nHash );
577 pBucket = bucket( nHash );
579 result = pBucket->update( val, func, bAllowInsert );
580 bResize = result.first && result.second && m_ResizingPolicy( ++m_ItemCounter, *this, *pBucket );
588 template <typename Func>
589 std::pair<bool, bool> ensure( value_type& val, Func func )
591 return update( val, func, true );
595 /// Unlink the item \p val from the set
597 The function searches the item \p val in the set and unlink it
598 if it is found and is equal to \p val (here, the equality means that
599 \p val belongs to the set: if \p item is an item found then
600 unlink is successful iif <tt>&val == &item</tt>)
602 The function returns \p true if success and \p false otherwise.
604 bool unlink( value_type& val )
607 size_t nHash = hashing( val );
609 scoped_cell_lock sl( m_MutexPolicy, nHash );
610 bOk = bucket( nHash )->unlink( val );
618 /// Deletes the item from the set
619 /** \anchor cds_intrusive_StripedSet_erase
620 The function searches an item with key equal to \p val in the set,
621 unlinks it from the set, and returns a pointer to unlinked item.
623 If the item with key equal to \p val is not found the function return \p nullptr.
625 Note the hash functor should accept a parameter of type \p Q that can be not the same as \p value_type.
627 template <typename Q>
628 value_type * erase( Q const& val )
630 return erase( val, [](value_type const&) {} );
633 /// Deletes the item from the set using \p pred predicate for searching
635 The function is an analog of \ref cds_intrusive_StripedSet_erase "erase(Q const&)"
636 but \p pred is used for key comparing
637 \p Less has the interface like \p std::less.
638 \p pred must imply the same element order as the comparator used for building the set.
640 template <typename Q, typename Less>
641 value_type * erase_with( Q const& val, Less pred )
643 return erase_with( val, pred, [](value_type const&) {} );
646 /// Deletes the item from the set
647 /** \anchor cds_intrusive_StripedSet_erase_func
649 The function searches an item with key equal to \p val in the set,
650 call \p f functor with item found, unlinks it from the set, and returns a pointer to unlinked item.
652 The \p Func interface is
655 void operator()( value_type const& item );
659 If the item with key equal to \p val is not found the function return \p false.
661 Note the hash functor should accept a parameter of type \p Q that can be not the same as \p value_type.
663 template <typename Q, typename Func>
664 value_type * erase( Q const& val, Func f )
666 size_t nHash = hashing( val );
669 scoped_cell_lock sl( m_MutexPolicy, nHash );
670 pVal = bucket( nHash )->erase( val, f );
678 /// Deletes the item from the set using \p pred predicate for searching
680 The function is an analog of \ref cds_intrusive_StripedSet_erase_func "erase(Q const&, Func)"
681 but \p pred is used for key comparing
682 \p Less has the interface like \p std::less.
683 \p pred must imply the same element order as the comparator used for building the set.
685 template <typename Q, typename Less, typename Func>
686 value_type * erase_with( Q const& val, Less pred, Func f )
688 size_t nHash = hashing( val );
691 scoped_cell_lock sl( m_MutexPolicy, nHash );
692 pVal = bucket( nHash )->erase( val, pred, f );
700 /// Find the key \p val
701 /** \anchor cds_intrusive_StripedSet_find_func
702 The function searches the item with key equal to \p val and calls the functor \p f for item found.
703 The interface of \p Func functor is:
706 void operator()( value_type& item, Q& val );
709 where \p item is the item found, \p val is the <tt>find</tt> function argument.
711 The functor may change non-key fields of \p item.
713 The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
714 may modify both arguments.
716 Note the hash functor specified for class \p Traits template parameter
717 should accept a parameter of type \p Q that can be not the same as \p value_type.
719 The function returns \p true if \p val is found, \p false otherwise.
721 template <typename Q, typename Func>
722 bool find( Q& val, Func f )
724 return find_( val, f );
727 /// Find the key \p val using \p pred predicate
729 The function is an analog of \ref cds_intrusive_StripedSet_find_func "find(Q&, Func)"
730 but \p pred is used for key comparing
731 \p Less has the interface like \p std::less.
732 \p pred must imply the same element order as the comparator used for building the set.
734 template <typename Q, typename Less, typename Func>
735 bool find_with( Q& val, Less pred, Func f )
737 return find_with_( val, pred, f );
740 /// Find the key \p val
741 /** \anchor cds_intrusive_StripedSet_find_cfunc
742 The function searches the item with key equal to \p val and calls the functor \p f for item found.
743 The interface of \p Func functor is:
746 void operator()( value_type& item, Q const& val );
749 where \p item is the item found, \p val is the <tt>find</tt> function argument.
751 The functor may change non-key fields of \p item.
753 The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
754 may modify both arguments.
756 The function returns \p true if \p val is found, \p false otherwise.
758 template <typename Q, typename Func>
759 bool find( Q const& val, Func f )
761 return find_( val, f );
764 /// Find the key \p val using \p pred predicate
766 The function is an analog of \ref cds_intrusive_StripedSet_find_cfunc "find(Q const&, Func)"
767 but \p pred is used for key comparing
768 \p Less has the interface like \p std::less.
769 \p pred must imply the same element order as the comparator used for building the set.
771 template <typename Q, typename Less, typename Func>
772 bool find_with( Q const& val, Less pred, Func f )
774 return find_with_( val, pred, f );
777 /// Checks whether the set contains \p key
779 The function searches the item with key equal to \p key
780 and returns \p true if it is found, and \p false otherwise.
782 Note the hash functor specified for class \p Traits template parameter
783 should accept a parameter of type \p Q that can be not the same as \p value_type.
784 Otherwise, you may use \p contains( Q const&, Less pred ) functions with explicit predicate for key comparing.
786 template <typename Q>
787 bool contains( Q const& key )
789 return find( key, [](value_type&, Q const& ) {} );
792 template <typename Q>
793 CDS_DEPRECATED("use contains()")
794 bool find( Q const& val )
796 return contains( val );
800 /// Checks whether the set contains \p key using \p pred predicate for searching
802 The function is an analog of <tt>contains( key )</tt> but \p pred is used for key comparing.
803 \p Less functor has the interface like \p std::less.
804 \p Less must imply the same element order as the comparator used for building the set.
806 template <typename Q, typename Less>
807 bool contains( Q const& key, Less pred )
809 return find_with( key, pred, [](value_type& , Q const& ) {} );
812 template <typename Q, typename Less>
813 CDS_DEPRECATED("use contains()")
814 bool find_with( Q const& val, Less pred )
816 return contains( val, pred );
822 The function unlinks all items from the set.
826 // locks entire array
827 scoped_full_lock sl( m_MutexPolicy );
829 size_t nBucketCount = bucket_count();
830 bucket_type * pBucket = m_Buckets;
831 for ( size_t i = 0; i < nBucketCount; ++i, ++pBucket )
833 m_ItemCounter.reset();
836 /// Clears the set and calls \p disposer for each item
838 The function unlinks all items from the set calling \p disposer for each item.
839 \p Disposer functor interface is:
842 void operator()( value_type * p );
846 template <typename Disposer>
847 void clear_and_dispose( Disposer disposer )
849 // locks entire array
850 scoped_full_lock sl( m_MutexPolicy );
852 size_t nBucketCount = bucket_count();
853 bucket_type * pBucket = m_Buckets;
854 for ( size_t i = 0; i < nBucketCount; ++i, ++pBucket )
855 pBucket->clear( disposer );
856 m_ItemCounter.reset();
859 /// Checks if the set is empty
861 Emptiness is checked by item counting: if item count is zero then the set is empty.
868 /// Returns item count in the set
871 return m_ItemCounter;
874 /// Returns the size of hash table
876 The hash table size is non-constant and can be increased via resizing.
878 size_t bucket_count() const
880 return m_nBucketMask + 1;
883 /// Returns lock array size
884 size_t lock_count() const
886 return m_MutexPolicy.lock_count();
889 /// Returns resizing policy object
890 resizing_policy& get_resizing_policy()
892 return m_ResizingPolicy;
895 /// Returns resizing policy (const version)
896 resizing_policy const& get_resizing_policy() const
898 return m_ResizingPolicy;
901 }} // namespace cds::itrusive
903 #endif // #ifndef CDSLIB_INTRUSIVE_STRIPED_SET_H