cds  2.3.1
cds::container::EllenBinTreeMap< GC, Key, T, Traits > Class Template Reference

Map based on Ellen's et al binary search tree. More...

#include <cds/container/impl/ellen_bintree_map.h>

Inheritance diagram for cds::container::EllenBinTreeMap< GC, Key, T, Traits >:
cds::intrusive::EllenBinTree< GC, Key, T, Traits >

Public Types

typedef GC gc
 Garbage collector.
 
typedef Key key_type
 type of a key stored in the map
 
typedef T mapped_type
 type of value stored in the map
 
typedef std::pair< key_type const, mapped_typevalue_type
 Key-value pair stored in leaf node of the mp.
 
typedef Traits traits
 Map traits.
 
typedef implementation_defined key_comparator
 key compare functor based on Traits::compare and Traits::less
 
typedef base_class::item_counter item_counter
 Item counting policy.
 
typedef base_class::memory_model memory_model
 Memory ordering, see cds::opt::memory_model.
 
typedef base_class::node_allocator node_allocator_type
 allocator for maintaining internal node
 
typedef base_class::stat stat
 internal statistics type
 
typedef traits::copy_policy copy_policy
 key copy policy
 
typedef traits::back_off back_off
 Back-off strategy.
 
typedef traits::allocator allocator_type
 Allocator for leaf nodes.
 
typedef base_class::node_allocator node_allocator
 Internal node allocator.
 
typedef base_class::update_desc_allocator update_desc_allocator
 Update descriptor allocator.
 
typedef gc::template guarded_ptr< leaf_node, value_type, details::guarded_ptr_cast_set< leaf_node, value_type > > guarded_ptr
 Guarded pointer.
 
- Public Types inherited from cds::intrusive::EllenBinTree< GC, Key, T, Traits >
typedef GC gc
 Garbage collector.
 
typedef Key key_type
 type of a key to be stored in internal nodes; key is a part of value_type
 
typedef T value_type
 type of value stored in the binary tree
 
typedef Traits traits
 Traits template parameter.
 
typedef traits::hook hook
 hook type
 
typedef hook::node_type node_type
 node type
 
typedef traits::disposer disposer
 leaf node disposer
 
typedef traits::back_off back_off
 back-off strategy
 
typedef gc::template guarded_ptr< value_typeguarded_ptr
 Guarded pointer.
 
typedef implementation_defined key_comparator
 key compare functor based on Traits::compare and Traits::less
 
typedef get_node_traits< value_type, node_type, hook >::type node_traits
 Node traits.
 
typedef traits::item_counter item_counter
 Item counting policy.
 
typedef traits::memory_model memory_model
 Memory ordering, see cds::opt::memory_model.
 
typedef traits::stat stat
 internal statistics type
 
typedef traits::key_extractor key_extractor
 key extracting functor
 
typedef traits::node_allocator node_allocator
 Allocator for internal node.
 
typedef traits::update_desc_allocator update_desc_allocator
 Update descriptor allocator.
 

Public Member Functions

 EllenBinTreeMap ()
 Default constructor.
 
 ~EllenBinTreeMap ()
 Clears the map.
 
template<typename K >
bool insert (K const &key)
 Inserts new node with key and default value. More...
 
template<typename K , typename V >
bool insert (K const &key, V const &val)
 Inserts new node. More...
 
template<typename K , typename Func >
bool insert_with (const K &key, Func func)
 Inserts new node and initialize it by a functor. More...
 
template<typename K , typename... Args>
bool emplace (K &&key, Args &&... args)
 For key key inserts data of type value_type created in-place from args. More...
 
template<typename K , typename Func >
std::pair< bool, bool > update (K const &key, Func func, bool bAllowInsert=true)
 Updates the node. More...
 
template<typename K >
bool erase (K const &key)
 Delete key from the map. More...
 
template<typename K , typename Less >
bool erase_with (K const &key, Less pred)
 Deletes the item from the map using pred predicate for searching. More...
 
template<typename K , typename Func >
bool erase (K const &key, Func f)
 Delete key from the map. More...
 
template<typename K , typename Less , typename Func >
bool erase_with (K const &key, Less pred, Func f)
 Deletes the item from the map using pred predicate for searching. More...
 
guarded_ptr extract_min ()
 Extracts an item with minimal key from the map. More...
 
guarded_ptr extract_max ()
 Extracts an item with maximal key from the map. More...
 
template<typename Q >
guarded_ptr extract (Q const &key)
 Extracts an item from the tree. More...
 
template<typename Q , typename Less >
guarded_ptr extract_with (Q const &key, Less pred)
 Extracts an item from the map using pred for searching. More...
 
template<typename K , typename Func >
bool find (K const &key, Func f)
 Find the key key. More...
 
template<typename K , typename Less , typename Func >
bool find_with (K const &key, Less pred, Func f)
 Finds the key val using pred predicate for searching. More...
 
template<typename K >
bool contains (K const &key)
 Checks whether the map contains key. More...
 
template<typename K , typename Less >
bool contains (K const &key, Less pred)
 Checks whether the map contains key using pred predicate for searching. More...
 
template<typename Q >
guarded_ptr get (Q const &key)
 Finds key and returns the item found. More...
 
template<typename Q , typename Less >
guarded_ptr get_with (Q const &key, Less pred)
 Finds key with predicate pred and returns the item found. More...
 
void clear ()
 Clears the map (not atomic)
 
bool empty () const
 Checks if the map is empty. More...
 
size_t size () const
 Returns item count in the set. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
bool check_consistency () const
 Checks internal consistency (not atomic, not thread-safe) More...
 
- Public Member Functions inherited from cds::intrusive::EllenBinTree< GC, Key, T, Traits >
 EllenBinTree ()
 Default constructor.
 
 ~EllenBinTree ()
 Clears the tree.
 
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)
 Unlinks the item val from the tree. More...
 
template<typename Q >
bool erase (const Q &key)
 Deletes the item from the tree. More...
 
template<typename Q , typename Less >
bool erase_with (const Q &key, Less pred)
 Delete the item from the tree with comparing functor pred. More...
 
template<typename Q , typename Func >
bool erase (Q const &key, Func f)
 Deletes the item from the tree. More...
 
template<typename Q , typename Less , typename Func >
bool erase_with (Q const &key, Less pred, Func f)
 Delete the item from the tree with comparing functor pred. More...
 
guarded_ptr extract_min ()
 Extracts an item with minimal key from the tree. More...
 
guarded_ptr extract_max ()
 Extracts an item with maximal key from the tree. More...
 
template<typename Q >
guarded_ptr extract (Q const &key)
 Extracts an item from the tree. More...
 
template<typename Q , typename Less >
guarded_ptr extract_with (Q const &key, Less pred)
 Extracts an item from the tree using pred for searching. More...
 
template<typename Q >
bool contains (Q const &key) const
 Checks whether the set contains key. More...
 
template<typename Q , typename Less >
bool contains (Q const &key, Less pred) const
 Checks whether the set contains key using pred predicate for searching. More...
 
template<typename Q , typename Func >
bool find (Q &key, Func f) const
 Finds the key key. More...
 
template<typename Q , typename Less , typename Func >
bool find_with (Q &key, Less pred, Func f) const
 Finds the key key with comparing functor pred. More...
 
template<typename Q >
guarded_ptr get (Q const &key) const
 Finds key and returns the item found. More...
 
template<typename Q , typename Less >
guarded_ptr get_with (Q const &key, Less pred) const
 Finds key with predicate pred and returns the item found. More...
 
bool empty () const
 Checks if the tree is empty.
 
void clear ()
 Clears the tree (thread safe, not atomic) More...
 
void unsafe_clear ()
 Clears the tree (not thread safe) More...
 
size_t size () const
 Returns item count in the tree. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
bool check_consistency () const
 Checks internal consistency (not atomic, not thread-safe) More...
 

Additional Inherited Members

- Static Public Attributes inherited from cds::intrusive::EllenBinTree< GC, Key, T, Traits >
static constexpr const size_t c_nHazardPtrCount = 9
 Count of hazard pointer required for the algorithm.
 
- Protected Attributes inherited from cds::intrusive::EllenBinTree< GC, Key, T, Traits >
item_counter m_ItemCounter
 item counter
 
stat m_Stat
 internal statistics
 

Detailed Description

template<class GC, typename Key, typename T, class Traits = ellen_bintree::traits>
class cds::container::EllenBinTreeMap< GC, Key, T, Traits >

Map based on Ellen's et al binary search tree.

Source:

  • [2010] F.Ellen, P.Fatourou, E.Ruppert, F.van Breugel "Non-blocking Binary Search Tree"

EllenBinTreeMap is an unbalanced leaf-oriented binary search tree that implements the map abstract data type. Nodes maintains child pointers but not parent pointers. Every internal node has exactly two children, and all data of type std::pair<Key const, T> currently in the tree are stored in the leaves. Internal nodes of the tree are used to direct find operation along the path to the correct leaf. The keys (of Key type) stored in internal nodes may or may not be in the map. Unlike EllenBinTreeSet keys are not a part of T type. The map can be represented as a set containing std::pair< Key const, T> values.

Due to extract_min and extract_max member functions the EllenBinTreeMap can act as a priority queue. In this case you should provide unique compound key, for example, the priority value plus some uniformly distributed random value.

Warning
Recall the tree is unbalanced. The complexity of operations is O(log N) for uniformly distributed random keys, but in the worst case the complexity is O(N).
Note
In the current implementation we do not use helping technique described in the original paper. In Hazard Pointer schema helping is too complicated and does not give any observable benefits. Instead of helping, when a thread encounters a concurrent operation it just spins waiting for the operation done. Such solution allows greatly simplify implementation of the tree.

Template arguments :

  • GC - safe memory reclamation (i.e. light-weight garbage collector) type, like cds::gc::HP, cds::gc::DHP
  • Key - key type. Should be default-constructible
  • T - value type to be stored in tree's leaf nodes.
  • Traits - map traits, default is ellen_bintree::traits It is possible to declare option-based tree with ellen_bintree::make_map_traits metafunction instead of Traits template argument.
Note
Do not include <cds/container/impl/ellen_bintree_map.h> header file directly. There are header file for each GC type:
  • <cds/container/ellen_bintree_map_hp.h> - for Hazard Pointer GC cds::gc::HP
  • <cds/container/ellen_bintree_map_dhp.h> - for Dynamic Hazard Pointer GC cds::gc::DHP
  • <cds/container/ellen_bintree_map_rcu.h> - for RCU GC (see RCU-based EllenBinTreeMap)

Member Function Documentation

◆ check_consistency()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::check_consistency ( ) const
inline

Checks internal consistency (not atomic, not thread-safe)

The debugging function to check internal consistency of the tree.

◆ contains() [1/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::contains ( K const &  key)
inline

Checks whether the map 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<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Less >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::contains ( K const &  key,
Less  pred 
)
inline

Checks whether the map 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<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename... Args>
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::emplace ( K &&  key,
Args &&...  args 
)
inline

For key key inserts data of type value_type created in-place from args.

Returns true if inserting successful, false otherwise.

◆ empty()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::empty ( ) const
inline

Checks if the map is empty.

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

◆ erase() [1/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::erase ( K const &  key)
inline

Delete key from the map.

Return true if key is found and deleted, false otherwise

◆ erase() [2/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Func >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::erase ( K const &  key,
Func  f 
)
inline

Delete key from the map.

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:

struct extractor {
void operator()(value_type& item) { ... }
};

Return true if key is found and deleted, false otherwise

◆ erase_with() [1/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Less >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::erase_with ( K const &  key,
Less  pred 
)
inline

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

The function is an analog of erase(K const&) 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 map.

◆ erase_with() [2/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Less , typename Func >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::erase_with ( K const &  key,
Less  pred,
Func  f 
)
inline

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

The function is an analog of erase(K const&, Func) 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 map.

◆ extract()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename Q >
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::extract ( Q const &  key)
inline

Extracts an item from the tree.

The function searches an item with key equal to key in the tree, unlinks it, and returns a guarded pointer to an item found. If the item is not found the function returns an empty guarded_ptr.

The guarded pointer prevents deallocation of returned item, see cds::gc::guarded_ptr for explanation.

Note
Each guarded_ptr object uses the GC's guard that can be limited resource.

◆ extract_max()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::extract_max ( )
inline

Extracts an item with maximal key from the map.

If the map is not empty, the function returns a guarded pointer to maximal value. If the map is empty, the function returns an empty guarded_ptr.

Note
Due the concurrent nature of the map, the function extracts nearly maximal key. It means that the function gets rightmost leaf of the tree and tries to unlink it. During unlinking, a concurrent thread may insert an item with key great than leftmost item's key. So, the function returns the item with maximum key at the moment of tree traversing.

The guarded pointer prevents deallocation of returned item, see cds::gc::guarded_ptr for explanation.

Note
Each guarded_ptr object uses the GC's guard that can be limited resource.

◆ extract_min()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::extract_min ( )
inline

Extracts an item with minimal key from the map.

If the map is not empty, the function returns an guarded pointer to minimum value. If the map is empty, the function returns an empty guarded_ptr.

Note
Due the concurrent nature of the map, the function extracts nearly minimum key. It means that the function gets leftmost leaf of the tree and tries to unlink it. During unlinking, a concurrent thread may insert an item with key less than leftmost item's key. So, the function returns the item with minimum key at the moment of tree traversing.

The guarded pointer prevents deallocation of returned item, see cds::gc::guarded_ptr for explanation.

Note
Each guarded_ptr object uses the GC's guard that can be limited resource.

◆ extract_with()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename Q , typename Less >
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::extract_with ( Q const &  key,
Less  pred 
)
inline

Extracts an item from the map using pred for searching.

The function is an analog of extract(Q const&) but pred is used for key compare. Less has the interface like std::less. pred must imply the same element order as the comparator used for building the map.

◆ find()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Func >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::find ( K const &  key,
Func  f 
)
inline

Find the key key.

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

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

where item is the item found.

The functor may change item.second.

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

◆ find_with()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Less , typename Func >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::find_with ( K const &  key,
Less  pred,
Func  f 
)
inline

Finds the key val using pred predicate for searching.

The function is an analog of find(K const&, Func) 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 map.

◆ get()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename Q >
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::get ( Q const &  key)
inline

Finds key and returns the item found.

The function searches the item with key equal to key and returns the item found as a guarded pointer. If key is not foudn the function returns an empty guarded_ptr.

The guarded pointer prevents deallocation of returned item, see cds::gc::guarded_ptr for explanation.

Note
Each guarded_ptr object uses the GC's guard that can be limited resource.

◆ get_with()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename Q , typename Less >
guarded_ptr cds::container::EllenBinTreeMap< GC, Key, T, Traits >::get_with ( Q const &  key,
Less  pred 
)
inline

Finds key with predicate pred and returns the item found.

The function is an analog of get(Q const&) but pred is used for key comparing. Less functor has the interface like std::less. pred must imply the same element order as the comparator used for building the map.

◆ insert() [1/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::insert ( K const &  key)
inline

Inserts new node with key and default value.

The function creates a node with key and default value, and then inserts the node created into the map.

Preconditions:

  • The key_type should be constructible from a value of type K. In trivial case, K is equal to key_type.
  • The mapped_type should be default-constructible.

Returns true if inserting successful, false otherwise.

◆ insert() [2/2]

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename V >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::insert ( K const &  key,
V const &  val 
)
inline

Inserts new node.

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

Preconditions:

  • The key_type should be constructible from key of type K.
  • The value_type should be constructible from val of type V.

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

◆ insert_with()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Func >
bool cds::container::EllenBinTreeMap< GC, Key, T, Traits >::insert_with ( const K &  key,
Func  func 
)
inline

Inserts new node and initialize it by a functor.

This function inserts new node with key key and if inserting is successful then it calls func functor with signature

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

The argument item of user-defined functor func is the reference to the map's item inserted:

  • item.first is a const reference to item's key that cannot be changed.
  • item.second is a reference to item's value that may be changed.

The key_type should be constructible from value of type K.

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

  • create item from key;
  • insert new item into the map;
  • if inserting is successful, initialize the value of item by calling func functor

This can be useful if complete initialization of object of value_type is heavyweight and it is preferable that the initialization should be completed only if inserting is successful.

◆ size()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
size_t cds::container::EllenBinTreeMap< GC, Key, T, Traits >::size ( ) const
inline

Returns item count in the set.

Only leaf nodes containing user data are counted.

The value returned depends on item counter type provided by Traits template parameter. If it is atomicity::empty_item_counter this function always returns 0.

The function is not suitable for checking the tree emptiness, use empty() member function for this purpose.

◆ update()

template<class GC , typename Key , typename T , class Traits = ellen_bintree::traits>
template<typename K , typename Func >
std::pair<bool, bool> cds::container::EllenBinTreeMap< GC, Key, T, Traits >::update ( K const &  key,
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 map, then val is inserted 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 );
};

with arguments:

  • bNew - true if the item has been inserted, false otherwise
  • item - item of the map

The functor may change any fields of the item.second that is mapped_type; however, func must guarantee that during changing no any other modifications could be made on this item by concurrent threads.

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.

Warning
See insert item troubleshooting

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

cds 2.3.1 Developed by Maxim Khizhinsky aka khizmax 2007 - 2017
Autogenerated Fri Sep 1 2017 08:46:57 by Doxygen 1.8.13