Type traits for CuckooSet class. More...

#include <cds/intrusive/cuckoo_set.h>

Public Types
typedef base_hook	hook
	Hook used. More...

typedef cds::opt::none	hash
	Hash functors tuple. More...

typedef cuckoo::striping	mutex_policy
	Concurrent access policy. More...

typedef opt::none	equal_to
	Key equality functor. More...

typedef opt::none	compare
	Key comparing functor. More...

typedef opt::none	less
	specifies binary predicate used for key comparison. More...

typedef atomicity::item_counter	item_counter
	Item counter. More...

typedef CDS_DEFAULT_ALLOCATOR	allocator
	Allocator type. More...

typedef intrusive::opt::v::empty_disposer	disposer
	Disposer. More...

typedef empty_stat	stat
	Internal statistics. Available statistics: `cuckoo::stat`, `cuckoo::empty_stat`.

Detailed Description

Type traits for CuckooSet class.

Member Typedef Documentation

◆ allocator

typedef CDS_DEFAULT_ALLOCATOR cds::intrusive::cuckoo::traits::allocator

Allocator type.

The allocator type for allocating bucket tables.

◆ compare

typedef opt::none cds::intrusive::cuckoo::traits::compare

Key comparing functor.

No default functor is provided. If the option is not specified, the less is used.

◆ disposer

typedef intrusive::opt::v::empty_disposer cds::intrusive::cuckoo::traits::disposer

Disposer.

The disposer functor is used in CuckooSet::clear() member function to free set's node.

◆ equal_to

typedef opt::none cds::intrusive::cuckoo::traits::equal_to

Key equality functor.

Default is std::equal_to<T>

◆ hash

typedef cds::opt::none cds::intrusive::cuckoo::traits::hash

Hash functors tuple.

This is mandatory type and has no predefined one.

At least, two hash functors should be provided. All hash functor should be orthogonal (different): for each i,j: i != j => h[i](x) != h[j](x) . The hash functors are defined as std::tuple< H1, H2, ... Hn > : @code cds::opt::hash< std::tuple< h1, h2 > > @endcode The number of hash functors specifies the number k - the count of hash tables in cuckoo hashing.

To specify hash tuple in traits you should use cds::opt::hash_tuple:

struct my_traits: public cds::intrusive::cuckoo::traits {
    typedef cds::opt::hash_tuple< hash1, hash2 > hash;
};

◆ hook

typedef base_hook cds::intrusive::cuckoo::traits::hook

Hook used.

Possible values are: cuckoo::base_hook, cuckoo::member_hook, cuckoo::traits_hook.

◆ item_counter

typedef atomicity::item_counter cds::intrusive::cuckoo::traits::item_counter

Item counter.

The type for item counting feature. Default is cds::atomicity::item_counter

Only atomic item counter type is allowed.

◆ less

typedef opt::none cds::intrusive::cuckoo::traits::less

specifies binary predicate used for key comparison.

Default is std::less<T>.

◆ mutex_policy

typedef cuckoo::striping cds::intrusive::cuckoo::traits::mutex_policy

Concurrent access policy.

Available opt::mutex_policy types:

cuckoo::striping - simple, but the lock array is not resizable
cuckoo::refinable - resizable lock array, but more complex access to set data.

Default is cuckoo::striping.

The documentation for this struct was generated from the following file:

cds/intrusive/cuckoo_set.h

Public Types