Cuckoo hash set. More...

#include <cds/container/cuckoo_set.h>

Inheritance diagram for cds::container::CuckooSet< T, Traits >:

Public Types
typedef T	value_type
	value type stored in the container

typedef Traits	traits
	traits

typedef traits::hash	hash
	hash functor tuple wrapped for internal use

typedef base_class::hash_tuple_type	hash_tuple_type
	Type of hash tuple.

typedef base_class::mutex_policy	mutex_policy
	Concurrent access policy, see cuckoo::traits::mutex_policy.

typedef base_class::stat	stat
	internal statistics type

typedef base_class::key_equal_to	key_equal_to
	Key equality functor; used only for unordered probe-set.

typedef base_class::key_comparator	key_comparator
	key comparing functor based on `Traits::compare` and `Traits::less` option setter. Used only for ordered probe set

typedef base_class::allocator	allocator
	allocator type used for internal bucket table allocations

typedef std::conditional< std::is_same< typename traits::node_allocator, opt::none >::value, allocator, typename traits::node_allocator >::type	node_allocator
	Node allocator type.

typedef traits::item_counter	item_counter
	item counter type

Public Member Functions
	CuckooSet ()
	Default constructor. More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold=0)
	Constructs the set object with given probe set size and threshold. More...

	CuckooSet (hash_tuple_type const &h)
	Constructs the set object with given hash functor tuple. More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold, hash_tuple_type const &h)
	Constructs the set object with given probe set properties and hash functor tuple. More...

	CuckooSet (hash_tuple_type &&h)
	Constructs the set object with given hash functor tuple (move semantics) More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold, hash_tuple_type &&h)
	Constructs the set object with given probe set properties and hash functor tuple (move semantics) More...

	~CuckooSet ()
	Destructor clears the set.

template<typename Q >
bool	insert (Q const &val)
	Inserts new node. More...

template<typename Q , typename Func >
bool	insert (Q const &val, Func f)
	Inserts new node. More...

template<typename... Args>
bool	emplace (Args &&... args)
	Inserts data of type value_type constructed with `std::forward<Args>(args)...` More...

template<typename Q , typename Func >
std::pair< bool, bool >	update (Q const &val, Func func, bool bAllowInsert=true)
	Updates the node. More...

template<typename Q >
bool	erase (Q const &key)
	Delete `key` from the set. More...

template<typename Q , typename Predicate >
bool	erase_with (Q const &key, Predicate pred)
	Deletes the item from the list using `pred` predicate for searching. More...

template<typename Q , typename Func >
bool	erase (Q const &key, Func f)
	Delete `key` from the set. More...

template<typename Q , typename Predicate , typename Func >
bool	erase_with (Q const &key, Predicate pred, Func f)
	Deletes the item from the list using `pred` predicate for searching. More...

template<typename Q , typename Func >
bool	find (Q &val, Func f)
	Find the key `val`. More...

template<typename Q , typename Predicate , typename Func >
bool	find_with (Q &val, Predicate pred, Func f)
	Find the key `val` using `pred` predicate for comparing. More...

template<typename Q >
bool	contains (Q const &key)
	Checks whether the set contains `key`. More...

template<typename Q , typename Predicate >
bool	contains (Q const &key, Predicate pred)
	Checks whether the set contains `key` using `pred` predicate for searching. More...

void	clear ()
	Clears the set. More...

bool	empty () const
	Checks if the set is empty. More...

size_t	size () const
	Returns item count in the set.

size_t	bucket_count () const
	Returns the size of hash table. More...

size_t	lock_count () const
	Returns lock array size.

stat const &	statistics () const
	Returns const reference to internal statistics.

mutex_policy::statistics_type const &	mutex_policy_statistics () const
	Returns const reference to mutex policy internal statistics.

Static Public Attributes
static bool const	c_isSorted = base_class::c_isSorted
	whether the probe set should be ordered

static size_t const	c_nArity = base_class::c_nArity
	the arity of cuckoo hashing: the number of hash functors provided; minimum 2.

static unsigned int const	c_nDefaultProbesetSize = base_class::c_nDefaultProbesetSize
	default probeset size

static size_t const	c_nDefaultInitialSize = base_class::c_nDefaultInitialSize
	default initial size

static unsigned int const	c_nRelocateLimit = base_class::c_nRelocateLimit
	Count of attempts to relocate before giving up.

Additional Inherited Members
Protected Types inherited from cds::intrusive::CuckooSet< T, Traits >
typedef T	value_type
	The value type stored in the set.

typedef Traits	traits
	Set traits.

typedef traits::hook	hook
	hook type

typedef hook::node_type	node_type
	node type

typedef get_node_traits< value_type, node_type, hook >::type	node_traits
	node traits

typedef traits::hash	hash
	hash functor tuple wrapped for internal use

typedef hash::hash_tuple_type	hash_tuple_type
	Type of hash tuple.

typedef traits::stat	stat
	internal statistics type

typedef traits::mutex_policy	original_mutex_policy
	Concurrent access policy, see `cuckoo::traits::mutex_policy`.

typedef opt::details::make_equal_to< value_type, traits, !c_isSorted >::type	key_equal_to
	Key equality functor; used only for unordered probe-set.

typedef opt::details::make_comparator< value_type, traits >::type	key_comparator
	key comparing functor based on `opt::compare` and `opt::less` option setter. Used only for ordered probe set

typedef traits::allocator	allocator
	allocator type

typedef traits::item_counter	item_counter
	item counter type

typedef traits::disposer	disposer
	node disposer

Protected Member Functions inherited from cds::intrusive::CuckooSet< T, Traits >
	CuckooSet ()
	Default constructor. More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold=0)
	Constructs the set object with given probe set size and threshold. More...

	CuckooSet (hash_tuple_type const &h)
	Constructs the set object with given hash functor tuple. More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold, hash_tuple_type const &h)
	Constructs the set object with given probe set properties and hash functor tuple. More...

	CuckooSet (hash_tuple_type &&h)
	Constructs the set object with given hash functor tuple (move semantics) More...

	CuckooSet (size_t nInitialSize, unsigned int nProbesetSize, unsigned int nProbesetThreshold, hash_tuple_type &&h)
	Constructs the set object with given probe set properties and hash functor tuple (move semantics) More...

	~CuckooSet ()
	Destructor.

bool	insert (value_type &val)
	Inserts new node. More...

template<typename Func >
bool	insert (value_type &val, Func f)
	Inserts new node. More...

template<typename Func >
std::pair< bool, bool >	update (value_type &val, Func func, bool bAllowInsert=true)
	Updates the node. More...

bool	unlink (value_type &val)
	Unlink the item `val` from the set. More...

template<typename Q >
value_type *	erase (Q const &val)
	Deletes the item from the set. More...

template<typename Q , typename Predicate >
value_type *	erase_with (Q const &val, Predicate pred)
	Deletes the item from the set using `pred` predicate for searching. More...

template<typename Q , typename Func >
value_type *	erase (Q const &val, Func f)
	Delete the item from the set. More...

template<typename Q , typename Predicate , typename Func >
value_type *	erase_with (Q const &val, Predicate pred, Func f)
	Deletes the item from the set using `pred` predicate for searching. More...

template<typename Q , typename Func >
bool	find (Q &val, Func f)
	Find the key `val`. More...

template<typename Q , typename Predicate , typename Func >
bool	find_with (Q &val, Predicate pred, Func f)
	Find the key `val` using `pred` predicate for comparing. More...

template<typename Q >
bool	contains (Q const &key)
	Checks whether the set contains `key`. More...

template<typename Q , typename Predicate >
bool	contains (Q const &key, Predicate pred)
	Checks whether the set contains `key` using `pred` predicate for searching. More...

void	clear ()
	Clears the set. More...

template<typename Disposer >
void	clear_and_dispose (Disposer oDisposer)
	Clears the set and calls `disposer` for each item. More...

bool	empty () const
	Checks if the set is empty. More...

size_t	size () const
	Returns item count in the set.

size_t	bucket_count () const
	Returns the size of hash table. More...

size_t	lock_count () const
	Returns lock array size.

stat const &	statistics () const
	Returns const reference to internal statistics.

mutex_policy::statistics_type const &	mutex_policy_statistics () const
	Returns const reference to mutex policy internal statistics.

Protected Attributes inherited from cds::intrusive::CuckooSet< T, Traits >
bucket_entry *	m_BucketTable [c_nArity]
	Bucket tables.

atomics::atomic< size_t >	m_nBucketMask
	Hash bitmask; bucket table size minus 1.

unsigned int const	m_nProbesetSize
	Probe set size.

unsigned int const	m_nProbesetThreshold
	Probe set threshold.

hash	m_Hash
	Hash functor tuple.

mutex_policy	m_MutexPolicy
	concurrent access policy

item_counter	m_ItemCounter
	item counter

stat	m_Stat
	internal statistics

Static Protected Attributes inherited from cds::intrusive::CuckooSet< T, Traits >
static bool const	c_isSorted
	Probe set should be ordered or not. More...

static size_t const	c_nArity = hash::size
	the arity of cuckoo hashing: the number of hash functors provided; minimum 2.

static unsigned int const	c_nDefaultProbesetSize = 4
	default probeset size

static size_t const	c_nDefaultInitialSize = 16
	default initial size

static unsigned int const	c_nRelocateLimit = c_nArity * 2 - 1
	Count of attempts to relocate before giving up.

Detailed Description

template<typename T, typename Traits = cuckoo::traits>
class cds::container::CuckooSet< T, Traits >

Cuckoo hash set.

Source

[2007] M.Herlihy, N.Shavit, M.Tzafrir "Concurrent Cuckoo Hashing. Technical report"
[2008] Maurice Herlihy, Nir Shavit "The Art of Multiprocessor Programming"

About Cuckoo hashing

[From "The Art of Multiprocessor Programming"] Cuckoo hashing is a hashing algorithm in which a newly added item displaces any earlier item occupying the same slot. For brevity, a table is a k-entry array of items. For a hash set f size N = 2k we use a two-entry array of tables, and two independent hash functions, h0, h1: KeyRange -> 0,...,k-1 mapping the set of possible keys to entries in he array. To test whether a value x is in the set, find(x) tests whether either table[0][h0(x)] or table[1][h1(x)] is equal to x. Similarly, erase(x)checks whether x is in either table[0][h0(x)] or table[1][h1(x)], ad removes it if found.

The insert(x) successively "kicks out" conflicting items until every key has a slot. To add x, the method swaps x with y, the current occupant of table[0][h0(x)]. If the prior value was nullptr, it is done. Otherwise, it swaps the newly nest-less value y for the current occupant of table[1][h1(y)] in the same way. As before, if the prior value was nullptr, it is done. Otherwise, the method continues swapping entries (alternating tables) until it finds an empty slot. We might not find an empty slot, either because the table is full, or because the sequence of displacement forms a cycle. We therefore need an upper limit on the number of successive displacements we are willing to undertake. When this limit is exceeded, we resize the hash table, choose new hash functions and start over.

For concurrent cuckoo hashing, rather than organizing the set as a two-dimensional table of items, we use two-dimensional table of probe sets, where a probe set is a constant-sized set of items with the same hash code. Each probe set holds at most PROBE_SIZE items, but the algorithm tries to ensure that when the set is quiescent (i.e no method call in progress) each probe set holds no more than THRESHOLD < PROBE_SET items. While method calls are in-flight, a probe set may temporarily hold more than THRESHOLD but never more than PROBE_SET items.

In current implementation, a probe set can be defined either as a (single-linked) list or as a fixed-sized vector, optionally ordered.

In description above two-table cuckoo hashing (k = 2) has been considered. We can generalize this approach for k >= 2 when we have k hash functions h[0], ... h[k-1] and k tables table[0], ... table[k-1].

The search in probe set is linear, the complexity is O(PROBE_SET) . The probe set may be ordered or not. Ordered probe set can be a little better since the average search complexity is O(PROBE_SET/2). However, the overhead of sorting can eliminate a gain of ordered search.

The probe set is ordered if compare or less is specified in Traits template parameter. Otherwise, the probe set is unordered and Traits must contain equal_to predicate.

Template arguments:

T - the type stored in the set.
Traits - type traits. See cuckoo::traits for explanation. It is possible to declare option-based set with cuckoo::make_traits metafunction result as Traits template argument.

Examples

Cuckoo-set with list-based unordered probe set and storing hash values

#include <cds/container/cuckoo_set.h>
// Data stored in cuckoo set
struct my_data
{
    // key field
    std::string     strKey;
    // other data
    // ...
};
// Provide equal_to functor for my_data since we will use unordered probe-set
struct my_data_equal_to {
    bool operator()( const my_data& d1, const my_data& d2 ) const
    {
        return d1.strKey.compare( d2.strKey ) == 0;
    }
    bool operator()( const my_data& d, const std::string& s ) const
    {
        return d.strKey.compare(s) == 0;
    }
    bool operator()( const std::string& s, const my_data& d ) const
    {
        return s.compare( d.strKey ) == 0;
    }
};
// Provide two hash functor for my_data
struct hash1 {
    size_t operator()(std::string const& s) const
    {
        return cds::opt::v::hash<std::string>( s );
    }
    size_t operator()( my_data const& d ) const
    {
        return (*this)( d.strKey );
    }
};
struct hash2: private hash1 {
    size_t operator()(std::string const& s) const
    {
        size_t h = ~( hash1::operator()(s));
        return ~h + 0x9e3779b9 + (h << 6) + (h >> 2);
    }
    size_t operator()( my_data const& d ) const
    {
        return (*this)( d.strKey );
    }
};
// Declare type traits
struct my_traits: public cds::container::cuckoo::traits
{
    typedef my_data_equa_to equal_to;
    typedef std::tuple< hash1, hash2 >  hash;
    static bool const store_hash = true;
};
// Declare CuckooSet type
typedef cds::container::CuckooSet< my_data, my_traits > my_cuckoo_set;
// Equal option-based declaration
typedef cds::container::CuckooSet< my_data,
    cds::container::cuckoo::make_traits<
        cds::opt::hash< std::tuple< hash1, hash2 > >
        ,cds::opt::equal_to< my_data_equal_to >
        ,cds::container::cuckoo::store_hash< true >
    >::type
> opt_cuckoo_set;

If we provide compare function instead of equal_to for my_data we get as a result a cuckoo set with ordered probe set that may improve performance. Example for ordered vector-based probe-set:

#include <cds/container/cuckoo_set.h>
// Data stored in cuckoo set
struct my_data
{
    // key field
    std::string     strKey;
    // other data
    // ...
};
// Provide compare functor for my_data since we want to use ordered probe-set
struct my_data_compare {
    int operator()( const my_data& d1, const my_data& d2 ) const
    {
        return d1.strKey.compare( d2.strKey );
    }
    int operator()( const my_data& d, const std::string& s ) const
    {
        return d.strKey.compare(s);
    }
    int operator()( const std::string& s, const my_data& d ) const
    {
        return s.compare( d.strKey );
    }
};
// Provide two hash functor for my_data
struct hash1 {
    size_t operator()(std::string const& s) const
    {
        return cds::opt::v::hash<std::string>( s );
    }
    size_t operator()( my_data const& d ) const
    {
        return (*this)( d.strKey );
    }
};
struct hash2: private hash1 {
    size_t operator()(std::string const& s) const
    {
        size_t h = ~( hash1::operator()(s));
        return ~h + 0x9e3779b9 + (h << 6) + (h >> 2);
    }
    size_t operator()( my_data const& d ) const
    {
        return (*this)( d.strKey );
    }
};
// Declare type traits
// We use a vector of capacity 4 as probe-set container and store hash values in the node
struct my_traits: public cds::container::cuckoo::traits
{
    typedef my_data_compare compare;
    typedef std::tuple< hash1, hash2 >  hash;
    typedef cds::container::cuckoo::vector<4> probeset_type;
    static bool const store_hash = true;
};
// Declare CuckooSet type
typedef cds::container::CuckooSet< my_data, my_traits > my_cuckoo_set;
// Equal option-based declaration
typedef cds::container::CuckooSet< my_data,
    cds::container::cuckoo::make_traits<
        cds::opt::hash< std::tuple< hash1, hash2 > >
        ,cds::opt::compare< my_data_compare >
        ,cds::container::cuckoo::probeset_type< cds::container::cuckoo::vector<4> >
        ,cds::container::cuckoo::store_hash< true >
    >::type
> opt_cuckoo_set;

Constructor & Destructor Documentation

◆ CuckooSet() [1/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet ( )

inline

Default constructor.

Initial size = c_nDefaultInitialSize

Probe set size:

c_nDefaultProbesetSize if probeset_type is cuckoo::list
Capacity if probeset_type is cuckoo::vector<Capacity>

Probe set threshold = probe set size - 1

◆ CuckooSet() [2/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet	(	size_t	nInitialSize,
		unsigned int	nProbesetSize,
		unsigned int	nProbesetThreshold = `0`
	)

inline

Constructs the set object with given probe set size and threshold.

If probe set type is cuckoo::vector<Capacity> vector then nProbesetSize should be equal to vector's Capacity.

Parameters

nInitialSize	Initial set size; if 0 - use default initial size c_nDefaultInitialSize
nProbesetSize	probe set size
nProbesetThreshold	probe set threshold, `nProbesetThreshold < nProbesetSize`. If 0, nProbesetThreshold = nProbesetSize - 1

◆ CuckooSet() [3/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet ( hash_tuple_type const & h )

inline

Constructs the set object with given hash functor tuple.

The probe set size and threshold are set as default, see CuckooSet()

Parameters

h	hash functor tuple of type `std::tuple<H1, H2, ... Hn>` where `n == c_nArity`

◆ CuckooSet() [4/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet	(	size_t	nInitialSize,
		unsigned int	nProbesetSize,
		unsigned int	nProbesetThreshold,
		hash_tuple_type const &	h
	)

inline

Constructs the set object with given probe set properties and hash functor tuple.

If probe set type is cuckoo::vector<Capacity> vector then nProbesetSize should be equal to vector's Capacity.

Parameters

nInitialSize	Initial set size; if 0 - use default initial size c_nDefaultInitialSize
nProbesetSize	probe set size
nProbesetThreshold	probe set threshold, `nProbesetThreshold < nProbesetSize`. If 0, nProbesetThreshold = nProbesetSize - 1
h	hash functor tuple of type `std::tuple<H1, H2, ... Hn>` where `n == c_nArity`

◆ CuckooSet() [5/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet ( hash_tuple_type && h )

inline

Constructs the set object with given hash functor tuple (move semantics)

The probe set size and threshold are set as default, see CuckooSet()

Parameters

h	hash functor tuple of type `std::tuple<H1, H2, ... Hn>` where `n == c_nArity`

◆ CuckooSet() [6/6]

template<typename T , typename Traits = cuckoo::traits>

cds::container::CuckooSet< T, Traits >::CuckooSet	(	size_t	nInitialSize,
		unsigned int	nProbesetSize,
		unsigned int	nProbesetThreshold,
		hash_tuple_type &&	h
	)

inline

Constructs the set object with given probe set properties and hash functor tuple (move semantics)

If probe set type is cuckoo::vector<Capacity> vector then nProbesetSize should be equal to vector's Capacity.

Parameters

nInitialSize	Initial set size; if 0 - use default initial size c_nDefaultInitialSize
nProbesetSize	probe set size
nProbesetThreshold	probe set threshold, `nProbesetThreshold < nProbesetSize`. If 0, nProbesetThreshold = nProbesetSize - 1
h	hash functor tuple of type `std::tuple<H1, H2, ... Hn>` where `n == c_nArity`

Member Function Documentation

◆ bucket_count()

template<typename T , typename Traits = cuckoo::traits>

size_t cds::container::CuckooSet< T, Traits >::bucket_count ( ) const

inline

Returns the size of hash table.

The hash table size is non-constant and can be increased via resizing.

◆ clear()

template<typename T , typename Traits = cuckoo::traits>

void cds::container::CuckooSet< T, Traits >::clear ( )

inline

Clears the set.

The function erases all items from the set.

◆ contains() [1/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q >

bool cds::container::CuckooSet< T, Traits >::contains ( Q const & key )

inline

Checks whether the set contains key.

The function searches the item with key equal to key and returns true if it is found, and false otherwise.

◆ contains() [2/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Predicate >

bool cds::container::CuckooSet< T, Traits >::contains	(	Q const &	key,
		Predicate	pred
	)

inline

Checks whether the set contains key using pred predicate for searching.

The function is similar to contains( key ) but pred is used for key comparing. Less functor has the interface like std::less. Less must imply the same element order as the comparator used for building the set.

◆ emplace()

template<typename T , typename Traits = cuckoo::traits>

template<typename... Args>

bool cds::container::CuckooSet< T, Traits >::emplace ( Args &&... args )

inline

Inserts data of type value_type constructed with std::forward<Args>(args)...

Returns true if inserting successful, false otherwise.

◆ empty()

template<typename T , typename Traits = cuckoo::traits>

bool cds::container::CuckooSet< T, Traits >::empty ( ) const

inline

Checks if the set is empty.

Emptiness is checked by item counting: if item count is zero then the set is empty.

◆ erase() [1/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q >

bool cds::container::CuckooSet< T, Traits >::erase ( Q const & key )

inline

Delete key from the set.

Since the key of set's item type value_type is not explicitly specified, template parameter Q defines the key type searching in the list. The set item comparator should be able to compare the type value_type and the type Q.

Return true if key is found and deleted, false otherwise

◆ erase() [2/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Func >

bool cds::container::CuckooSet< T, Traits >::erase	(	Q const &	key,
		Func	f
	)

inline

Delete key from the set.

The function searches an item with key key, calls f functor and deletes the item. If key is not found, the functor is not called.

The functor Func interface is:

struct functor {
    void operator()(value_type const& val);
};

Return true if key is found and deleted, false otherwise

◆ erase_with() [1/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Predicate >

bool cds::container::CuckooSet< T, Traits >::erase_with	(	Q const &	key,
		Predicate	pred
	)

inline

Deletes the item from the list using pred predicate for searching.

The function is an analog of erase(Q const&) but pred is used for key comparing. If cuckoo set is ordered, then Predicate should have the interface and semantics like std::less. If cuckoo set is unordered, then Predicate should have the interface and semantics like std::equal_to. Predicate must imply the same element order as the comparator used for building the set.

◆ erase_with() [2/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Predicate , typename Func >

bool cds::container::CuckooSet< T, Traits >::erase_with	(	Q const &	key,
		Predicate	pred,
		Func	f
	)

inline

Deletes the item from the list using pred predicate for searching.

The function is an analog of erase(Q const&, Func) but pred is used for key comparing. If you use ordered cuckoo set, then Predicate should have the interface and semantics like std::less. If you use unordered cuckoo set, then Predicate should have the interface and semantics like std::equal_to. Predicate must imply the same element order as the comparator used for building the set.

◆ find()

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Func >

bool cds::container::CuckooSet< T, Traits >::find	(	Q &	val,
		Func	f
	)

inline

Find the key val.

The function searches the item with key equal to val and calls the functor f for item found. The interface of Func functor is:

struct functor {
    void operator()( value_type& item, Q& val );
};

where item is the item found, val is the find function argument.

The functor can change non-key fields of item. The val argument is non-const since it can be used as f functor destination i.e., the functor can modify both arguments.

The type Q can differ from value_type of items storing in the container. Therefore, the value_type should be comparable with type Q.

The function returns true if val is found, false otherwise.

◆ find_with()

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Predicate , typename Func >

bool cds::container::CuckooSet< T, Traits >::find_with	(	Q &	val,
		Predicate	pred,
		Func	f
	)

inline

Find the key val using pred predicate for comparing.

The function is an analog of find(Q&, Func) but pred is used for key comparison. If you use ordered cuckoo set, then Predicate should have the interface and semantics like std::less. If you use unordered cuckoo set, then Predicate should have the interface and semantics like std::equal_to. pred must imply the same element order as the comparator used for building the set.

◆ insert() [1/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q >

bool cds::container::CuckooSet< T, Traits >::insert ( Q const & val )

inline

Inserts new node.

The function creates a node with copy of val value and then inserts the node created into the set.

The type Q should contain as minimum the complete key for the node. The object of value_type should be constructible from a value of type Q. In trivial case, Q is equal to value_type.

Returns true if val is inserted into the set, false otherwise.

◆ insert() [2/2]

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Func >

bool cds::container::CuckooSet< T, Traits >::insert	(	Q const &	val,
		Func	f
	)

inline

Inserts new node.

The function allows to split creating of new item into two part:

create item with key only
insert new item into the set
if inserting is success, calls f functor to initialize value-field of new item .

The functor signature is:

void func( value_type& item );

where item is the item inserted.

The type Q can differ from value_type of items storing in the set. Therefore, the value_type should be constructible from type Q.

The user-defined functor is called only if the inserting is success.

◆ update()

template<typename T , typename Traits = cuckoo::traits>

template<typename Q , typename Func >

std::pair<bool, bool> cds::container::CuckooSet< T, Traits >::update	(	Q const &	val,
		Func	func,
		bool	bAllowInsert = `true`
	)

inline

Updates the node.

The operation performs inserting or changing data with lock-free manner.

If the item val is not found in the set, then val is inserted into the set iff bAllowInsert is true. Otherwise, the functor func is called with item found. The functor func signature is:

struct my_functor {
    void operator()( bool bNew, value_type& item, const Q& val );
};

with arguments:

bNew - true if the item has been inserted, false otherwise
item - item of the set
val - argument val passed into the update() function If new item has been inserted (i.e. bNew is true) then item and val arguments refer to the same thing.

Returns std::pair<bool, bool> where first is true if operation is successful, i.e. the node has been inserted or updated, second is true if new item has been added or false if the item with key already exists.

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

cds/container/cuckoo_set.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<typename T, typename Traits = cuckoo::traits> class cds::container::CuckooSet< T, Traits >

Constructor & Destructor Documentation

◆ CuckooSet() [1/6]

◆ CuckooSet() [2/6]

◆ CuckooSet() [3/6]

◆ CuckooSet() [4/6]

◆ CuckooSet() [5/6]

◆ CuckooSet() [6/6]

Member Function Documentation

◆ bucket_count()

◆ clear()

◆ contains() [1/2]

◆ contains() [2/2]

◆ emplace()

◆ empty()

◆ erase() [1/2]

◆ erase() [2/2]

◆ erase_with() [1/2]

◆ erase_with() [2/2]

◆ find()

◆ find_with()

◆ insert() [1/2]

◆ insert() [2/2]

◆ update()

template<typename T, typename Traits = cuckoo::traits>
class cds::container::CuckooSet< T, Traits >