cds  2.2.0
cds::container::MichaelKVList< gc::nogc, Key, Value, Traits > Class Template Reference

Michael's ordered list (key-value pair, template specialization for gc::nogc) More...

#include <cds/container/michael_kvlist_nogc.h>

Inheritance diagram for cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >:
cds::intrusive::MichaelList< gc::nogc, implementation_defined, Traits >

Public Types

typedef cds::gc::nogc gc
 Garbage collector used.
 
typedef Traits traits
 List traits.
 
typedef Key key_type
 Key type.
 
typedef Value mapped_type
 Type of value stored in the list.
 
typedef std::pair< key_type const, mapped_typevalue_type
 key/value pair stored in the list
 
typedef base_class::back_off back_off
 Back-off strategy used.
 
typedef maker::allocator_type allocator_type
 Allocator type used for allocate/deallocate the nodes.
 
typedef base_class::item_counter item_counter
 Item counting policy used.
 
typedef maker::key_comparator key_comparator
 key comparison functor
 
typedef base_class::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef base_class::stat stat
 Internal statistics.
 

Public Member Functions

 MichaelKVList ()
 Default constructor. More...
 
 ~MichaelKVList ()
 List destructor. More...
 
template<typename K >
iterator insert (const K &key)
 Inserts new node with key and default value. More...
 
template<typename K , typename V >
iterator insert (const K &key, const V &val)
 Inserts new node with a key and a value. More...
 
template<typename K , typename Func >
iterator insert_with (const K &key, Func func)
 Inserts new node and initialize it by a functor. More...
 
template<typename K >
std::pair< iterator, bool > update (K const &key, bool bAllowInsert=true)
 Updates the item. More...
 
template<typename K , typename... Args>
iterator emplace (K &&key, Args &&... args)
 Inserts data of type mapped_type constructed with std::forward<Args>(args)... More...
 
template<typename Q >
iterator contains (Q const &key)
 Checks whether the list contains key. More...
 
template<typename Q , typename Less >
iterator contains (Q const &key, Less pred)
 Checks whether the list contains key using pred predicate for searching. More...
 
bool empty () const
 Check if the list is empty.
 
size_t size () const
 Returns list's item count. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
void clear ()
 Clears the list.
 

Forward iterators

typedef iterator_type< false > iterator
 Forward iterator. More...
 
typedef iterator_type< true > const_iterator
 Const forward iterator. More...
 
iterator begin ()
 Returns a forward iterator addressing the first element in a list. More...
 
iterator end ()
 Returns an iterator that addresses the location succeeding the last element in a list. More...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cbegin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cend () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 

Additional Inherited Members

- Protected Types inherited from cds::intrusive::MichaelList< gc::nogc, implementation_defined, Traits >
typedef node_type::atomic_marked_ptr atomic_node_ptr
 Atomic node pointer.
 
typedef node_type::marked_ptr marked_node_ptr
 Node marked pointer.
 
typedef atomic_node_ptr auxiliary_head
 Auxiliary head type (for split-list support)
 
typedef implementation_defined value_type
 type of value stored in the list
 
typedef Traits traits
 Traits template parameter.
 
typedef traits::hook hook
 hook type
 
typedef hook::node_type node_type
 node type
 
typedef implementation_defined key_comparator
 key comparison functor based on opt::compare and opt::less option setter.
 
typedef traits::disposer disposer
 disposer used
 
typedef traits::stat stat
 Internal statistics.
 
typedef get_node_traits< value_type, node_type, hook >::type node_traits
 node traits
 
typedef michael_list::get_link_checker< node_type, traits::link_checker >::type link_checker
 link checker
 
typedef gc::nogc gc
 Garbage collector.
 
typedef traits::back_off back_off
 back-off strategy
 
typedef traits::item_counter item_counter
 Item counting policy used.
 
typedef traits::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef gc::template guarded_ptr< value_typeguarded_ptr
 Guarded pointer.
 
typedef iterator_type< false > iterator
 Forward iterator. More...
 
typedef iterator_type< true > const_iterator
 Const forward iterator. More...
 
- Protected Member Functions inherited from cds::intrusive::MichaelList< gc::nogc, implementation_defined, Traits >
 MichaelList ()
 Default constructor initializes empty list.
 
 ~MichaelList ()
 Destroys the list object.
 
bool insert (value_type &val)
 Inserts new node. More...
 
bool insert (value_type &val, Func f)
 Inserts new node. More...
 
std::pair< bool, bool > update (value_type &val, Func func, bool bInsert=true)
 Updates the node. More...
 
bool unlink (value_type &val)
 Unlinks the item val from the list. More...
 
bool erase (Q const &key)
 Deletes the item from the list. More...
 
bool erase (Q const &key, Func func)
 Deletes the item from the list. More...
 
bool erase_with (Q const &key, Less pred)
 Deletes the item from the list using pred predicate for searching. More...
 
bool erase_with (Q const &key, Less pred, Func f)
 Deletes the item from the list using pred predicate for searching. More...
 
guarded_ptr extract (Q const &key)
 Extracts the item from the list with specified key. More...
 
guarded_ptr extract_with (Q const &key, Less pred)
 Extracts the item using compare functor pred. More...
 
bool find (Q &key, Func f)
 Finds key in the list. More...
 
bool find_with (Q &key, Less pred, Func f)
 Finds the key using pred predicate for searching. More...
 
bool contains (Q const &key)
 Checks whether the list contains key. More...
 
bool contains (Q const &key, Less pred)
 Checks whether the list contains key using pred predicate for searching. More...
 
guarded_ptr get (Q const &key)
 Finds the key and return the item found. More...
 
guarded_ptr get_with (Q const &key, Less pred)
 Finds the key and return the item found. More...
 
void clear ()
 Clears the list. More...
 
bool empty () const
 Checks whether the list is empty.
 
size_t size () const
 Returns list's item count. More...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 
iterator begin ()
 Returns a forward iterator addressing the first element in a list. More...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
iterator end ()
 Returns an iterator that addresses the location succeeding the last element in a list. More...
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cbegin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cend () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
- Protected Attributes inherited from cds::intrusive::MichaelList< gc::nogc, implementation_defined, Traits >
atomic_node_ptr m_pHead
 Head pointer.
 
item_counter m_ItemCounter
 Item counter.
 
stat m_Stat
 Internal statistics.
 
- Static Protected Attributes inherited from cds::intrusive::MichaelList< gc::nogc, implementation_defined, Traits >
static constexpr const size_t c_nHazardPtrCount
 Count of hazard pointer required for the algorithm.
 

Detailed Description

template<typename Key, typename Value, typename Traits = michael_list::traits>
class cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >

Michael's ordered list (key-value pair, template specialization for gc::nogc)

This specialization is intended for so-called persistent usage when no item reclamation may be performed. The class does not support deleting of list item.

Usually, ordered single-linked list is used as a building block for the hash table implementation. The complexity of searching is O(N).

See MichaelList for description of template parameters.

The interface of the specialization is a little different.

Member Typedef Documentation

§ const_iterator

template<typename Key , typename Value , typename Traits = michael_list::traits>
typedef iterator_type<true> cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::const_iterator

Const forward iterator.

For iterator's features and requirements see iterator

§ iterator

template<typename Key , typename Value , typename Traits = michael_list::traits>
typedef iterator_type<false> cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::iterator

Forward iterator.

The forward iterator is safe: you may use it in multi-threaded enviromnent without any synchronization.

The forward iterator for Michael's list based on gc::nogc has pre- and post-increment operators.

The iterator interface to access item data:

  • operator -> - returns a pointer to value_type
  • operator * - returns a reference (a const reference for const_iterator) to value_type
  • const key_type& key() - returns a key reference for iterator
  • mapped_type& val() - retuns a value reference for iterator (const reference for const_iterator)

For both functions the iterator should not be equal to end().

Note
end() iterator is not dereferenceable

Constructor & Destructor Documentation

§ MichaelKVList()

template<typename Key , typename Value , typename Traits = michael_list::traits>
cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::MichaelKVList ( )
inline

Default constructor.

Initialize empty list

§ ~MichaelKVList()

template<typename Key , typename Value , typename Traits = michael_list::traits>
cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::~MichaelKVList ( )
inline

List destructor.

Clears the list

Member Function Documentation

§ begin()

template<typename Key , typename Value , typename Traits = michael_list::traits>
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::begin ( )
inline

Returns a forward iterator addressing the first element in a list.

For empty list

begin() == end()

§ contains() [1/2]

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename Q >
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::contains ( Q const &  key)
inline

Checks whether the list contains key.

The function searches the item with key equal to key and returns an iterator pointed to item found and end() otherwise

§ contains() [2/2]

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename Q , typename Less >
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::contains ( Q const &  key,
Less  pred 
)
inline

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

The function is an analog of contains( key ) 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 list.

§ emplace()

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename K , typename... Args>
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::emplace ( K &&  key,
Args &&...  args 
)
inline

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

Returns an iterator pointed to inserted value, or end() if inserting is failed

§ end()

template<typename Key , typename Value , typename Traits = michael_list::traits>
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::end ( )
inline

Returns an iterator that addresses the location succeeding the last element in a list.

Do not use the value returned by end function to access any item. Internally, end returning value equals to nullptr.

The returned value can be used only to control reaching the end of the list. For empty list

begin() == end()

§ insert() [1/2]

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename K >
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::insert ( const K &  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 list.

Preconditions:

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

Returns an iterator pointed to inserted value, or end() if inserting is failed

§ insert() [2/2]

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename K , typename V >
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::insert ( const K &  key,
const V &  val 
)
inline

Inserts new node with a key and a value.

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

Preconditions:

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

Returns an iterator pointed to inserted value, or end() if inserting is failed

§ insert_with()

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename K , typename Func >
iterator cds::container::MichaelKVList< gc::nogc, Key, Value, 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

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

The argument item of user-defined functor func is the reference to the list's item inserted. item.second is a reference to item's value that may be changed. User-defined functor func should guarantee that during changing item's value no any other changes could be made on this list's item by concurrent threads.

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 list;
  • if inserting is successful, initialize the value of item by calling f functor

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

Returns an iterator pointed to inserted value, or end() if inserting is failed

§ size()

template<typename Key , typename Value , typename Traits = michael_list::traits>
size_t cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::size ( ) const
inline

Returns list's item count.

The value returned depends on item counter provided by Traits. For atomicity::empty_item_counter, this function always returns 0.

Note
Even if you use real item counter and it returns 0, this fact does not mean that the list is empty. To check list emptyness use empty() method.

§ update()

template<typename Key , typename Value , typename Traits = michael_list::traits>
template<typename K >
std::pair<iterator, bool> cds::container::MichaelKVList< gc::nogc, Key, Value, Traits >::update ( K const &  key,
bool  bAllowInsert = true 
)
inline

Updates the item.

If key is not in the list and bAllowInsert is true,

the function inserts a new item. Otherwise, the function returns an iterator pointing to the item found.

Returns std::pair<iterator, bool> where first is an iterator pointing to item found or inserted, second is true if new item has been added or false if the item already is in the list.


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

cds 2.2.0 Developed by Maxim Khizhinsky aka khizmax 2007 - 2017
Autogenerated Wed Jan 4 2017 08:49:39 by Doxygen 1.8.12