Template class for intrusive linked lists. More...

Inheritance diagram for UILList:

[legend]

Data Structures
class	const_iterator
	An STL-conforming const_iterator. More...

class	const_reverse_iterator
	An STL-conforming const_reverse_iterator. More...

class	iterator
	An STL-conforming iterator. More...

Public Types
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Public Member Functions
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Construct as copy. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Data Fields
const typedef T &	const_reference
	Type that can be used for storing into constant. More...

Friends
class	iterator

class	const_iterator

class	const_reverse_iterator

Ostream &	operator (Ostream &, const UILList< LListBase, T > &)

Detailed Description

Template class for intrusive linked lists.

Source files

Definition at line 51 of file UILList.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Type of values the DLList contains.

Definition at line 159 of file UILList.H.

◆ reference

typedef T& reference

Type that can be used for storing into DLList::value_type.

objects.

Definition at line 163 of file UILList.H.

◆ size_type

typedef label size_type

The type that can represent the size of a DLList.

Definition at line 170 of file UILList.H.

◆ LListBase_iterator

typedef LListBase::iterator LListBase_iterator

Definition at line 175 of file UILList.H.

◆ LListBase_const_iterator

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 224 of file UILList.H.

Constructor & Destructor Documentation

◆ UILList() [1/3]

UILList ( )

inline

Null construct.

Definition at line 88 of file UILList.H.

◆ UILList() [2/3]

UILList ( T * a )

inline

Construct given initial T.

Definition at line 92 of file UILList.H.

◆ UILList() [3/3]

UILList ( const UILList< LListBase, T > & )

Construct as copy.

Member Function Documentation

◆ first() [1/2]

T* first ( )

inline

Return the first entry.

Definition at line 106 of file UILList.H.

◆ first() [2/2]

const T* first ( ) const

inline

Return the first entry.

Definition at line 112 of file UILList.H.

◆ last() [1/2]

T* last ( )

inline

Return the last entry.

Definition at line 118 of file UILList.H.

◆ last() [2/2]

const T* last ( ) const

inline

Return the last entry.

Definition at line 124 of file UILList.H.

◆ removeHead()

T* removeHead ( )

inline

Remove and return head.

Definition at line 133 of file UILList.H.

◆ remove() [1/2]

T* remove ( T * p )

inline

Remove and return element.

Definition at line 139 of file UILList.H.

◆ remove() [2/2]

T* remove ( iterator & it )

inline

Remove and return specified by iterator.

Definition at line 145 of file UILList.H.

◆ operator=()

void operator= ( const UILList< LListBase, T > & rhs )

Definition at line 43 of file UILList.C.

◆ begin() [1/2]

iterator begin ( )

inline

Definition at line 211 of file UILList.H.

Referenced by UILList< DLListBase, callback >::operator=().

Here is the caller graph for this function:

◆ end() [1/2]

const iterator& end ( )

inline

Definition at line 216 of file UILList.H.

Referenced by UILList< DLListBase, callback >::operator=().

Here is the caller graph for this function:

◆ cbegin()

const_iterator cbegin ( ) const

inline

Definition at line 268 of file UILList.H.

◆ cend()

const const_iterator& cend ( ) const

inline

Definition at line 273 of file UILList.H.

◆ begin() [2/2]

const_iterator begin ( ) const

inline

Definition at line 278 of file UILList.H.

◆ end() [2/2]

const const_iterator& end ( ) const

inline

Definition at line 283 of file UILList.H.

◆ crbegin()

const_reverse_iterator crbegin ( ) const

inline

Definition at line 330 of file UILList.H.

◆ crend()

const const_reverse_iterator& crend ( ) const

inline

Definition at line 335 of file UILList.H.

◆ rbegin()

const_reverse_iterator rbegin ( ) const

inline

Definition at line 342 of file UILList.H.

◆ rend()

const const_reverse_iterator& rend ( ) const

inline

Definition at line 347 of file UILList.H.

◆ operator==()

bool operator== ( const UILList< LListBase, T > & rhs ) const

Equality operation on ULists of the same type.

Returns true when the ULists are element-wise equal (using UList::value_type::operator==). Takes linear time.

Definition at line 56 of file UILList.C.

◆ operator!=()

bool operator!= ( const UILList< LListBase, T > & rhs ) const

The opposite of the equality operation. Takes linear time.

Definition at line 82 of file UILList.C.

Friends And Related Function Documentation

◆ iterator

friend class iterator

friend

Definition at line 75 of file UILList.H.

Referenced by UILList< DLListBase, callback >::end().

◆ const_iterator

friend class const_iterator

friend

Definition at line 78 of file UILList.H.

Referenced by UILList< DLListBase, callback >::cend(), and UILList< DLListBase, callback >::end().

◆ const_reverse_iterator

friend class const_reverse_iterator

friend

Definition at line 81 of file UILList.H.

Referenced by UILList< DLListBase, callback >::crend(), and UILList< DLListBase, callback >::rend().

◆ operator

Ostream& operator	(	Ostream &	,
		const UILList< LListBase, T > &
	)

friend

Field Documentation

◆ const_reference

const typedef T& const_reference

Type that can be used for storing into constant.

DLList::value_type objects.

Definition at line 167 of file UILList.H.

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

src/OpenFOAM/containers/LinkedLists/accessTypes/UILList/UILList.H
src/OpenFOAM/containers/LinkedLists/accessTypes/UILList/UILList.C

Data Structures

Public Types

Public Member Functions

Data Fields

Friends

Detailed Description

Member Typedef Documentation

◆ value_type

◆ reference

◆ size_type

◆ LListBase_iterator

◆ LListBase_const_iterator

Constructor & Destructor Documentation

◆ UILList() [1/3]

◆ UILList() [2/3]

◆ UILList() [3/3]

Member Function Documentation

◆ first() [1/2]

◆ first() [2/2]

◆ last() [1/2]

◆ last() [2/2]

◆ removeHead()

◆ remove() [1/2]

◆ remove() [2/2]

◆ operator=()

◆ begin() [1/2]

◆ end() [1/2]

◆ cbegin()

◆ cend()

◆ begin() [2/2]

◆ end() [2/2]

◆ crbegin()

◆ crend()

◆ rbegin()

◆ rend()

◆ operator==()

◆ operator!=()

Friends And Related Function Documentation

◆ iterator

◆ const_iterator

◆ const_reverse_iterator

◆ operator

Field Documentation

◆ const_reference