A List with indirect addressing. Like IndirectList but does not store addressing. More...

#include <IndirectList.H>

Inheritance diagram for UIndirectList< T >:

[legend]

Collaboration diagram for UIndirectList< T >:

Public Member Functions
	UIndirectList (const UList< T > &values, const labelUList &addr)
	Shallow copy values and addressing.
	UIndirectList (const UIndirectList< T > &list)
	Copy construct (shallow copy values and addressing).
void	operator= (const UIndirectList< T > &rhs)
	Deep copy values, Fatal if list sizes are not identical.
Public Member Functions inherited from IndirectListBase< T, labelUList >
	IndirectListBase ()=delete
	No default construct.
bool	empty () const noexcept
	True if the list is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the list.
const UList< T > &	values () const noexcept
	The list of values (without addressing).
const labelUList &	addressing () const noexcept
	The addressing used for the list.
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
const T &	front () const
	The first element of the list.
const T &	back () const
	The last element of the list.
label	fcIndex (const label i) const
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
List< T >	list () const
	Return the addressed elements as a List.
bool	contains (const T &val, label pos=0, label len=-1) const
	Is the value contained in the list?
label	find (const T &val, label pos=0, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value.
List< T >	operator() () const
	Return the addressed elements as a List.
T &	operator[] (const label i)
	Non-const access to an element in the list.
void	operator= (const T &val)
	Assign all addressed elements to the given value.
iterator	begin ()
	Return an iterator at begin of list.
iterator	end ()
	Return an iterator at end of list.
const_iterator	cbegin () const
	Return a const_iterator at begin of list.
const_iterator	cend () const
	Return a const_iterator at end of list.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
T &	first ()
	Access first element of the list, position [0].
T &	last ()
	Access last element of the list, position [size()-1].
bool	found (const T &val, label pos=0) const
	Same as contains().

Additional Inherited Members
Public Types inherited from IndirectListBase< T, labelUList >
typedef T	value_type
	Type of values the list contains.
typedef T *	pointer
	The pointer type for non-const access to value_type items.
typedef const T *	const_pointer
	The pointer type for const access to value_type items.
typedef T &	reference
	The type used for storing into value_type objects.
typedef const T &	const_reference
	The type used for reading from constant value_type objects.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef labelUList	addressing_type
	The addressing type (non-stl definition).
Protected Member Functions inherited from IndirectListBase< T, labelUList >
void	copyList (const ListType &rhs)
	Deep copy values from the list.

Detailed Description

template<class T>
class Foam::UIndirectList< T >

A List with indirect addressing. Like IndirectList but does not store addressing.

Note the const_cast of the list values. This is so we can use it both on const and non-const lists. Alternative would be to have a const_ variant etc.

Source files

Definition at line 73 of file IndirectList.H.

Constructor & Destructor Documentation

◆ UIndirectList() [1/2]

template<class T>

UIndirectList	(	const UList< T > &	values,
		const labelUList &	addr )

inline

Shallow copy values and addressing.

Definition at line 84 of file IndirectList.H.

Referenced by IndirectList< T >::IndirectList(), IndirectList< T >::IndirectList(), IndirectList< T >::IndirectList(), IndirectList< T >::IndirectList(), IndirectList< T >::IndirectList(), and IndirectList< T >::IndirectList().

Here is the caller graph for this function:

◆ UIndirectList() [2/2]

template<class T>

UIndirectList ( const UIndirectList< T > & list )

inline

Copy construct (shallow copy values and addressing).

Definition at line 92 of file IndirectList.H.

Member Function Documentation

◆ operator=()

template<class T>

void operator= ( const UIndirectList< T > & rhs )

inline

Deep copy values, Fatal if list sizes are not identical.

Definition at line 108 of file IndirectList.H.

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

src/finiteArea/faMatrices/faMatrix/faMatrix.H
src/OpenFOAM/containers/IndirectLists/IndirectList/IndirectList.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UIndirectList() [1/2]

◆ UIndirectList() [2/2]

Member Function Documentation

◆ operator=()