Lazy ordered single-linked list (template specialization for gc::nogc) More...

#include <cds/intrusive/lazy_list_nogc.h>

Inheritance diagram for cds::intrusive::LazyList< gc::nogc, T, Traits >:

Public Types
typedef T	value_type
	type of value stored in the list

typedef Traits	options
	Traits template parameter.

typedef options::hook	hook
	hook type

typedef hook::node_type	node_type
	node type

typedef implementation_defined	key_comparator
	key comparision functor based on opt::compare and opt::less option setter.

typedef options::disposer	disposer
	disposer used

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

typedef lazy_list::get_link_checker < node_type, options::link_checker >::type	link_checker
	link checker

typedef gc::nogc	gc
	Garbage collector.

typedef options::back_off	back_off
	back-off strategy (not used)

typedef options::item_counter	item_counter
	Item counting policy used.

typedef options::memory_model	memory_model
	C++ memory ordering (see lazy_list::type_traits::memory_model)

typedef iterator_type< false >	iterator
	Forward iterator.

typedef iterator_type< true >	const_iterator
	Const forward iterator.

Public Member Functions
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	end () const
	Returns an const iterator that addresses the location succeeding the last element in a list.

	LazyList ()
	Default constructor initializes empty list.

	~LazyList ()
	Destroys the list object.

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

template<typename Func >
std::pair< bool, bool >	ensure (value_type &val, Func func)
	Ensures that the `item` exists in the list. More...

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

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

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

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

template<typename Q >
value_type *	find (Q const &val)
	Finds the key `val`. More...

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

template<typename Disposer >
void	clear (Disposer disp)
	Clears the list. More...

void	clear ()
	Clears the list using default disposer. More...

bool	empty () const
	Checks if the list is empty.

size_t	size () const
	Returns list's item count. More...

Protected Types
typedef node_type *	auxiliary_head
	Auxiliary head type (for split-list support)

Protected Attributes
node_type	m_Head
	List head (dummy node)

node_type	m_Tail
	List tail (dummy node)

item_counter	m_ItemCounter
	Item counter.

Detailed Description

template<typename T, class Traits = lazy_list::type_traits>
class cds::intrusive::LazyList< gc::nogc, T, Traits >

Lazy ordered single-linked list (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 LazyList for description of template parameters.

The interface of the specialization is a slightly different.

The gc::nogc specialization of LazyList accepts following template argument list Options of cds::intrusive::lazy_list::make_traits metafunction:

opt::hook - hook used. Possible values are: lazy_list::base_hook, lazy_list::member_hook, lazy_list::traits_hook. If the option is not specified, lazy_list::base_hook<> and gc::HP is used.
opt::compare - key comparison functor. No default functor is provided. If the option is not specified, the opt::less is used.
opt::less - specifies binary predicate used for key comparision. Default is std::less<T>.
opt::back_off - back-off strategy used. If the option is not specified, the cds::backoff::empty is used.
opt::disposer - the functor used for dispose removed items. Default is opt::v::empty_disposer. The disposer provided is used only in clear() function.
opt::link_checker - the type of node's link fields checking. Default is opt::debug_check_link
opt::item_counter - the type of item counting feature. Default is atomicity::empty_item_counter that is no item counting.
opt::memory_model - C++ memory ordering model. Can be opt::v::relaxed_ordering (relaxed memory model, the default) or opt::v::sequential_consistent (sequentially consisnent memory model).

The opt::allocator and opt::back_off is not used for this specialization.

Member Function Documentation

template<typename T , class Traits = lazy_list::type_traits>

iterator cds::intrusive::LazyList< gc::nogc, T, Traits >::begin ( )

inline

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

For empty list

begin() == end()

template<typename T , class Traits = lazy_list::type_traits>

template<typename Disposer >

void cds::intrusive::LazyList< gc::nogc, T, Traits >::clear ( Disposer disp )

inline

Clears the list.

The function unlink all items from the list. For each unlinked item the item disposer disp is called after unlinking.

This function is not thread-safe.

template<typename T , class Traits = lazy_list::type_traits>

void cds::intrusive::LazyList< gc::nogc, T, Traits >::clear ( )

inline

Clears the list using default disposer.

The function clears the list using default (provided in class template) disposer functor.

template<typename T , class Traits = lazy_list::type_traits>

iterator cds::intrusive::LazyList< gc::nogc, T, 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.

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

begin() == end()

template<typename T , class Traits = lazy_list::type_traits>

template<typename Func >

std::pair<bool, bool> cds::intrusive::LazyList< gc::nogc, T, Traits >::ensure	(	value_type &	val,
		Func	func
	)

inline

Ensures that the item exists in the list.

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

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

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

with arguments:

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

The functor may change non-key fields of the item. While the functor f is calling the item item is locked.

You may pass func argument by reference using boost::ref or cds::ref.

Returns std::pair<bool, bool> where first is true if operation is successfull, second is true if new item has been added or false if the item with key already is in the list.

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q , typename Func >

bool cds::intrusive::LazyList< gc::nogc, T, Traits >::find	(	Q &	val,
		Func	f
	)

inline

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

You may pass f argument by reference using boost::ref or cds::ref.

The functor may change non-key fields of item. While the functor f is calling the item found item is locked.

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

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q , typename Func >

bool cds::intrusive::LazyList< gc::nogc, T, Traits >::find	(	Q const &	val,
		Func	f
	)

inline

Finds 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 const& val ) ;
};

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

You may pass f argument by reference using boost::ref or cds::ref.

The functor may change non-key fields of item. While the functor f is calling the item found item is locked.

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

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q >

value_type* cds::intrusive::LazyList< gc::nogc, T, Traits >::find ( Q const & val )

inline

Finds the key val.

The function searches the item with key equal to val and returns pointer to value found or NULL.

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q , typename Less , typename Func >

bool cds::intrusive::LazyList< gc::nogc, T, Traits >::find_with	(	Q const &	val,
		Less	pred,
		Func	f
	)

inline

Finds the key val using pred predicate for searching.

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

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q , typename Less , typename Func >

bool cds::intrusive::LazyList< gc::nogc, T, Traits >::find_with	(	Q &	val,
		Less	pred,
		Func	f
	)

inline

Finds the key val using pred predicate for searching.

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

template<typename T , class Traits = lazy_list::type_traits>

template<typename Q , typename Less >

value_type* cds::intrusive::LazyList< gc::nogc, T, Traits >::find_with	(	Q const &	val,
		Less	pred
	)

inline

Finds the key val using pred predicate for searching.

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

template<typename T , class Traits = lazy_list::type_traits>

bool cds::intrusive::LazyList< gc::nogc, T, Traits >::insert ( value_type & val )

inline

Inserts new node.

The function inserts val in the list if the list does not contain an item with key equal to val.

Returns true if val is linked into the list, false otherwise.

template<typename T , class Traits = lazy_list::type_traits>

size_t cds::intrusive::LazyList< gc::nogc, T, Traits >::size ( ) const

inline

Returns list's item count.

The value returned depends on opt::item_counter option. For atomicity::empty_item_counter, this function always returns 0.

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

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

cds/intrusive/lazy_list_nogc.h

Public Types

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

template<typename T, class Traits = lazy_list::type_traits> class cds::intrusive::LazyList< gc::nogc, T, Traits >

Member Function Documentation

template<typename T, class Traits = lazy_list::type_traits>
class cds::intrusive::LazyList< gc::nogc, T, Traits >