Base for lists with indirect addressing, templated on the list contents type and the addressing type. Storage for both values and addressing is held outside of the class. More...

Inheritance diagram for IndirectListBase< T, Addr >:

[legend]

Classes
class	const_iterator
	A const iterator for an indirect list. More...

class	iterator
	A non-const iterator for an indirect list. More...

Public Types
typedef T	value_type
	Type of values the list contains. More...

typedef T *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const T *	const_pointer
	The pointer type for const access to value_type items. More...

typedef T &	reference
	The type used for storing into value_type objects. More...

typedef const T &	const_reference
	The type used for reading from constant value_type objects. More...

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

typedef label	difference_type
	The difference between iterator objects. More...

typedef Addr	addressing_type
	The addressing type (non-stl definition) More...

Public Member Functions
	IndirectListBase ()=delete
	No default construct. More...

	IndirectListBase (const UList< T > &values, const Addr &addr) noexcept
	Store references to the values list and the addressing array. More...

template<class... Args>
	IndirectListBase (UList< T > &&, Args &&...)=delete
	The values list (reference) cannot be an rvalue! More...

	IndirectListBase (const UList< T > &, Addr &&)=delete
	The addressing (reference) cannot be an rvalue! More...

bool	empty () const noexcept
	True if the list is empty (ie, size() is zero). More...

label	size () const noexcept
	The number of elements in the list. More...

const UList< T > &	values () const noexcept
	The list of values (without addressing) More...

UList< T > &	values () noexcept
	The list of values (without addressing) More...

const Addr &	addressing () const noexcept
	The addressing used for the list. More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

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

T &	front ()
	The first element of the list. More...

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

T &	back ()
	The last element of the list. More...

label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list. More...

label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...

const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

T &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const T &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

void	extract (UList< T > &result) const
	Extract the addressed elements. Sizes must match! More...

List< T >	list () const
	Extract and return the addressed elements as a List. More...

void	checkAddressing () const
	Check that addressing is within valid range of values(), otherwise Fatal. More...

bool	contains (const T &val, label pos=0, label len=-1) const
	Is the value contained in the list? More...

label	find (const T &val, label pos=0, label len=-1) const
	Find index of the first occurrence of the value. More...

label	rfind (const T &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

List< T >	operator() () const
	Extract and return the addressed elements as a List. Same as the list() method. More...

T &	operator[] (const label i)
	Non-const access to an element in the list. More...

const T &	operator[] (const label i) const
	Const access to an element in the list. More...

void	operator= (const T &val)
	Assign all addressed elements to the given value. More...

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

void	operator= (const UList< T > &rhs)
	Deep copy values from a list of the addressed elements. More...

void	operator= (const IndirectListBase &rhs)
	Deep copy values from a list of the addressed elements. More...

template<class AnyAddr >
void	operator= (const IndirectListBase< T, AnyAddr > &rhs)
	Deep copy values from a list of the addressed elements. More...

iterator	begin ()
	Return an iterator at begin of list. More...

iterator	end ()
	Return an iterator at end of list. More...

const_iterator	cbegin () const
	Return a const_iterator at begin of list. More...

const_iterator	cend () const
	Return a const_iterator at end of list. More...

const_iterator	begin () const
	Return a const_iterator at begin of list. More...

const_iterator	end () const
	Return a const_iterator at end of list. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

T &	first ()
	Access first element of the list, position [0]. More...

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

T &	last ()
	Access last element of the list, position [size()-1]. More...

const T &	last () const
	Access last element of the list, position [size()-1]. More...

bool	found (const T &val, label pos=0) const
	Same as contains() More...

Detailed Description

template<class T, class Addr>
class Foam::IndirectListBase< T, Addr >

Base for lists with indirect addressing, templated on the list contents type and the addressing type. Storage for both values and addressing is held outside of the class.

Source files

Definition at line 115 of file IndirectListBase.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Type of values the list contains.

Definition at line 147 of file IndirectListBase.H.

◆ pointer

typedef T* pointer

The pointer type for non-const access to value_type items.

Definition at line 152 of file IndirectListBase.H.

◆ const_pointer

typedef const T* const_pointer

The pointer type for const access to value_type items.

Definition at line 157 of file IndirectListBase.H.

◆ reference

typedef T& reference

The type used for storing into value_type objects.

Definition at line 162 of file IndirectListBase.H.

◆ const_reference

typedef const T& const_reference

The type used for reading from constant value_type objects.

Definition at line 167 of file IndirectListBase.H.

◆ size_type

typedef label size_type

The type to represent the size of a UList.

Definition at line 172 of file IndirectListBase.H.

◆ difference_type

typedef label difference_type

The difference between iterator objects.

Definition at line 177 of file IndirectListBase.H.

◆ addressing_type

typedef Addr addressing_type

The addressing type (non-stl definition)

Definition at line 187 of file IndirectListBase.H.

Constructor & Destructor Documentation

◆ IndirectListBase() [1/4]

IndirectListBase ( )

delete

No default construct.

◆ IndirectListBase() [2/4]

IndirectListBase	(	const UList< T > &	values,
		const Addr &	addr
	)

inlinenoexcept

Store references to the values list and the addressing array.

Definition at line 69 of file IndirectListBaseI.H.

◆ IndirectListBase() [3/4]

IndirectListBase	(	UList< T > &&	,
		Args &&	...
	)

delete

The values list (reference) cannot be an rvalue!

◆ IndirectListBase() [4/4]

IndirectListBase	(	const UList< T > &	,
		Addr &&
	)

delete

The addressing (reference) cannot be an rvalue!

Member Function Documentation

◆ empty()

bool empty ( ) const

inlinenoexcept

True if the list is empty (ie, size() is zero).

Definition at line 236 of file IndirectListBase.H.

Referenced by List< Field< scalar > >::List().

Here is the caller graph for this function:

◆ size()

label size ( ) const

inlinenoexcept

The number of elements in the list.

Definition at line 241 of file IndirectListBase.H.

Referenced by UList< Foam::vector >::deepCopy(), List< Field< scalar > >::List(), List< Field< scalar > >::operator=(), PackedList< 2 >::PackedList(), List< Field< scalar > >::push_back(), DynamicList< Foam::vector >::push_back(), LLTMatrix< Type >::solve(), and IndirectListBase< T, labelRange >::writeList().

Here is the caller graph for this function:

◆ values() [1/2]

const UList<T>& values ( ) const

inlinenoexcept

The list of values (without addressing)

Definition at line 246 of file IndirectListBase.H.

◆ values() [2/2]

UList<T>& values ( )

inlinenoexcept

The list of values (without addressing)

Definition at line 251 of file IndirectListBase.H.

◆ addressing()

const Addr& addressing ( ) const

inlinenoexcept

The addressing used for the list.

Definition at line 256 of file IndirectListBase.H.

◆ uniform()

bool uniform ( ) const

inline

True if all entries have identical values, and list is non-empty.

Definition at line 82 of file IndirectListBaseI.H.

Referenced by IndirectListBase< T, labelRange >::writeList().

Here is the caller graph for this function:

◆ front() [1/2]

const T & front ( ) const

inline

The first element of the list.

Definition at line 134 of file IndirectListBaseI.H.

Referenced by IndirectListBase< T, labelRange >::first().

Here is the caller graph for this function:

◆ front() [2/2]

T & front ( )

inline

The first element of the list.

Definition at line 140 of file IndirectListBaseI.H.

◆ back() [1/2]

const T & back ( ) const

inline

The last element of the list.

Definition at line 147 of file IndirectListBaseI.H.

Referenced by IndirectListBase< T, labelRange >::last().

Here is the caller graph for this function:

◆ back() [2/2]

T & back ( )

inline

The last element of the list.

Definition at line 153 of file IndirectListBaseI.H.

◆ fcIndex()

Foam::label fcIndex ( const label i ) const

inlinenoexcept

The forward circular index. The next index in the list which returns to the first at the end of the list.

Definition at line 119 of file IndirectListBaseI.H.

◆ rcIndex()

Foam::label rcIndex ( const label i ) const

inlinenoexcept

The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.

Definition at line 127 of file IndirectListBaseI.H.

◆ fcValue() [1/2]

const T & fcValue ( const label i ) const

inline

Return forward circular value (ie, next value in the list)

Definition at line 160 of file IndirectListBaseI.H.

◆ fcValue() [2/2]

T & fcValue ( const label i )

inline

Return forward circular value (ie, next value in the list)

Definition at line 167 of file IndirectListBaseI.H.

◆ rcValue() [1/2]

const T & rcValue ( const label i ) const

inline

Return reverse circular value (ie, previous value in the list)

Definition at line 174 of file IndirectListBaseI.H.

◆ rcValue() [2/2]

T & rcValue ( const label i )

inline

Return reverse circular value (ie, previous value in the list)

Definition at line 181 of file IndirectListBaseI.H.

◆ extract()

void extract ( UList< T > & result ) const

inline

Extract the addressed elements. Sizes must match!

Definition at line 188 of file IndirectListBaseI.H.

◆ list()

Foam::List< T > list ( ) const

inline

Extract and return the addressed elements as a List.

Definition at line 358 of file IndirectListBaseI.H.

◆ checkAddressing()

void checkAddressing ( ) const

inline

Check that addressing is within valid range of values(), otherwise Fatal.

Definition at line 219 of file IndirectListBaseI.H.

◆ contains()

bool contains	(	const T &	val,
		label	pos = `0`,
		label	len = `-1`
	)		const

inline

Is the value contained in the list?

Parameters

val	The value to search for
pos	The first position to examine (default: 0, no-op if -ve)
len	The length of the search region (-ve until the end)

Returns: true if found.

Definition at line 107 of file IndirectListBaseI.H.

Referenced by IndirectListBase< T, labelRange >::found().

Here is the caller graph for this function:

◆ find()

Foam::label find	(	const T &	val,
		label	pos = `0`,
		label	len = `-1`
	)		const

Find index of the first occurrence of the value.

Parameters

val	The value to search for
pos	The first position to examine (default: 0, no-op if -ve)
len	The length of the search region (-ve until the end)

Returns: position in list or -1 if not found.

Definition at line 25 of file IndirectListBase.C.

Referenced by pureZoneMixture< ThermoType >::pureZoneMixture().

Here is the caller graph for this function:

◆ rfind()

Foam::label rfind	(	const T &	val,
		label	pos = `-1`
	)		const

Find index of the last occurrence of the value.

Any occurrences after the end pos are ignored. Linear search.

Returns: -1 if not found.

Definition at line 61 of file IndirectListBase.C.

◆ operator()()

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

inline

Extract and return the addressed elements as a List. Same as the list() method.

Definition at line 367 of file IndirectListBaseI.H.

◆ operator[]() [1/2]

T & operator[] ( const label i )

inline

Non-const access to an element in the list.

Definition at line 256 of file IndirectListBaseI.H.

◆ operator[]() [2/2]

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

inline

Const access to an element in the list.

Definition at line 264 of file IndirectListBaseI.H.

◆ operator=() [1/5]

void operator= ( const T & val )

inline

Assign all addressed elements to the given value.

Definition at line 271 of file IndirectListBaseI.H.

◆ operator=() [2/5]

void operator= ( Foam::zero )

inline

Assignment of all entries to zero.

Definition at line 281 of file IndirectListBaseI.H.

◆ operator=() [3/5]

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

inline

Deep copy values from a list of the addressed elements.

Fatal if list sizes are not identical

Definition at line 292 of file IndirectListBaseI.H.

◆ operator=() [4/5]

void operator= ( const IndirectListBase< T, Addr > & rhs )

inline

Deep copy values from a list of the addressed elements.

Fatal if list sizes are not identical

Definition at line 312 of file IndirectListBaseI.H.

◆ operator=() [5/5]

void operator= ( const IndirectListBase< T, AnyAddr > & rhs )

inline

Deep copy values from a list of the addressed elements.

Fatal if list sizes are not identical

Definition at line 333 of file IndirectListBaseI.H.

◆ begin() [1/2]

iterator begin ( )

inline

Return an iterator at begin of list.

Definition at line 530 of file IndirectListBase.H.

Referenced by bitSet::bitSet(), HashSet< word, Hash< word > >::HashSet(), HashSet< word, Hash< word > >::insert(), DynamicList< Foam::vector >::push_back(), bitSet::set(), CompactListList< T >::unpack(), HashSet< word, Hash< word > >::unset(), and bitSet::unset().

Here is the caller graph for this function:

◆ end() [1/2]

iterator end ( )

inline

Return an iterator at end of list.

Definition at line 538 of file IndirectListBase.H.

Referenced by bitSet::bitSet(), HashSet< word, Hash< word > >::HashSet(), HashSet< word, Hash< word > >::insert(), DynamicList< Foam::vector >::push_back(), bitSet::set(), HashSet< word, Hash< word > >::unset(), and bitSet::unset().

Here is the caller graph for this function:

◆ cbegin()

const_iterator cbegin ( ) const

inline

Return a const_iterator at begin of list.

Definition at line 549 of file IndirectListBase.H.

Referenced by IndirectListBase< T, labelRange >::begin().

Here is the caller graph for this function:

◆ cend()

const_iterator cend ( ) const

inline

Return a const_iterator at end of list.

Definition at line 557 of file IndirectListBase.H.

Referenced by IndirectListBase< T, labelRange >::end().

Here is the caller graph for this function:

◆ begin() [2/2]

const_iterator begin ( ) const

inline

Return a const_iterator at begin of list.

Definition at line 565 of file IndirectListBase.H.

◆ end() [2/2]

const_iterator end ( ) const

inline

Return a const_iterator at end of list.

Definition at line 570 of file IndirectListBase.H.

◆ writeList()

Foam::Ostream & writeList	(	Ostream &	os,
		const label	shortLen = `0`
	)		const

Write List, with line-breaks in ASCII when length exceeds shortLen.

Using '0' suppresses line-breaks entirely.

Definition at line 30 of file IndirectListBaseIO.C.

◆ first() [1/2]

T& first ( )

inline

Access first element of the list, position [0].

FOAM_DEPRECATED_FOR(2022-10, "front()")

Definition at line 590 of file IndirectListBase.H.

◆ first() [2/2]

const T& first ( ) const

inline

Access first element of the list.

FOAM_DEPRECATED_FOR(2022-10, "front()")

Definition at line 597 of file IndirectListBase.H.

◆ last() [1/2]

T& last ( )

inline

Access last element of the list, position [size()-1].

FOAM_DEPRECATED_FOR(2022-10, "back()")

Definition at line 604 of file IndirectListBase.H.

◆ last() [2/2]

const T& last ( ) const

inline

Access last element of the list, position [size()-1].

FOAM_DEPRECATED_FOR(2022-10, "back()")

Definition at line 611 of file IndirectListBase.H.

◆ found()

bool found	(	const T &	val,
		label	pos = `0`
	)		const

inline

Same as contains()

Definition at line 616 of file IndirectListBase.H.

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

src/OpenFOAM/containers/IndirectLists/IndirectListBase/IndirectListBase.H
src/OpenFOAM/containers/IndirectLists/IndirectListBase/IndirectListBase.C
src/OpenFOAM/containers/IndirectLists/IndirectListBase/IndirectListBaseI.H
src/OpenFOAM/containers/IndirectLists/IndirectListBase/IndirectListBaseIO.C

Classes

Public Types

Public Member Functions

Detailed Description

template<class T, class Addr> class Foam::IndirectListBase< T, Addr >

Member Typedef Documentation

◆ value_type

◆ pointer

◆ const_pointer

◆ reference

◆ const_reference

◆ size_type

◆ difference_type

◆ addressing_type

Constructor & Destructor Documentation

◆ IndirectListBase() [1/4]

◆ IndirectListBase() [2/4]

◆ IndirectListBase() [3/4]

◆ IndirectListBase() [4/4]

Member Function Documentation

◆ empty()

◆ size()

◆ values() [1/2]

◆ values() [2/2]

◆ addressing()

◆ uniform()

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ fcIndex()

◆ rcIndex()

◆ fcValue() [1/2]

◆ fcValue() [2/2]

◆ rcValue() [1/2]

◆ rcValue() [2/2]

◆ extract()

◆ list()

◆ checkAddressing()

◆ contains()

◆ find()

◆ rfind()

◆ operator()()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ begin() [1/2]

◆ end() [1/2]

◆ cbegin()

◆ cend()

◆ begin() [2/2]

◆ end() [2/2]

◆ writeList()

◆ first() [1/2]

◆ first() [2/2]

◆ last() [1/2]

◆ last() [2/2]

◆ found()

template<class T, class Addr>
class Foam::IndirectListBase< T, Addr >