Split-ordered list map (template specialization for gc::nogc) More...

#include <cds/container/split_list_map_nogc.h>

Inheritance diagram for cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >:

Public Types
typedef base_class::gc	gc
	Garbage collector.

typedef Key	key_type
	key type

typedef Value	mapped_type
	type of value stored in the map

typedef std::pair< key_type const, mapped_type >	value_type
	Pair type.

typedef base_class::ordered_list	ordered_list
	Underlying ordered list class.

typedef base_class::key_comparator	key_comparator
	key comparision functor

typedef base_class::hash	hash
	Hash functor for key_type.

typedef base_class::item_counter	item_counter
	Item counter type.

typedef base_class::iterator	iterator
	Forward iterator (see SplitListSet::iterator) More...

typedef base_class::const_iterator	const_iterator
	Const forward iterator (see SplitListSet::const_iterator)

Public Member Functions
iterator	begin ()
	Returns a forward iterator addressing the first element in a map. More...

iterator	end ()
	Returns an iterator that addresses the location succeeding the last element in a map. More...

	SplitListMap ()
	Initialize split-ordered map of default capacity. More...

	SplitListMap (size_t nItemCount, size_t nLoadFactor=1)
	Initialize split-ordered map. More...

template<typename K >
iterator	insert (K const &key)
	Inserts new node with key and default value. More...

template<typename K , typename V >
iterator	insert (K const &key, V const &val)
	Inserts new node. More...

template<typename K , typename Func >
iterator	insert_key (const K &key, Func func)
	Inserts new node and initialize it by a functor. More...

template<typename K , typename... Args>
iterator	emplace (K &&key, Args &&...args)
	For key `key` inserts data of type mapped_type constructed with `std::forward<Args>(args)...` More...

template<typename K >
std::pair< iterator, bool >	ensure (K const &key)
	Ensures that the key `key` exists in the map. More...

template<typename K >
iterator	find (K const &key)
	Find the key `key`. More...

template<typename K , typename Less >
iterator	find_with (K const &key, Less pred)
	Finds the key `val` using `pred` predicate for searching. More...

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

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


const_iterator	begin () const
	Returns a forward const iterator addressing the first element in a map.

const_iterator	cbegin ()


const_iterator	end () const
	Returns an const iterator that addresses the location succeeding the last element in a map.

const_iterator	cend ()

Additional Inherited Members
Protected Types inherited from cds::container::SplitListSet< cds::gc::nogc, std::pair< Key const, Value >, split_list::details::wrap_map_traits< Key, Value, Traits > >
typedef options::gc	gc
	Garbage collector.

typedef options::value_type	value_type
	type of value stored in the list

typedef options::ordered_list	ordered_list
	Underlying ordered list class.

typedef base_class::key_comparator	key_comparator
	key compare functor

typedef base_class::hash	hash
	Hash functor for `value_type` and all its derivatives that you use.

typedef base_class::item_counter	item_counter
	Item counter type.

typedef iterator_type< false >	iterator
	Forward iterator.

typedef iterator_type< true >	const_iterator
	Const forward iterator.

Protected Member Functions inherited from cds::container::SplitListSet< cds::gc::nogc, std::pair< Key const, Value >, split_list::details::wrap_map_traits< Key, Value, Traits > >
	SplitListSet ()
	Initializes split-ordered list of default capacity. More...

	SplitListSet (size_t nItemCount, size_t nLoadFactor=1)
	Initializes split-ordered list. More...

iterator	begin ()
	Returns a forward iterator addressing the first element in a set. More...

const_iterator	begin () const
	Returns a forward const iterator addressing the first element in a set.

iterator	end ()
	Returns an iterator that addresses the location succeeding the last element in a set. More...

const_iterator	end () const
	Returns an const iterator that addresses the location succeeding the last element in a set.

bool	insert (Q const &val)
	Inserts new node. More...

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

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

std::pair< bool, bool >	ensure (Q const &val, Func func)
	Ensures that the `item` exists in the set. More...

bool	erase (Q const &key)
	Deletes `key` from the set. More...

bool	erase (Q const &key, Func f)
	Deletes `key` from the set. More...

bool	erase_with (Q const &key, Less pred)
	Deletes the item from the set using `pred` predicate for searching. More...

bool	erase_with (Q const &key, Less pred, Func f)
	Deletes the item from the set using `pred` predicate for searching. More...

bool	find (Q &val, Func f)
	Finds the key `val`. More...

bool	find (Q const &val, Func f)
	Finds the key `val`. More...

bool	find (Q const &val)
	Finds the key `val`. More...

bool	find_with (Q &val, Less pred, Func f)
	Finds the key `val` using `pred` predicate for searching. More...

bool	find_with (Q const &val, Less pred, Func f)
	Finds the key `val` using `pred` predicate for searching. More...

bool	find_with (Q const &val, Less pred)
	Finds the key `val` using `pred` predicate for searching. More...

void	clear ()
	Clears the set (non-atomic) More...

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

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

Detailed Description

template<typename Key, typename Value, class Traits = split_list::type_traits>
class cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >

Split-ordered list map (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.

See SplitListMap for description of template parameters.

The interface of the specialization is a slightly different.

Member Typedef Documentation

template<typename Key , typename Value , class Traits = split_list::type_traits>

typedef base_class::iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::iterator

Forward iterator (see SplitListSet::iterator)

Remember, the iterator operator -> and operator * returns value_type pointer and reference. To access item key and value use it->first and it->second respectively.

Constructor & Destructor Documentation

template<typename Key , typename Value , class Traits = split_list::type_traits>

cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::SplitListMap ( )

inline

Initialize split-ordered map of default capacity.

The default capacity is defined in bucket table constructor. See intrusive::split_list::expandable_bucket_table, intrusive::split_list::static_ducket_table which selects by intrusive::split_list::dynamic_bucket_table option.

template<typename Key , typename Value , class Traits = split_list::type_traits>

cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::SplitListMap	(	size_t	nItemCount,
		size_t	nLoadFactor = `1`
	)

inline

Initialize split-ordered map.

Parameters

nItemCount	estimate average item count
nLoadFactor	load factor - average item count per bucket. Small integer up to 10, default is 1.

Member Function Documentation

template<typename Key , typename Value , class Traits = split_list::type_traits>

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::begin ( )

inline

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

For empty set

begin() == end()

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K , typename... Args>

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::emplace	(	K &&	key,
		Args &&...	args
	)

inline

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

key_type should be constructible from type K

Returns true if inserting successful, false otherwise.

This function is available only for compiler that supports variadic template and move semantics

template<typename Key , typename Value , class Traits = split_list::type_traits>

bool cds::container::SplitListMap< cds::gc::nogc, Key, Value, 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. Thus, the correct item counting feature is an important part of Michael's map implementation.

template<typename Key , typename Value , class Traits = split_list::type_traits>

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::end ( )

inline

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

Do not use the value returned by end function to access any item. The returned value can be used only to control reaching the end of the set. For empty set

begin() == end()

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K >

std::pair<iterator, bool> cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::ensure ( K const & key )

inline

Ensures that the key key exists in the map.

The operation inserts new item if the key key is not found in the map. Otherwise, the function returns an iterator that points to 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.

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K >

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::find ( K const & key )

inline

Find the key key.

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

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K , typename Less >

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::find_with	(	K const &	key,
		Less	pred
	)

inline

Finds the key val using pred predicate for searching.

The function is an analog of find(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.

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K >

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, 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 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

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K , typename V >

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, 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 mapped_type should be constructible from val of type V.

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

template<typename Key , typename Value , class Traits = split_list::type_traits>

template<typename K , typename Func >

iterator cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >::insert_key	(	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.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 map's item by concurrent threads. The user-defined functor can be passed by reference using boost::ref and it is called only if the inserting is successful.

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 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

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

cds/container/split_list_map_nogc.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename Key, typename Value, class Traits = split_list::type_traits> class cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename Key, typename Value, class Traits = split_list::type_traits>
class cds::container::SplitListMap< cds::gc::nogc, Key, Value, Traits >