cds  1.4.0
Public Types | Public Member Functions
cds::container::MichaelList< gc::nogc, T, Traits > Class Template Reference

Michael's lock-free ordered single-linked list (template specialization for gc::nogc) More...

#include <cds/container/michael_list_nogc.h>

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

Public Types

typedef T value_type
 Type of value stored in the list.
 
typedef base_class::gc gc
 Garbage collector used.
 
typedef base_class::back_off back_off
 Back-off strategy used.
 
typedef options::allocator_type allocator_type
 Allocator type used for allocate/deallocate the nodes.
 
typedef base_class::item_counter item_counter
 Item counting policy used.
 
typedef options::key_comparator key_comparator
 key comparision functor
 
typedef base_class::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef iterator_type< false > iterator
 Returns a forward iterator addressing the first element in a list. More...
 
typedef iterator_type< true > const_iterator
 Const forward iterator. More...
 

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...
 
 MichaelList ()
 Default constructor. More...
 
 ~MichaelList ()
 List desctructor. More...
 
template<typename Q >
iterator insert (const Q &val)
 Inserts new node. More...
 
template<typename Q >
std::pair< iterator, bool > ensure (const Q &val)
 Ensures that the item val exists in the list. More...
 
template<typename... Args>
iterator emplace (Args &&...args)
 Inserts data of type value_type constructed with std::forward<Args>(args)... More...
 
template<typename Q >
iterator find (Q const &key)
 Find the key val. More...
 
template<typename Q , typename Less >
iterator find_with (Q const &key, Less pred)
 Finds the key val 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...
 
void clear ()
 Clears the list. More...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cbegin ()
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cend ()
 

Additional Inherited Members

- Protected Types inherited from cds::intrusive::MichaelList< gc::nogc, T, Traits >
typedef T value_type
 type of value stored in the queue
 
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
michael_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
 
typedef options::item_counter item_counter
 Item counting policy used.
 
typedef options::memory_model memory_model
 Memory ordering. See cds::opt::memory_model option.
 
typedef iterator_type< false > iterator
 Forward iterator.
 
typedef iterator_type< true > const_iterator
 Const forward iterator.
 
typedef node_type::atomic_ptr atomic_node_ptr
 Atomic node pointer.
 
typedef atomic_node_ptr auxiliary_head
 Auxiliary head type (for split-list support)
 
- Protected Member Functions inherited from cds::intrusive::MichaelList< gc::nogc, T, Traits >
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...
 
 MichaelList ()
 Default constructor initializes empty list.
 
 ~MichaelList ()
 Destroys the list objects.
 
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 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 , 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 >
value_typefind (Q const &val)
 Finds the key val. More...
 
template<typename Q , typename Less >
value_typefind_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...
 
const_iterator begin () const
 Returns a forward const iterator addressing the first element in a list.
 
const_iterator cbegin ()
 
const_iterator end () const
 Returns an const iterator that addresses the location succeeding the last element in a list.
 
const_iterator cend () const
 

Detailed Description

template<typename T, typename Traits>
class cds::container::MichaelList< gc::nogc, T, Traits >

Michael's lock-free 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 MichaelList for description of template parameters.

The interface of the specialization is a little different.

Member Typedef Documentation

template<typename T , typename Traits >
typedef iterator_type<true> cds::container::MichaelList< gc::nogc, T, Traits >::const_iterator

Const forward iterator.

For iterator's features and requirements see iterator

template<typename T , typename Traits >
typedef iterator_type<false> cds::container::MichaelList< gc::nogc, T, Traits >::iterator

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

For empty list

begin() == end()

Constructor & Destructor Documentation

template<typename T , typename Traits >
cds::container::MichaelList< gc::nogc, T, Traits >::MichaelList ( )
inline

Default constructor.

Initialize empty list

template<typename T , typename Traits >
cds::container::MichaelList< gc::nogc, T, Traits >::~MichaelList ( )
inline

List desctructor.

Clears the list

Member Function Documentation

template<typename T , typename Traits >
iterator cds::container::MichaelList< 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 , typename Traits >
void cds::container::MichaelList< gc::nogc, T, Traits >::clear ( )
inline

Clears the list.

Post-condition: the list is empty

template<typename T , typename Traits >
template<typename... Args>
iterator cds::container::MichaelList< gc::nogc, T, Traits >::emplace ( Args &&...  args)
inline

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

Return an iterator pointing to inserted item if success end() otherwise

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

template<typename T , typename Traits >
iterator cds::container::MichaelList< 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. Internally, end returning value equals to NULL.

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

begin() == end()
template<typename T , typename Traits >
template<typename Q >
std::pair<iterator, bool> cds::container::MichaelList< gc::nogc, T, Traits >::ensure ( const Q &  val)
inline

Ensures that the item val exists in the list.

The operation inserts new item if the key val is not found in the list. 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 T , typename Traits >
template<typename Q >
iterator cds::container::MichaelList< gc::nogc, T, Traits >::find ( Q const &  key)
inline

Find the key val.

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

template<typename T , typename Traits >
template<typename Q , typename Less >
iterator cds::container::MichaelList< gc::nogc, T, Traits >::find_with ( Q const &  key,
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 , typename Traits >
template<typename Q >
iterator cds::container::MichaelList< gc::nogc, T, Traits >::insert ( const Q &  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.

Return an iterator pointing to inserted item if success end() otherwise

template<typename T , typename Traits >
size_t cds::container::MichaelList< gc::nogc, T, Traits >::size ( ) const
inline

Returns list's item count.

The value returned depends on opt::item_counter option. For atomics::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 1.4.0 Developed by Maxim Khiszinsky aka khizmax 2007 - 2012
Autogenerated Mon May 20 2013 00:37:56 by Doxygen 1.8.3.1