FreeFOAM The Cross-Platform CFD Toolkit
UIDLList< T > Class Template Reference

Intrusive doubly-linked list. More...

#include <OpenFOAM/UIDLList.H>


Detailed Description

template<class T>
class Foam::UIDLList< T >

Intrusive doubly-linked list.

Definition at line 48 of file UIDLList.H.

+ Inheritance diagram for UIDLList< T >:
+ Collaboration diagram for UIDLList< T >:

List of all members.

Public Member Functions

 UIDLList ()
 Null construct.
 UIDLList (T a)
 Construct given initial T.
 UIDLList (Istream &is)
 Construct from Istream.
- Public Member Functions inherited from UILList< DLListBase, T >
 UILList ()
 Null construct.
 UILList (T *a)
 Construct given initial T.
 UILList (const UILList< DLListBase, T > &)
 Construct as copy.
T * first ()
 Return the first entry.
const T * first () const
 Return the first entry.
T * last ()
 Return the last entry.
const T * last () const
 Return the last entry.
T * removeHead ()
 Remove and return head.
T * remove (T *p)
 Remove and return element.
T * remove (iterator &it)
 Remove and return specified by iterator.
void operator= (const UILList< DLListBase, T > &)
bool operator== (const UILList< DLListBase, T > &) const
 Equality operation on ULists of the same type.
bool operator!= (const UILList< DLListBase, T > &) const
 The opposite of the equality operation. Takes linear time.
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct.
 DLListBase (link *)
 Construct given initial entry.
 ~DLListBase ()
label size () const
 Return number of elements in list.
bool empty () const
 Return true if the list is empty.
void insert (link *)
 Add at head of list.
void append (link *)
 Add at tail of list.
bool swapUp (link *)
 Swap this element with the one above unless it is at the top.
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom.
link * remove (link *)
 Remove and return element.
link * replace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element.
link * replace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element.
void clear ()
 Clear the list.
void transfer (DLListBase &)
 Transfer the contents of the argument into this List.
iterator begin ()
const iterator & end ()
const_iterator cbegin () const
const const_iterator & cend () const
const_iterator begin () const
const const_iterator & end () const

Additional Inherited Members

- Public Types inherited from UILList< DLListBase, T >
typedef T value_type
 Type of values the DLList contains.
typedef T & reference
 Type that can be used for storing into DLList::value_type.
typedef const T & const_reference
 Type that can be used for storing into constant.
typedef label size_type
 The type that can represent the size of a DLList.
typedef DLListBase::iterator LListBase_iterator
typedef DLListBase::const_iterator LListBase_const_iterator

Constructor & Destructor Documentation

UIDLList ( )
inline

Null construct.

Definition at line 58 of file UIDLList.H.

UIDLList ( T  a)
inline

Construct given initial T.

Definition at line 62 of file UIDLList.H.

UIDLList ( Istream &  is)
inline

Construct from Istream.

Definition at line 68 of file UIDLList.H.


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