cds  2.3.1
cds::intrusive::LazyList< gc::nogc, T, Traits > Class Template Reference

Lazy 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 >:
cds::container::LazyList< cds::gc::nogc, T, Traits >

Public Types

typedef gc::nogc gc
 Garbage collector.
 
typedef T 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 comparing functor. More...
 
typedef traits::back_off back_off
 Back-off strategy.
 
typedef traits::disposer disposer
 disposer
 
typedef get_node_traits< value_type, node_type, hook >::type node_traits
 node traits
 
typedef lazy_list::get_link_checker< node_type, traits::link_checker >::type link_checker
 link checker
 
typedef traits::item_counter item_counter
 Item counting policy used.
 
typedef traits::memory_model memory_model
 C++ memory ordering (see lazy_list::traits::memory_model)
 
typedef traits::stat stat
 Internal statistics.
 
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 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.
 
 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 > update (value_type &val, Func func, bool bAllowInsert=true)
 Updates the item. More...
 
template<typename Q , typename Func >
bool find (Q &key, Func f)
 Finds the key key. More...
 
template<typename Q , typename Less , typename Func , bool Sort = c_bSort>
std::enable_if< Sort, bool >::type find_with (Q &key, Less less, Func f)
 Finds the key key using less predicate for searching. Disabled for unordered lists. More...
 
template<typename Q , typename Equal , typename Func , bool Sort = c_bSort>
std::enable_if<!Sort, bool >::type find_with (Q &key, Equal equal, Func f)
 Finds the key key using equal predicate for searching. Disabled for ordered lists. More...
 
template<typename Q >
value_typecontains (Q const &key)
 Checks whether the list contains key. More...
 
template<typename Q , typename Less , bool Sort = c_bSort>
std::enable_if< Sort, value_type * >::type contains (Q const &key, Less pred)
 Checks whether the map contains key using pred predicate for searching (ordered list version) More...
 
template<typename Q , typename Equal , bool Sort = c_bSort>
std::enable_if<!Sort, value_type * >::type contains (Q const &key, Equal equal)
 Checks whether the map contains key using equal predicate for searching (unordered list version) 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...
 
stat const & statistics () const
 Returns const reference to internal statistics.
 

Static Public Attributes

static constexpr bool const c_bSort = traits::sort
 List type: ordered (true) or unordered (false)
 

Protected Types

typedef node_typeauxiliary_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.
 
stat m_Stat
 Internal statistics.
 

Detailed Description

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

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

This specialization is append-only list when no item reclamation may be performed. The class does not support deleting of list item.

The list can be ordered if Traits::sort is true that is default or unordered otherwise. Unordered list can be maintained by equal_to relationship (Traits::equal_to), but for the ordered list less or compare relations should be specified in Traits.

See LazyList for description of template parameters.

Member Typedef Documentation

◆ key_comparator

template<typename T , class Traits = lazy_list::traits>
typedef implementation_defined cds::intrusive::LazyList< gc::nogc, T, Traits >::key_comparator

Key comparing functor.

  • for ordered list, the functor is based on traits::compare or traits::less
  • for unordered list, the functor is based on traits::equal_to, traits::compare or traits::less

Member Function Documentation

◆ begin()

template<typename T , class Traits = lazy_list::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()

◆ clear() [1/2]

template<typename T , class Traits = lazy_list::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.

◆ clear() [2/2]

template<typename T , class Traits = lazy_list::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.

◆ contains() [1/3]

template<typename T , class Traits = lazy_list::traits>
template<typename Q >
value_type* cds::intrusive::LazyList< gc::nogc, T, Traits >::contains ( Q const &  key)
inline

Checks whether the list contains key.

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

◆ contains() [2/3]

template<typename T , class Traits = lazy_list::traits>
template<typename Q , typename Less , bool Sort = c_bSort>
std::enable_if<Sort, value_type *>::type cds::intrusive::LazyList< gc::nogc, T, Traits >::contains ( Q const &  key,
Less  pred 
)
inline

Checks whether the map contains key using pred predicate for searching (ordered list version)

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

◆ contains() [3/3]

template<typename T , class Traits = lazy_list::traits>
template<typename Q , typename Equal , bool Sort = c_bSort>
std::enable_if<!Sort, value_type *>::type cds::intrusive::LazyList< gc::nogc, T, Traits >::contains ( Q const &  key,
Equal  equal 
)
inline

Checks whether the map contains key using equal predicate for searching (unordered list version)

The function is an analog of contains( key ) but equal is used for key comparing. Equal functor has the interface like std::equal_to.

◆ end()

template<typename T , class Traits = lazy_list::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()

◆ find()

template<typename T , class Traits = lazy_list::traits>
template<typename Q , typename Func >
bool cds::intrusive::LazyList< gc::nogc, T, Traits >::find ( Q &  key,
Func  f 
)
inline

Finds 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, Q& key );
};

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

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 key is found, false otherwise.

◆ find_with() [1/2]

template<typename T , class Traits = lazy_list::traits>
template<typename Q , typename Less , typename Func , bool Sort = c_bSort>
std::enable_if<Sort, bool>::type cds::intrusive::LazyList< gc::nogc, T, Traits >::find_with ( Q &  key,
Less  less,
Func  f 
)
inline

Finds the key key using less predicate for searching. Disabled for unordered lists.

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.

◆ find_with() [2/2]

template<typename T , class Traits = lazy_list::traits>
template<typename Q , typename Equal , typename Func , bool Sort = c_bSort>
std::enable_if<!Sort, bool>::type cds::intrusive::LazyList< gc::nogc, T, Traits >::find_with ( Q &  key,
Equal  equal,
Func  f 
)
inline

Finds the key key using equal predicate for searching. Disabled for ordered lists.

The function is an analog of find(Q&, Func) but equal is used for key comparing. Equal functor has the interface like std::equal_to.

◆ insert()

template<typename T , class Traits = lazy_list::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.

◆ size()

template<typename T , class Traits = lazy_list::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.

◆ update()

template<typename T , class Traits = lazy_list::traits>
template<typename Func >
std::pair<bool, bool> cds::intrusive::LazyList< gc::nogc, T, Traits >::update ( value_type val,
Func  func,
bool  bAllowInsert = true 
)
inline

Updates the item.

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 iff bAllowInsert is true. 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 update() function If new item has been inserted (i.e. bNew is true) then item and val arguments refer 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.

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


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:47:21 by Doxygen 1.8.13