UILList< LListBase, T > Class Template Reference

Template class for intrusive linked lists. More...

Inheritance diagram for UILList< LListBase, T >:

Collaboration diagram for UILList< LListBase, T >:

Classes
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 const T &	const_reference
	Type that can be used for storing into constant. 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...

Friends
class	iterator
class	const_iterator
class	const_reverse_iterator
Ostream &	operator (Ostream &, const UILList< LListBase, T > &)

Detailed Description

template<class LListBase, class T>
class Foam::UILList< LListBase, T >

Template class for intrusive linked lists.

Source files

• UILList.H
• UILList.C
• UILListIO.C

Definition at line 51 of file UILList.H.

Member Typedef Documentation

typedef T value_type

Type of values the DLList contains.

Definition at line 159 of file UILList.H.

typedef T& reference

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

objects.

Definition at line 163 of file UILList.H.

typedef const T& const_reference

Type that can be used for storing into constant.

DLList::value_type objects.

Definition at line 167 of file UILList.H.

typedef label size_type

The type that can represent the size of a DLList.

Definition at line 170 of file UILList.H.

typedef LListBase::iterator LListBase_iterator

Definition at line 175 of file UILList.H.

typedef LListBase::const_iterator LListBase_const_iterator

Definition at line 224 of file UILList.H.

Constructor & Destructor Documentation

UILList ( )

inline

Null construct.

Definition at line 88 of file UILList.H.

Referenced by UILList< DLListBase, Foam::molecule >::UILList().

Here is the caller graph for this function:

UILList ( T *  a )

inline

Construct given initial T.

Definition at line 92 of file UILList.H.

UILList

(

const UILList< LListBase, T > &

lst

)

Construct as copy.

Definition at line 31 of file UILList.C.

References UILList< LListBase, T >::begin(), and UILList< LListBase, T >::end().

Here is the call graph for this function:

Member Function Documentation

T* first ( )

inline

Return the first entry.

Definition at line 106 of file UILList.H.

Referenced by interpolation2DTable< Type >::interpolation2DTable(), and snappyRefineDriver::snappyRefineDriver().

Here is the caller graph for this function:

const T* first ( ) const

inline

Return the first entry.

Definition at line 112 of file UILList.H.

T* last ( )

inline

Return the last entry.

Definition at line 118 of file UILList.H.

Referenced by interpolation2DTable< Type >::interpolation2DTable().

Here is the caller graph for this function:

const T* last ( ) const

inline

Return the last entry.

Definition at line 124 of file UILList.H.

T* removeHead ( )

inline

Remove and return head.

Definition at line 133 of file UILList.H.

Referenced by ILList< LListBase, T >::eraseHead().

Here is the caller graph for this function:

T* remove ( T *  p )

inline

Remove and return element.

Definition at line 139 of file UILList.H.

Referenced by Cloud< ParticleType >::move().

Here is the caller graph for this function:

T* remove ( iterator &  it )

inline

Remove and return specified by iterator.

Definition at line 145 of file UILList.H.

void operator=

(

const UILList< LListBase, T > &

rhs

)

Definition at line 43 of file UILList.C.

References UILList< LListBase, T >::begin(), clear(), and UILList< LListBase, T >::end().

Referenced by UILList< DLListBase, Foam::molecule >::remove().

Here is the call graph for this function:

Here is the caller graph for this function:

iterator begin ( )

inline

Definition at line 211 of file UILList.H.

Referenced by ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), UILList< LListBase, T >::operator=(), and UILList< LListBase, T >::UILList().

Here is the caller graph for this function:

const iterator& end ( )

inline

Definition at line 216 of file UILList.H.

Referenced by ILList< LListBase, T >::ILList(), ILList< LListBase, T >::operator=(), UILList< LListBase, T >::operator=(), and UILList< LListBase, T >::UILList().

Here is the caller graph for this function:

const_iterator cbegin ( ) const

inline

Definition at line 268 of file UILList.H.

const const_iterator& cend ( ) const

inline

Definition at line 273 of file UILList.H.

const_iterator begin ( ) const

inline

Definition at line 278 of file UILList.H.

const const_iterator& end ( ) const

inline

Definition at line 283 of file UILList.H.

const_reverse_iterator crbegin ( ) const

inline

Definition at line 330 of file UILList.H.

const const_reverse_iterator& crend ( ) const

inline

Definition at line 335 of file UILList.H.

const_reverse_iterator rbegin ( ) const

inline

Definition at line 342 of file UILList.H.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::readField().

Here is the caller graph for this function:

const const_reverse_iterator& rend ( ) const

inline

Definition at line 347 of file UILList.H.

Referenced by GeometricField< Type, PatchField, GeoMesh >::Boundary::readField().

Here is the caller graph for this function:

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.

References Foam::equal().

Referenced by UILList< DLListBase, Foam::molecule >::rend().

Here is the call graph for this function:

Here is the caller graph for this function:

bool operator!=

(

const UILList< LListBase, T > &

rhs

)

const

The opposite of the equality operation. Takes linear time.

Definition at line 81 of file UILList.C.

References Foam::operator==().

Referenced by UILList< DLListBase, Foam::molecule >::rend().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class iterator

friend

Definition at line 75 of file UILList.H.

friend class const_iterator

friend

Definition at line 78 of file UILList.H.

friend class const_reverse_iterator

friend

Definition at line 81 of file UILList.H.

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

friend

---

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