cds/intrusive/striped_set.h

   1 //$$CDS-header$$
   2
   3 #ifndef __CDS_INTRUSIVE_STRIPED_SET_H
   4 #define __CDS_INTRUSIVE_STRIPED_SET_H
   5
   6 #include <cds/intrusive/details/base.h>
   7 #include <cds/intrusive/striped_set/adapter.h>
   8 #include <cds/intrusive/striped_set/striping_policy.h>
   9
  10 namespace cds { namespace intrusive {
  11     /// StripedSet related definitions
  12     namespace striped_set {
  13     }   // namespace striped_set
  14
  15     /// Striped hash set
  16     /** @ingroup cds_intrusive_map
  17
  18         Source
  19             - [2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"
  20
  21         Lock striping is very simple technique.
  22         The set consists of the bucket table and the array of locks.
  23         Initially, the capacity of lock array and bucket table is the same.
  24         When set is resized, bucket table capacity will be doubled but lock array will not.
  25         The lock \p i protects each bucket \p j, where <tt> j = i mod L </tt>,
  26         where \p L - the size of lock array.
  27
  28         Template arguments:
  29             - \p Container - the container class that is used as bucket table entry. The \p Container class should support
  30                 an uniform interface described below.
  31             - \p Options - options
  32
  33         The \p %StripedSet class does not exactly dictate the type of container that should be used as a \p Container bucket.
  34         Instead, the class supports different intrusive container type for the bucket, for exampe, \p boost::intrusive::list, \p boost::intrusive::set and others.
  35
  36         Remember that \p %StripedSet class algorithm ensures sequential blocking access to its bucket through the mutex type you specify
  37         among \p Options template arguments.
  38
  39         The \p Options are:
  40         - opt::mutex_policy - concurrent access policy.
  41             Available policies: striped_set::striping, striped_set::refinable.
  42             Default is striped_set::striping.
  43         - cds::opt::hash - hash functor. Default option value see <tt>opt::v::hash_selector <opt::none></tt> which selects default hash functor for
  44             your compiler.
  45         - cds::opt::compare - key comparison functor. No default functor is provided.
  46             If the option is not specified, the opt::less is used.
  47         - cds::opt::less - specifies binary predicate used for key comparison. Default is \p std::less<T>.
  48         - cds::opt::item_counter - item counter type. Default is \p atomicity::item_counter since some operation on the counter is performed
  49             without locks. Note that item counting is an essential part of the set algorithm, so dummy type like atomicity::empty_item_counter
  50             is not suitable.
  51         - cds::opt::allocator - the allocator type using for memory allocation of bucket table and lock array. Default is CDS_DEFAULT_ALLOCATOR.
  52         - cds::opt::resizing_policy - the resizing policy that is a functor that decides when to resize the hash set.
  53             Default option value depends on bucket container type:
  54                 for sequential containers like \p boost::intrusive::list the resizing policy is <tt>cds::container::striped_set::load_factor_resizing <4></tt>;
  55                 for other type of containers like \p boost::intrusive::set  the resizing policy is cds::container::striped_set::no_resizing.
  56             See cds::container::striped_set namespace for list of all possible types of the option.
  57             Note that the choose of resizing policy depends of \p Container type:
  58             for sequential containers like \p boost::intrusive::list right choosing of the policy can significantly improve performance.
  59             For other, non-sequential types of \p Container (like a \p boost::intrusive::set) the resizing policy is not so important.
  60         - cds::opt::buffer - a buffer type used only for boost::intrusive::unordered_set.
  61             Default is cds::opt::v::static_buffer< cds::any_type, 256 >.
  62
  63             opt::compare or opt::less options are used in some \p Container class for ordering.
  64             opt::compare option has the highest priority: if opt::compare is specified, opt::less is not used.
  65
  66             You can pass other option that would be passed to <tt>adapt</tt> metafunction, see below.
  67
  68         <b>Internal details</b>
  69
  70             The \p %StripedSet class cannot utilize the \p Container container specified directly, but only its adapted variant which
  71             supports an unified interface. Internally, the adaptation is made via intrusive::striped_set::adapt metafunction that wraps bucket container
  72             and provides the unified bucket interface suitable for \p %StripedSet. Such adaptation is completely transparent for you -
  73             you don't need to call \p adapt metafunction directly, \p %StripedSet class's internal machinery itself invokes appropriate
  74             \p adapt metafunction specialization to adjust your \p Container container class to \p %StripedSet bucket's internal interface.
  75             All you need is to include a right header before <tt>striped_set.h</tt>.
  76
  77             By default, <tt>intrusive::striped_set::adapt<AnyContainer, OptionPack> </tt> metafunction does not make any wrapping to \p AnyContainer,
  78             so, the result <tt>intrusive::striped_set::adapt<AnyContainer, OptionPack>::type </tt> is the same as \p AnyContainer.
  79             However, there are a lot of specializations of \p %intrusive::striped_set::adapt for \p boost::intrusive containers, see table below.
  80             Any of this specialization wraps corresponding container making it suitable for the set's bucket.
  81             Remember, you should include the proper header file for \p adapt <b>before</b> including <tt>striped_set.h</tt>.
  82
  83             \note It is important to specify <tt>boost::intrusive::constant_time_size<true></tt> option
  84             for all \p boost::intrusive container that supports this option. Fast item counting feature is essential part of
  85             \p %StripedSet resizing algorithm.
  86
  87             <table>
  88                 <tr>
  89                     <th>Container</th>
  90                     <th>.h-file for \p adapt</th>
  91                     <th>Example</th>
  92                     <th>Notes</th>
  93                 </tr>
  94                 <tr>
  95                     <td> \p boost::intrusive::list</td>
  96                     <td><tt><cds/intrusive/striped_set/boost_list.h></tt></td>
  97                     <td>\code
  98                         #include <cds/intrusive/striped_set/boost_list.h>
  99                         #include <cds/intrusive/striped_set.h>
 100                         typedef cds::intrusive::StripedSet<
 101                         boost::intrusive::list<T, boost::intrusive::constant_time_size<true> >,
 102                             cds::opt::less< std::less<T> >
 103                         > striped_set;
 104                     \endcode
 105                     </td>
 106                     <td>
 107                         The list is ordered.
 108                         Template argument pack \p Options <b>must</b> contain cds::opt::less or cds::opt::compare for type \p T stored in the list
 109                     </td>
 110                 </tr>
 111                 <tr>
 112                     <td> \p boost::intrusive::slist</td>
 113                     <td><tt><cds/intrusive/striped_set/boost_slist.h></tt></td>
 114                     <td>\code
 115                         #include <cds/intrusive/striped_set/boost_slist.h>
 116                         #include <cds/intrusive/striped_set.h>
 117                         typedef cds::intrusive::StripedSet<
 118                             boost::intrusive::slist<T, boost::intrusive::constant_time_size<true> >,
 119                             cds::opt::less< std::less<T> >
 120                         > striped_set;
 121                     \endcode
 122                     </td>
 123                     <td>
 124                         The list is ordered.
 125                         Template argument pack \p Options <b>must</b> contain cds::opt::less or cds::opt::compare for type \p T stored in the list
 126                     </td>
 127                 </tr>
 128                 <tr>
 129                     <td> \p boost::intrusive::set</td>
 130                     <td><tt><cds/intrusive/striped_set/boost_set.h></tt></td>
 131                     <td>\code
 132                         #include <cds/intrusive/striped_set/boost_set.h>
 133                         #include <cds/intrusive/striped_set.h>
 134                         typedef cds::intrusive::StripedSet<
 135                             boost::intrusive::set<T, boost::intrusive::constant_time_size<true> >
 136                         > striped_set;
 137                     \endcode
 138                     </td>
 139                     <td>
 140                         Note that \p boost::intrusive::compare option using in \p boost::intrusive::set
 141                         should support \p T type stored in the set and any type \p Q that you can use
 142                         in \p erase and \p find member functions.
 143                     </td>
 144                 </tr>
 145                 <tr>
 146                     <td> \p boost::intrusive::unordered_set</td>
 147                     <td><tt><cds/intrusive/striped_set/boost_unordered_set.h></tt></td>
 148                     <td>\code
 149                         #include <cds/intrusive/striped_set/boost_unordered_set.h>
 150                         #include <cds/intrusive/striped_set.h>
 151                         typedef cds::intrusive::StripedSet<
 152                             boost::intrusive::unordered_set<T
 153                                 ,boost::intrusive::constant_time_size<true>
 154                                 ,boost::intrusive::hash< user_provided_hash_functor >
 155                             >
 156                         > striped_set;
 157                     \endcode
 158                     </td>
 159                     <td>
 160                         You should provide two different hash function h1 and h2 - one for boost::intrusive::unordered_set
 161                         and other for %StripedSet. For the best result, h1 and h2 must be orthogonal i.e. h1(X) != h2(X) for any value X
 162
 163                         The option opt::buffer is used for boost::intrusive::bucket_traits. Default is cds::opt::v::static_buffer< cds::any_type, 256 >.
 164                         The resizing policy should correlate with the buffer capacity.
 165                         The default resizing policy is cds::container::striped_set::load_factor_resizing<256> what gives load factor 1 for
 166                         default bucket buffer that is the best for \p boost::intrusive::unordered_set.
 167                     </td>
 168                 </tr>
 169                 <tr>
 170                     <td> \p boost::intrusive::avl_set</td>
 171                     <td><tt><cds/intrusive/striped_set/boost_avl_set.h></tt></td>
 172                     <td>\code
 173                         #include <cds/intrusive/striped_set/boost_avl_set.h>
 174                         #include <cds/intrusive/striped_set.h>
 175                         typedef cds::intrusive::StripedSet<
 176                             boost::intrusive::avl_set<T, boost::intrusive::constant_time_size<true> >
 177                         > striped_set;
 178                     \endcode
 179                     </td>
 180                     <td>
 181                         Note that \p boost::intrusive::compare option using in \p boost::intrusive::avl_set
 182                         should support \p T type stored in the set and any type \p Q that you can use
 183                         in \p erase and \p find member functions.
 184                     </td>
 185                 </tr>
 186                 <tr>
 187                     <td> \p boost::intrusive::sg_set</td>
 188                     <td><tt><cds/intrusive/striped_set/boost_sg_set.h></tt></td>
 189                     <td>\code
 190                         #include <cds/intrusive/striped_set/boost_sg_set.h>
 191                         #include <cds/intrusive/striped_set.h>
 192                         typedef cds::intrusive::StripedSet<
 193                             boost::intrusive::sg_set<T, boost::intrusive::constant_time_size<true> >
 194                         > striped_set;
 195                     \endcode
 196                     </td>
 197                     <td>
 198                         Note that \p boost::intrusive::compare option using in \p boost::intrusive::sg_set
 199                         should support \p T type stored in the set and any type \p Q that you can use
 200                         in \p erase and \p find member functions.
 201                     </td>
 202                 </tr>
 203                 <tr>
 204                     <td> \p boost::intrusive::splay_set</td>
 205                     <td><tt><cds/intrusive/striped_set/boost_splay_set.h></tt></td>
 206                     <td>\code
 207                         #include <cds/intrusive/striped_set/boost_splay_set.h>
 208                         #include <cds/intrusive/striped_set.h>
 209                         typedef cds::intrusive::StripedSet<
 210                             boost::intrusive::splay_set<T, boost::intrusive::constant_time_size<true> >
 211                         > striped_set;
 212                     \endcode
 213                     </td>
 214                     <td>
 215                         Note that \p boost::intrusive::compare option using in \p boost::intrusive::splay_set
 216                         should support \p T type stored in the set and any type \p Q that you can use
 217                         in \p erase and \p find member functions.
 218                     </td>
 219                 </tr>
 220                 <tr>
 221                     <td> \p boost::intrusive::treap_set</td>
 222                     <td><tt><cds/intrusive/striped_set/boost_treap_set.h></tt></td>
 223                     <td>\code
 224                         #include <cds/intrusive/striped_set/boost_treap_set.h>
 225                         #include <cds/intrusive/striped_set.h>
 226                         typedef cds::intrusive::StripedSet<
 227                             boost::intrusive::treap_set<T, boost::intrusive::constant_time_size<true> >
 228                         > striped_set;
 229                     \endcode
 230                     </td>
 231                     <td>
 232                         Note that \p boost::intrusive::compare option using in \p boost::intrusive::treap_set
 233                         should support \p T type stored in the set and any type \p Q that you can use
 234                         in \p erase and \p find member functions.
 235                     </td>
 236                 </tr>
 237             </table>
 238
 239             You can use another intrusive container type as striped set's bucket.
 240             Suppose, you have a container class \p MyBestContainer and you want to integrate it with \p StripedSet as bucket type.
 241             There are two possibility:
 242             - either your \p MyBestContainer class has native support of bucket's interface;
 243                 in this case, you can use default \p intrusive::striped_set::adapt metafunction;
 244             - or your \p MyBestContainer class does not support bucket's interface, which means, that you should develop a specialization
 245                 <tt>cds::intrusive::striped_set::adapt<MyBestContainer> </tt> metafunction providing necessary interface.
 246
 247             The <tt>intrusive::striped_set::adapt< Container, OptionPack ></tt> metafunction has two template argument:
 248             - \p Container is the class that should be used as the bucket, for example, <tt>boost::intrusive::list< T ></tt>.
 249             - \p OptionPack is the packed options from \p %StripedSet declaration. The \p adapt metafunction can use
 250                 any option from \p OptionPack for its internal use. For example, a \p compare option can be passed to \p adapt
 251                 metafunction via \p OptionPack argument of \p %StripedSet declaration.
 252
 253             See intrusive::striped_set::adapt metafunction for the description of interface that the bucket container must provide
 254             to be \p %StripedSet compatible.
 255     */
 256     template <class Container, typename... Options>
 257     class StripedSet
 258     {
 259     public:
 260         //@cond
 261         struct default_options {
 262             typedef striped_set::striping<>         mutex_policy;
 263             typedef typename cds::opt::v::hash_selector< cds::opt::none >::type   hash;
 264             typedef cds::atomicity::item_counter    item_counter;
 265             typedef CDS_DEFAULT_ALLOCATOR           allocator;
 266             typedef cds::opt::none                  resizing_policy;
 267             typedef cds::opt::none                  compare;
 268             typedef cds::opt::none                  less;
 269         };
 270
 271         typedef typename cds::opt::make_options<
 272             typename cds::opt::find_type_traits< default_options, Options... >::type
 273             ,Options...
 274         >::type   options;
 275         //@endcond
 276
 277         typedef Container                           underlying_container_type   ;   ///< original intrusive container type for the bucket
 278         typedef typename cds::intrusive::striped_set::adapt< underlying_container_type, Options... >::type   bucket_type ;   ///< container type adapted for hash set
 279         typedef typename bucket_type::value_type    value_type  ;   ///< value type stored in the set
 280
 281         typedef typename options::hash              hash            ; ///< Hash functor
 282         typedef typename options::item_counter      item_counter    ; ///< Item counter
 283         typedef typename cds::opt::select_default<
 284             typename options::resizing_policy,
 285             typename bucket_type::default_resizing_policy
 286         >::type                                     resizing_policy ; ///< Resizing policy
 287         typedef typename options::allocator         allocator_type  ; ///< allocator type specified in options.
 288         typedef typename options::mutex_policy      mutex_policy    ; ///< Mutex policy
 289
 290         typedef cds::details::Allocator< bucket_type, allocator_type > bucket_allocator;  ///< bucket allocator type based on allocator_type
 291
 292     protected:
 293         bucket_type *   m_Buckets       ;   ///< Bucket table
 294         size_t          m_nBucketMask   ;   ///< Bucket table size - 1. m_nBucketMask + 1 should be power of two.
 295         item_counter    m_ItemCounter   ;   ///< Item counter
 296         hash            m_Hash          ;   ///< Hash functor
 297
 298         mutex_policy    m_MutexPolicy   ;   ///< Mutex policy
 299         resizing_policy m_ResizingPolicy;   ///< Resizing policy
 300
 301         static const size_t c_nMinimalCapacity = 16 ;   ///< Minimal capacity
 302
 303     protected:
 304         //@cond
 305         typedef typename mutex_policy::scoped_cell_lock     scoped_cell_lock;
 306         typedef typename mutex_policy::scoped_full_lock     scoped_full_lock;
 307         typedef typename mutex_policy::scoped_resize_lock   scoped_resize_lock;
 308         //@endcond
 309
 310     protected:
 311         //@cond
 312         static size_t calc_init_capacity( size_t nCapacity )
 313         {
 314             nCapacity = cds::beans::ceil2( nCapacity );
 315             return nCapacity < c_nMinimalCapacity ? c_nMinimalCapacity : nCapacity;
 316         }
 317
 318         void alloc_bucket_table( size_t nSize )
 319         {
 320             assert( cds::beans::is_power2( nSize ));
 321             m_nBucketMask = nSize - 1;
 322             m_Buckets = bucket_allocator().NewArray( nSize );
 323         }
 324
 325         static void free_bucket_table( bucket_type * pBuckets, size_t nSize )
 326         {
 327             bucket_allocator().Delete( pBuckets, nSize );
 328         }
 329
 330         template <typename Q>
 331         size_t hashing( Q const& v ) const
 332         {
 333             return m_Hash( v );
 334         }
 335
 336         bucket_type * bucket( size_t nHash ) const CDS_NOEXCEPT
 337         {
 338             return m_Buckets + (nHash & m_nBucketMask);
 339         }
 340
 341         template <typename Q, typename Func>
 342         bool find_( Q& val, Func f )
 343         {
 344             size_t nHash = hashing( val );
 345
 346             scoped_cell_lock sl( m_MutexPolicy, nHash );
 347             return bucket( nHash )->find( val, f );
 348         }
 349
 350         template <typename Q, typename Less, typename Func>
 351         bool find_with_( Q& val, Less pred, Func f )
 352         {
 353             size_t nHash = hashing( val );
 354             scoped_cell_lock sl( m_MutexPolicy, nHash );
 355             return bucket( nHash )->find( val, pred, f );
 356         }
 357
 358         void internal_resize( size_t nNewCapacity )
 359         {
 360             // All locks are already locked!
 361             m_MutexPolicy.resize( nNewCapacity );
 362
 363             size_t nOldCapacity = bucket_count();
 364             bucket_type * pOldBuckets = m_Buckets;
 365
 366             alloc_bucket_table( nNewCapacity );
 367
 368             typedef typename bucket_type::iterator bucket_iterator;
 369             bucket_type * pEnd = pOldBuckets + nOldCapacity;
 370             for ( bucket_type * pCur = pOldBuckets; pCur != pEnd; ++pCur ) {
 371                 bucket_iterator itEnd = pCur->end();
 372                 bucket_iterator itNext;
 373                 for ( bucket_iterator it = pCur->begin(); it != itEnd; it = itNext ) {
 374                     itNext = it;
 375                     ++itNext;
 376                     bucket( m_Hash( *it ) )->move_item( *pCur, it );
 377                 }
 378                 pCur->clear();
 379             }
 380
 381             free_bucket_table( pOldBuckets, nOldCapacity );
 382
 383             m_ResizingPolicy.reset();
 384         }
 385
 386         void resize()
 387         {
 388             size_t nOldCapacity = bucket_count();
 389             size_t volatile& refBucketMask = m_nBucketMask;
 390
 391             scoped_resize_lock al( m_MutexPolicy );
 392             if ( al.success() ) {
 393                 if ( nOldCapacity != refBucketMask + 1 ) {
 394                     // someone resized already
 395                     return;
 396                 }
 397
 398                 internal_resize( nOldCapacity * 2 );
 399             }
 400         }
 401
 402         //@endcond
 403
 404     public:
 405         /// Default ctor. The initial capacity is 16.
 406         StripedSet()
 407             : m_Buckets( nullptr )
 408         , m_nBucketMask( c_nMinimalCapacity - 1 )
 409         , m_MutexPolicy( c_nMinimalCapacity )
 410         {
 411             alloc_bucket_table( m_nBucketMask + 1 );
 412         }
 413
 414         /// Ctor with initial capacity specified
 415         StripedSet(
 416             size_t nCapacity    ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
 417         )
 418         : m_Buckets( nullptr )
 419         , m_nBucketMask( calc_init_capacity(nCapacity) - 1 )
 420         , m_MutexPolicy( m_nBucketMask + 1 )
 421         {
 422             alloc_bucket_table( m_nBucketMask + 1 );
 423         }
 424
 425         /// Ctor with resizing policy (copy semantics)
 426         /**
 427             This constructor initializes m_ResizingPolicy member with copy of \p resizingPolicy parameter
 428         */
 429         StripedSet(
 430             size_t nCapacity    ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
 431             ,resizing_policy const& resizingPolicy  ///< Resizing policy
 432         )
 433         : m_Buckets( nullptr )
 434         , m_nBucketMask( ( nCapacity ? calc_init_capacity(nCapacity) : c_nMinimalCapacity ) - 1 )
 435         , m_MutexPolicy( m_nBucketMask + 1 )
 436         , m_ResizingPolicy( resizingPolicy )
 437         {
 438             alloc_bucket_table( m_nBucketMask + 1 );
 439         }
 440
 441         /// Ctor with resizing policy (move semantics)
 442         /**
 443             This constructor initializes m_ResizingPolicy member moving \p resizingPolicy parameter
 444             Move semantics is used.
 445         */
 446         StripedSet(
 447             size_t nCapacity    ///< Initial size of bucket table and lock array. Must be power of two, the minimum is 16.
 448             ,resizing_policy&& resizingPolicy  ///< Resizing policy
 449         )
 450         : m_Buckets( nullptr )
 451         , m_nBucketMask( ( nCapacity ? calc_init_capacity(nCapacity) : c_nMinimalCapacity ) - 1 )
 452         , m_MutexPolicy( m_nBucketMask + 1 )
 453         , m_ResizingPolicy( std::forward<resizing_policy>( resizingPolicy ) )
 454         {
 455             alloc_bucket_table( m_nBucketMask + 1 );
 456         }
 457
 458         /// Destructor destroys internal data
 459         ~StripedSet()
 460         {
 461             free_bucket_table( m_Buckets, m_nBucketMask + 1 );
 462         }
 463
 464     public:
 465         /// Inserts new node
 466         /**
 467             The function inserts \p val in the set if it does not contain
 468             an item with key equal to \p val.
 469
 470             Returns \p true if \p val is placed into the set, \p false otherwise.
 471         */
 472         bool insert( value_type& val )
 473         {
 474             return insert( val, []( value_type& ) {} );
 475         }
 476
 477         /// Inserts new node
 478         /**
 479             The function allows to split creating of new item into two part:
 480             - create item with key only
 481             - insert new item into the set
 482             - if inserting is success, calls  \p f functor to initialize value-field of \p val.
 483
 484             The functor signature is:
 485             \code
 486                 void func( value_type& val );
 487             \endcode
 488             where \p val is the item inserted.
 489
 490             The user-defined functor is called only if the inserting is success and can be passed by reference
 491             using \p std::ref.
 492         */
 493         template <typename Func>
 494         bool insert( value_type& val, Func f )
 495         {
 496             bool bOk;
 497             bool bResize;
 498             size_t nHash = hashing( val );
 499             bucket_type * pBucket;
 500             {
 501                 scoped_cell_lock sl( m_MutexPolicy, nHash );
 502                 pBucket = bucket( nHash );
 503                 bOk = pBucket->insert( val, f );
 504                 bResize = bOk && m_ResizingPolicy( ++m_ItemCounter, *this, *pBucket );
 505             }
 506
 507             if ( bResize )
 508                 resize();
 509             return bOk;
 510         }
 511
 512         /// Ensures that the \p val exists in the set
 513         /**
 514             The operation performs inserting or changing data with lock-free manner.
 515
 516             If the item \p val not found in the set, then \p val is inserted into the set.
 517             Otherwise, the functor \p func is called with item found.
 518             The functor signature is:
 519             \code
 520                 void func( bool bNew, value_type& item, value_type& val );
 521             \endcode
 522             with arguments:
 523             - \p bNew - \p true if the item has been inserted, \p false otherwise
 524             - \p item - item of the set
 525             - \p val - argument \p val passed into the \p ensure function
 526             If new item has been inserted (i.e. \p bNew is \p true) then \p item and \p val arguments
 527             refers to the same thing.
 528
 529             The functor may change non-key fields of the \p item.
 530
 531             You may pass \p func argument by reference using \p std::ref.
 532
 533             Returns <tt> std::pair<bool, bool> </tt> where \p first is \p true if operation is successful,
 534             \p second is \p true if new item has been added or \p false if the item with \p key
 535             already is in the set.
 536         */
 537         template <typename Func>
 538         std::pair<bool, bool> ensure( value_type& val, Func func )
 539         {
 540             std::pair<bool, bool> result;
 541             bool bResize;
 542             size_t nHash = hashing( val );
 543             bucket_type * pBucket;
 544             {
 545                 scoped_cell_lock sl( m_MutexPolicy, nHash );
 546                 pBucket = bucket( nHash );
 547
 548                 result = pBucket->ensure( val, func );
 549                 bResize = result.first && result.second && m_ResizingPolicy( ++m_ItemCounter, *this, *pBucket );
 550             }
 551
 552             if ( bResize )
 553                 resize();
 554             return result;
 555         }
 556
 557         /// Unlink the item \p val from the set
 558         /**
 559             The function searches the item \p val in the set and unlink it
 560             if it is found and is equal to \p val (here, the equality means that
 561             \p val belongs to the set: if \p item is an item found then
 562             unlink is successful iif <tt>&val == &item</tt>)
 563
 564             The function returns \p true if success and \p false otherwise.
 565         */
 566         bool unlink( value_type& val )
 567         {
 568             bool bOk;
 569             size_t nHash = hashing( val );
 570             {
 571                 scoped_cell_lock sl( m_MutexPolicy, nHash );
 572                 bOk = bucket( nHash )->unlink( val );
 573             }
 574
 575             if ( bOk )
 576                 --m_ItemCounter;
 577             return bOk;
 578         }
 579
 580         /// Deletes the item from the set
 581         /** \anchor cds_intrusive_StripedSet_erase
 582             The function searches an item with key equal to \p val in the set,
 583             unlinks it from the set, and returns a pointer to unlinked item.
 584
 585             If the item with key equal to \p val is not found the function return \p nullptr.
 586
 587             Note the hash functor should accept a parameter of type \p Q that can be not the same as \p value_type.
 588         */
 589         template <typename Q>
 590         value_type * erase( Q const& val )
 591         {
 592             return erase( val, [](value_type const&) {} );
 593         }
 594
 595         /// Deletes the item from the set using \p pred predicate for searching
 596         /**
 597             The function is an analog of \ref cds_intrusive_StripedSet_erase "erase(Q const&)"
 598             but \p pred is used for key comparing
 599             \p Less has the interface like \p std::less.
 600             \p pred must imply the same element order as the comparator used for building the set.
 601         */
 602         template <typename Q, typename Less>
 603         value_type * erase_with( Q const& val, Less pred )
 604         {
 605             return erase_with( val, pred, [](value_type const&) {} );
 606         }
 607
 608         /// Deletes the item from the set
 609         /** \anchor cds_intrusive_StripedSet_erase_func
 610
 611             The function searches an item with key equal to \p val in the set,
 612             call \p f functor with item found, unlinks it from the set, and returns a pointer to unlinked item.
 613
 614             The \p Func interface is
 615             \code
 616             struct functor {
 617                 void operator()( value_type const& item );
 618             };
 619             \endcode
 620             The functor may be passed by reference with <tt>boost:ref</tt>
 621
 622             If the item with key equal to \p val is not found the function return \p false.
 623
 624             Note the hash functor should accept a parameter of type \p Q that can be not the same as \p value_type.
 625         */
 626         template <typename Q, typename Func>
 627         value_type * erase( Q const& val, Func f )
 628         {
 629             size_t nHash = hashing( val );
 630             value_type * pVal;
 631             {
 632                 scoped_cell_lock sl( m_MutexPolicy, nHash );
 633                 pVal = bucket( nHash )->erase( val, f );
 634             }
 635
 636             if ( pVal )
 637                 --m_ItemCounter;
 638             return pVal;
 639         }
 640
 641         /// Deletes the item from the set using \p pred predicate for searching
 642         /**
 643             The function is an analog of \ref cds_intrusive_StripedSet_erase_func "erase(Q const&, Func)"
 644             but \p pred is used for key comparing
 645             \p Less has the interface like \p std::less.
 646             \p pred must imply the same element order as the comparator used for building the set.
 647         */
 648         template <typename Q, typename Less, typename Func>
 649         value_type * erase_with( Q const& val, Less pred, Func f )
 650         {
 651             size_t nHash = hashing( val );
 652             value_type * pVal;
 653             {
 654                 scoped_cell_lock sl( m_MutexPolicy, nHash );
 655                 pVal = bucket( nHash )->erase( val, pred, f );
 656             }
 657
 658             if ( pVal )
 659                 --m_ItemCounter;
 660             return pVal;
 661         }
 662
 663         /// Find the key \p val
 664         /** \anchor cds_intrusive_StripedSet_find_func
 665             The function searches the item with key equal to \p val and calls the functor \p f for item found.
 666             The interface of \p Func functor is:
 667             \code
 668             struct functor {
 669                 void operator()( value_type& item, Q& val );
 670             };
 671             \endcode
 672             where \p item is the item found, \p val is the <tt>find</tt> function argument.
 673
 674             You can pass \p f argument by reference using \p std::ref.
 675
 676             The functor may change non-key fields of \p item.
 677
 678             The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
 679             may modify both arguments.
 680
 681             Note the hash functor specified for class \p Traits template parameter
 682             should accept a parameter of type \p Q that can be not the same as \p value_type.
 683
 684             The function returns \p true if \p val is found, \p false otherwise.
 685         */
 686         template <typename Q, typename Func>
 687         bool find( Q& val, Func f )
 688         {
 689             return find_( val, f );
 690         }
 691
 692         /// Find the key \p val using \p pred predicate
 693         /**
 694             The function is an analog of \ref cds_intrusive_StripedSet_find_func "find(Q&, Func)"
 695             but \p pred is used for key comparing
 696             \p Less has the interface like \p std::less.
 697             \p pred must imply the same element order as the comparator used for building the set.
 698         */
 699         template <typename Q, typename Less, typename Func>
 700         bool find_with( Q& val, Less pred, Func f )
 701         {
 702             return find_with_( val, pred, f );
 703         }
 704
 705         /// Find the key \p val
 706         /** \anchor cds_intrusive_StripedSet_find_cfunc
 707             The function searches the item with key equal to \p val and calls the functor \p f for item found.
 708             The interface of \p Func functor is:
 709             \code
 710             struct functor {
 711                 void operator()( value_type& item, Q const& val );
 712             };
 713             \endcode
 714             where \p item is the item found, \p val is the <tt>find</tt> function argument.
 715
 716             You can pass \p f argument by reference using \p std::ref.
 717
 718             The functor may change non-key fields of \p item.
 719
 720             The \p val argument is non-const since it can be used as \p f functor destination i.e., the functor
 721             may modify both arguments.
 722
 723             The function returns \p true if \p val is found, \p false otherwise.
 724         */
 725         template <typename Q, typename Func>
 726         bool find( Q const& val, Func f )
 727         {
 728             return find_( val, f );
 729         }
 730
 731         /// Find the key \p val using \p pred predicate
 732         /**
 733             The function is an analog of \ref cds_intrusive_StripedSet_find_cfunc "find(Q const&, Func)"
 734             but \p pred is used for key comparing
 735             \p Less has the interface like \p std::less.
 736             \p pred must imply the same element order as the comparator used for building the set.
 737         */
 738         template <typename Q, typename Less, typename Func>
 739         bool find_with( Q const& val, Less pred, Func f )
 740         {
 741             return find_with_( val, pred, f );
 742         }
 743
 744         /// Find the key \p val
 745         /** \anchor cds_intrusive_StripedSet_find_val
 746             The function searches the item with key equal to \p val
 747             and returns \p true if it is found, and \p false otherwise.
 748
 749             Note the hash functor specified for class \p Traits template parameter
 750             should accept a parameter of type \p Q that can be not the same as \p value_type.
 751         */
 752         template <typename Q>
 753         bool find( Q const& val )
 754         {
 755             return find( val, [](value_type&, Q const& ) {} );
 756         }
 757
 758         /// Find the key \p val using \p pred predicate
 759         /**
 760             The function is an analog of \ref cds_intrusive_StripedSet_find_val "find(Q const&)"
 761             but \p pred is used for key comparing
 762             \p Less has the interface like \p std::less.
 763             \p pred must imply the same element order as the comparator used for building the set.
 764         */
 765         template <typename Q, typename Less>
 766         bool find_with( Q const& val, Less pred )
 767         {
 768             return find_with( val, pred, [](value_type& , Q const& ) {} );
 769         }
 770
 771         /// Clears the set
 772         /**
 773             The function unlinks all items from the set.
 774         */
 775         void clear()
 776         {
 777             // locks entire array
 778             scoped_full_lock sl( m_MutexPolicy );
 779
 780             size_t nBucketCount = bucket_count();
 781             bucket_type * pBucket = m_Buckets;
 782             for ( size_t i = 0; i < nBucketCount; ++i, ++pBucket )
 783                 pBucket->clear();
 784             m_ItemCounter.reset();
 785         }
 786
 787         /// Clears the set and calls \p disposer for each item
 788         /**
 789             The function unlinks all items from the set calling \p disposer for each item.
 790             \p Disposer functor interface is:
 791             \code
 792             struct Disposer{
 793                 void operator()( value_type * p );
 794             };
 795             \endcode
 796         */
 797         template <typename Disposer>
 798         void clear_and_dispose( Disposer disposer )
 799         {
 800             // locks entire array
 801             scoped_full_lock sl( m_MutexPolicy );
 802
 803             size_t nBucketCount = bucket_count();
 804             bucket_type * pBucket = m_Buckets;
 805             for ( size_t i = 0; i < nBucketCount; ++i, ++pBucket )
 806                 pBucket->clear( disposer );
 807             m_ItemCounter.reset();
 808         }
 809
 810         /// Checks if the set is empty
 811         /**
 812             Emptiness is checked by item counting: if item count is zero then the set is empty.
 813         */
 814         bool empty() const
 815         {
 816             return size() == 0;
 817         }
 818
 819         /// Returns item count in the set
 820         size_t size() const
 821         {
 822             return m_ItemCounter;
 823         }
 824
 825         /// Returns the size of hash table
 826         /**
 827             The hash table size is non-constant and can be increased via resizing.
 828         */
 829         size_t bucket_count() const
 830         {
 831             return m_nBucketMask + 1;
 832         }
 833
 834         /// Returns lock array size
 835         size_t lock_count() const
 836         {
 837             return m_MutexPolicy.lock_count();
 838         }
 839
 840         /// Returns resizing policy object
 841         resizing_policy& get_resizing_policy()
 842         {
 843             return m_ResizingPolicy;
 844         }
 845
 846         /// Returns resizing policy (const version)
 847         resizing_policy const& get_resizing_policy() const
 848         {
 849             return m_ResizingPolicy;
 850         }
 851     };
 852 }}  // namespace cds::itrusive
 853
 854 #endif // #ifndef __CDS_INTRUSIVE_STRIPED_SET_H