FixedList< T, Size > Class Template Reference

A 1D vector of objects of type <T> with a fixed size <Size>. More...

Inheritance diagram for FixedList< T, Size >:

[legend]

Collaboration diagram for FixedList< T, Size >:

[legend]

List of all members.

Classes
class	Hash
	Hashing function class. More...
Public Types
typedef T	value_type
	Type of values the FixedList contains.
typedef T &	reference
	Type that can be used for storing into.
typedef const T &	const_reference
	Type that can be used for storing into.
typedef label	difference_type
	The type that can represent the difference between any two.
typedef label	size_type
	The type that can represent the size of a FixedList.
typedef T *	iterator
	Random access iterator for traversing FixedList.
typedef const T *	const_iterator
	Random access iterator for traversing FixedList.
typedef T *	reverse_iterator
	Reverse iterator for reverse traversal of FixedList.
typedef const T *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant FixedList.
Public Member Functions
	FixedList ()
	Null constructor.
	FixedList (const T v[Size])
	Construct from components.
	FixedList (const T &)
	Construct from value.
	FixedList (const UList< T > &)
	Construct from UList.
	FixedList (const SLList< T > &)
	Construct from SLList.
	FixedList (const FixedList< T, Size > &)
	Copy constructor.
	FixedList (Istream &)
	Construct from Istream.
autoPtr< FixedList< T, Size > >	clone () const
	Clone.
label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index.
label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index.
const T *	cdata () const
	Return a const pointer to the first data element,.
T *	data ()
	Return a pointer to the first data element,.
void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1).
void	checkSize (const label size) const
	Check size is within valid range (0 ... size).
void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1).
void	resize (const label)
	Dummy resize function.
void	setSize (const label)
	Dummy setSize function.
void	transfer (const FixedList< T, Size > &)
	Copy (not transfer) the argument contents.
void	writeEntry (Ostream &) const
	Write the FixedList as a dictionary entry.
void	writeEntry (const word &keyword, Ostream &) const
	Write the FixedList as a dictionary entry with keyword.
T &	operator[] (const label)
	Return element of FixedList.
const T &	operator[] (const label) const
	Return element of constant FixedList.
void	operator= (const T v[Size])
	Assignment from array operator. Takes linear time.
void	operator= (const UList< T > &)
	Assignment from UList operator. Takes linear time.
void	operator= (const SLList< T > &)
	Assignment from SLList operator. Takes linear time.
void	operator= (const T &)
	Assignment of all entries to the given value.
iterator	begin ()
	Return an iterator to begin traversing the FixedList.
iterator	end ()
	Return an iterator to end traversing the FixedList.
const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	cend () const
	Return const_iterator to end traversing the constant FixedList.
const_iterator	begin () const
	Return const_iterator to begin traversing the constant FixedList.
const_iterator	end () const
	Return const_iterator to end traversing the constant FixedList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the FixedList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing FixedList.
label	size () const
	Return the number of elements in the FixedList.
label	max_size () const
	Return size of the largest possible FixedList.
bool	empty () const
	Return true if the FixedList is empty (ie, size() is zero).
void	swap (FixedList< T, Size > &)
	Swap two FixedLists of the same type in constant time.
bool	operator== (const FixedList< T, Size > &) const
	Equality operation on FixedLists of the same type.
bool	operator!= (const FixedList< T, Size > &) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const FixedList< T, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator> (const FixedList< T, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time.
bool	operator<= (const FixedList< T, Size > &) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const FixedList< T, Size > &) const
	Return true if !(a < b). Takes linear time.
Static Public Member Functions
static const FixedList< T, Size > &	null ()
	Return a null FixedList.
Friends
Istream &	operator>> (Istream &, FixedList< T, Size > &)
	Read List from Istream, discarding contents of existing List.
Ostream &	operator (Ostream &, const FixedList< T, Size > &)

---

Detailed Description

template<class T, unsigned Size>
class Foam::FixedList< T, Size >

A 1D vector of objects of type <T> with a fixed size <Size>.

Source files

• FixedList.H
• FixedList.C
• FixedListI.H
• FixedListIO.C

Definition at line 66 of file FixedList.H.

---

Member Typedef Documentation

typedef T value_type

Type of values the FixedList contains.

Definition at line 225 of file FixedList.H.

typedef T& reference

Type that can be used for storing into.

FixedList::value_type objects.

Definition at line 231 of file FixedList.H.

typedef const T& const_reference

Type that can be used for storing into.

constant FixedList::value_type objects

Definition at line 237 of file FixedList.H.

typedef label difference_type

The type that can represent the difference between any two.

FixedList iterator objects.

Definition at line 243 of file FixedList.H.

typedef label size_type

The type that can represent the size of a FixedList.

Definition at line 246 of file FixedList.H.

typedef T* iterator

Random access iterator for traversing FixedList.

Definition at line 252 of file FixedList.H.

typedef const T* const_iterator

Random access iterator for traversing FixedList.

Definition at line 264 of file FixedList.H.

typedef T* reverse_iterator

Reverse iterator for reverse traversal of FixedList.

Definition at line 282 of file FixedList.H.

typedef const T* const_reverse_iterator

Reverse iterator for reverse traversal of constant FixedList.

Definition at line 294 of file FixedList.H.

---

Constructor & Destructor Documentation

FixedList

(

)

[inline]

Null constructor.

Definition at line 25 of file FixedListI.H.

FixedList

(

const T

v[Size]

)

[inline]

Construct from components.

Definition at line 30 of file FixedListI.H.

FixedList

(

const T &

t

)

[inline]

Construct from value.

Definition at line 40 of file FixedListI.H.

FixedList

(

const UList< T > &

lst

)

[inline]

Construct from UList.

Definition at line 50 of file FixedListI.H.

FixedList

(

const SLList< T > &

lst

)

[inline]

Construct from SLList.

Definition at line 62 of file FixedListI.H.

FixedList

(

const FixedList< T, Size > &

lst

)

[inline]

Copy constructor.

Definition at line 80 of file FixedListI.H.

References FixedList< T, Size >::operator[]().

Here is the call graph for this function:

FixedList

(

Istream &

is

)

[inline]

Construct from Istream.

Definition at line 27 of file FixedListIO.C.

---

Member Function Documentation

const Foam::FixedList< T, Size > & null

(

)

[inline, static]

Return a null FixedList.

Definition at line 100 of file FixedListI.H.

Foam::autoPtr< Foam::FixedList< T, Size > > clone

(

)

const [inline]

Clone.

Definition at line 91 of file FixedListI.H.

Foam::label fcIndex

(

const label

i

)

const [inline]

Return the forward circular index, i.e. the next index.

which returns to the first at the end of the list

Definition at line 107 of file FixedListI.H.

Referenced by PatchTools::sortedEdgeFaces().

Here is the caller graph for this function:

Foam::label rcIndex

(

const label

i

)

const [inline]

Return the reverse circular index, i.e. the previous index.

which returns to the last at the beginning of the list

Definition at line 114 of file FixedListI.H.

const T * cdata

(

)

const [inline]

Return a const pointer to the first data element,.

similar to the STL front() method and the string::data() method This can be used (with caution) when interfacing with C code.

Definition at line 188 of file FixedListI.H.

T * data

(

)

[inline]

Return a pointer to the first data element,.

similar to the STL front() method and the string::data() method This can be used (with caution) when interfacing with C code.

Definition at line 196 of file FixedListI.H.

void checkStart

(

const label

start

)

const [inline]

Check start is within valid range (0 ... size-1).

Definition at line 122 of file FixedListI.H.

void checkSize

(

const label

size

)

const [inline]

Check size is within valid range (0 ... size).

Definition at line 135 of file FixedListI.H.

Referenced by FixedList< T, Size >::setSize(), and FixedList< T, Size >::transfer().

Here is the caller graph for this function:

void checkIndex

(

const label

i

)

const [inline]

Check index i is within valid range (0 ... size-1).

Definition at line 149 of file FixedListI.H.

Referenced by FixedList< T, Size >::operator=().

Here is the caller graph for this function:

void resize

(

const label

s

)

[inline]

Dummy resize function.

needed to make FixedList consistent with List

Definition at line 161 of file FixedListI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

void setSize

(

const label

s

)

[inline]

Dummy setSize function.

needed to make FixedList consistent with List

Definition at line 169 of file FixedListI.H.

References FixedList< T, Size >::checkSize().

Here is the call graph for this function:

void transfer

(

const FixedList< T, Size > &

lst

)

[inline]

Copy (not transfer) the argument contents.

needed to make FixedList consistent with List

Definition at line 177 of file FixedListI.H.

References FixedList< T, Size >::checkSize().

Here is the call graph for this function:

void writeEntry

(

Ostream &

os

)

const [inline]

Write the FixedList as a dictionary entry.

Definition at line 129 of file FixedListIO.C.

void writeEntry	(	const word &	keyword,
		Ostream &	os
	)			const [inline]

Write the FixedList as a dictionary entry with keyword.

Definition at line 149 of file FixedListIO.C.

T & operator[]

(

const label

i

)

[inline]

Return element of FixedList.

Definition at line 206 of file FixedListI.H.

Referenced by FixedList< T, Size >::FixedList(), and FixedList< T, Size >::operator=().

Here is the caller graph for this function:

const T & operator[]

(

const label

i

)

const [inline]

Return element of constant FixedList.

Definition at line 217 of file FixedListI.H.

void operator=

(

const T

v[Size]

)

[inline]

Assignment from array operator. Takes linear time.

Definition at line 227 of file FixedListI.H.

References FixedList< T, Size >::checkIndex().

Here is the call graph for this function:

void operator=

(

const UList< T > &

lst

)

[inline]

Assignment from UList operator. Takes linear time.

Definition at line 236 of file FixedListI.H.

void operator=

(

const SLList< T > &

lst

)

[inline]

Assignment from SLList operator. Takes linear time.

Definition at line 247 of file FixedListI.H.

void operator=

(

const T &

t

)

[inline]

Assignment of all entries to the given value.

Definition at line 264 of file FixedListI.H.

References FixedList< T, Size >::operator[]().

Here is the call graph for this function:

Foam::FixedList< T, Size >::iterator begin

(

)

[inline]

Return an iterator to begin traversing the FixedList.

Definition at line 277 of file FixedListI.H.

Foam::FixedList< T, Size >::iterator end

(

)

[inline]

Return an iterator to end traversing the FixedList.

Reimplemented in edge.

Definition at line 301 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator cbegin

(

)

const [inline]

Return const_iterator to begin traversing the constant FixedList.

Definition at line 293 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator cend

(

)

const [inline]

Return const_iterator to end traversing the constant FixedList.

Definition at line 317 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator begin

(

)

const [inline]

Return const_iterator to begin traversing the constant FixedList.

Definition at line 285 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator end

(

)

const [inline]

Return const_iterator to end traversing the constant FixedList.

Reimplemented in edge.

Definition at line 309 of file FixedListI.H.

Foam::FixedList< T, Size >::iterator rbegin

(

)

[inline]

Return reverse_iterator to begin reverse traversing the FixedList.

Definition at line 325 of file FixedListI.H.

Foam::FixedList< T, Size >::iterator rend

(

)

[inline]

Return reverse_iterator to end reverse traversing the FixedList.

Definition at line 349 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator crbegin

(

)

const [inline]

Return const_reverse_iterator to begin reverse traversing FixedList.

Definition at line 341 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator crend

(

)

const [inline]

Return const_reverse_iterator to end reverse traversing FixedList.

Definition at line 365 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator rbegin

(

)

const [inline]

Return const_reverse_iterator to begin reverse traversing FixedList.

Definition at line 333 of file FixedListI.H.

Foam::FixedList< T, Size >::const_iterator rend

(

)

const [inline]

Return const_reverse_iterator to end reverse traversing FixedList.

Definition at line 357 of file FixedListI.H.

Foam::label size

(

)

const [inline]

Return the number of elements in the FixedList.

Definition at line 372 of file FixedListI.H.

Foam::label max_size

(

)

const [inline]

Return size of the largest possible FixedList.

Definition at line 379 of file FixedListI.H.

bool empty

(

)

const [inline]

Return true if the FixedList is empty (ie, size() is zero).

Definition at line 386 of file FixedListI.H.

void swap

(

FixedList< T, Size > &

a

)

[inline]

Swap two FixedLists of the same type in constant time.

Definition at line 26 of file FixedList.C.

References List_ACCESS, List_ELEM, List_FOR_ALL, and Foam::T().

Here is the call graph for this function:

bool operator==

(

const FixedList< T, Size > &

a

)

const [inline]

Equality operation on FixedLists of the same type.

Returns true when the FixedLists are elementwise equal (using FixedList::value_type::operator==). Takes linear time.

Definition at line 42 of file FixedList.C.

Referenced by FixedList< T, Size >::operator<().

Here is the caller graph for this function:

bool operator!=

(

const FixedList< T, Size > &

a

)

const [inline]

The opposite of the equality operation. Takes linear time.

Definition at line 58 of file FixedList.C.

bool operator<

(

const FixedList< T, Size > &

a

)

const [inline]

Compare two FixedLists lexicographically. Takes linear time.

Definition at line 65 of file FixedList.C.

References FixedList< T, Size >::operator==().

Here is the call graph for this function:

bool operator>

(

const FixedList< T, Size > &

a

)

const [inline]

Compare two FixedLists lexicographically. Takes linear time.

Definition at line 96 of file FixedList.C.

Referenced by FixedList< T, Size >::operator>=().

Here is the caller graph for this function:

bool operator<=

(

const FixedList< T, Size > &

a

)

const [inline]

Return true if !(a > b). Takes linear time.

Definition at line 103 of file FixedList.C.

References FixedList< T, Size >::operator.

bool operator>=

(

const FixedList< T, Size > &

a

)

const [inline]

Return true if !(a < b). Takes linear time.

Definition at line 110 of file FixedList.C.

References FixedList< T, Size >::operator>().

Here is the call graph for this function:

---

Friends And Related Function Documentation

Istream& operator>>	(	Istream &	,
		FixedList< T, Size > &
	)			[friend]

Read List from Istream, discarding contents of existing List.

Ostream& operator	(	Ostream &	,
		const FixedList< T, Size > &
	)			[friend]

Referenced by FixedList< T, Size >::operator<=().

---

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

• src/OpenFOAM/containers/Lists/FixedList/FixedList.H
• src/OpenFOAM/containers/Lists/FixedList/FixedList.C
• src/OpenFOAM/containers/Lists/FixedList/FixedListI.H
• src/OpenFOAM/containers/Lists/FixedList/FixedListIO.C