A List obtained as a section of another List. More...

Inheritance diagram for SubList< T >:

[legend]

Collaboration diagram for SubList< T >:

Public Member Functions
	SubList (const UList< T > &list, const label subSize)
	Construct from UList and sub-list size. More...

	SubList (const UList< T > &list, const label subSize, const label startIndex)
	Construct from UList, sub-list size and start index. More...

	SubList (const SubList< T > &sl)=default
	Copy constructor. More...

void	transfer (UList< T > &)
	Transfer the contents of the argument List into this list. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const SubList< T > &)
	Assignment of all entries to the given sub-list. More...

void	operator= (const UList< T > &)
	Assignment of all entries to the given list. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

Public Member Functions inherited from UList< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. More...

	UList (const UList< T > &)=default
	Copy construct. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const T *	cdata () const
	Return a const pointer to the first data element,. More...

T *	data ()
	Return a pointer to the first data element,. More...

T &	first ()
	Return the first element of the list. More...

const T &	first () const
	Return first element of the list. More...

T &	last ()
	Return the last element of the list. More...

const T &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	shallowCopy (const UList< T > &)
	Copy the pointer held by the given UList. More...

void	deepCopy (const UList< T > &)
	Copy elements of the given UList. More...

T &	operator[] (const label)
	Return element of UList. More...

const T &	operator[] (const label) const
	Return element of constant UList. More...

	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&. More...

void	operator= (const T &)
	Assignment of all entries to the given value. More...

void	operator= (const zero)
	Assignment of all entries to zero. More...

iterator	begin ()
	Return an iterator to begin traversing the UList. More...

iterator	end ()
	Return an iterator to end traversing the UList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cend () const
	Return const_iterator to end traversing the constant UList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< T > &)
	Swap two ULists of the same type in constant time. More...

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

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

bool	operator< (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< T > &) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< T > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< T > &) const
	Return true if !(a < b). Takes linear time. More...

const bool &	operator[] (const label i) const

Static Public Member Functions
static const SubList< T > &	null ()
	Return a null SubList. More...

Static Public Member Functions inherited from UList< T >
static const UList< T > &	null ()
	Return a null UList. More...

Additional Inherited Members
Public Types inherited from UList< T >
typedef T	value_type
	Type of values the UList contains. More...

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

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

typedef label	difference_type
	The type that can represent the difference between any two. More...

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

typedef T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	const_iterator
	Random access iterator for traversing UList. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Detailed Description

template<class T>
class Foam::SubList< T >

A List obtained as a section of another List.

Since the SubList is itself unallocated, no storage is allocated or de-allocated during its use. To achieve this behaviour, SubList is derived from UList rather than List.

Source files

Definition at line 53 of file SubList.H.

Constructor & Destructor Documentation

◆ SubList() [1/3]

SubList	(	const UList< T > &	list,
		const label	subSize
	)

inline

Construct from UList and sub-list size.

Definition at line 31 of file SubListI.H.

References UList< T >::checkSize().

Here is the call graph for this function:

◆ SubList() [2/3]

SubList	(	const UList< T > &	list,
		const label	subSize,
		const label	startIndex
	)

inline

Construct from UList, sub-list size and start index.

Definition at line 46 of file SubListI.H.

References UList< T >::checkSize(), and UList< T >::checkStart().

Here is the call graph for this function:

◆ SubList() [3/3]

SubList ( const SubList< T > & sl )

inlinedefault

Copy constructor.

Member Function Documentation

◆ null()

const Foam::SubList< T > & null

inlinestatic

Return a null SubList.

Definition at line 77 of file SubListI.H.

◆ transfer()

void transfer ( UList< T > & l )

inline

Transfer the contents of the argument List into this list.

Definition at line 84 of file SubListI.H.

References UList< T >::deepCopy().

Here is the call graph for this function:

◆ operator const Foam::List< T > &()

operator const Foam::List< T > &

inline

Allow cast to a const List<T>&.

Definition at line 93 of file SubListI.H.

◆ operator=() [1/4]

void operator= ( const SubList< T > & sl )

inline

Assignment of all entries to the given sub-list.

Definition at line 100 of file SubListI.H.

Referenced by SubField< Type >::operator=().

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( const UList< T > & l )

inline

Assignment of all entries to the given list.

Definition at line 107 of file SubListI.H.

◆ operator=() [3/4]

void operator= ( const T & t )

inline

Assignment of all entries to the given value.

Definition at line 114 of file SubListI.H.

◆ operator=() [4/4]

void operator= ( const zero )

inline

Assignment of all entries to zero.

Definition at line 121 of file SubListI.H.

References Foam::Zero.

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

src/OpenFOAM/containers/Lists/SubList/SubList.H
src/OpenFOAM/containers/Lists/SubList/SubListI.H

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class Foam::SubList< T >

Constructor & Destructor Documentation

◆ SubList() [1/3]

◆ SubList() [2/3]

◆ SubList() [3/3]

Member Function Documentation

◆ null()

◆ transfer()

◆ operator const Foam::List< T > &()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

template<class T>
class Foam::SubList< T >