A List with indirect addressing. More...

#include <IndirectList.H>

Inheritance diagram for IndirectList< T >:

[legend]

Collaboration diagram for IndirectList< T >:

[legend]

Public Member Functions
	IndirectList (const UList< T > &values, const labelUList &addr)
	Copy construct addressing, shallow copy values reference.
	IndirectList (const UList< T > &values, labelList &&addr)
	Move construct addressing, shallow copy values reference.
	IndirectList (const UList< T > &values, Foam::zero)
	Zero-sized addressing, shallow copy values reference.
	IndirectList (const IndirectList< T > &list)
	Copy construct addressing, shallow copy values reference.
	IndirectList (IndirectList< T > &&list)
	Move construct addressing, shallow copy values reference.
	IndirectList (const UIndirectList< T > &list)
	Copy construct addressing, shallow copy values reference.
void	operator= (const IndirectList< T > &rhs)
	Deep copy values, Fatal if list sizes are not identical.
template<class UnaryCondition>
Foam::IndirectList< T >	subset (const UList< T > &values, const UnaryCondition &select, const bool invert)
template<class UnaryPredicate>
Foam::IndirectList< T >	subset_if (const UList< T > &values, const UnaryPredicate &pred, const bool invert)
const Addr &	addressing () const noexcept
	The list addressing.
Addr &	addressing () noexcept
	The list addressing.
Public Member Functions inherited from UIndirectList< T >
	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().

Static Public Member Functions
template<class UnaryCondition>
static IndirectList< T >	subset (const UList< T > &values, const UnaryCondition &select, const bool invert=false)
	Return an IndirectList comprising entries with positions that satisfy the condition predicate.
template<class UnaryPredicate>
static IndirectList< T >	subset_if (const UList< T > &values, const UnaryPredicate &pred, const bool invert=false)
	Return an IndirectList comprising entries with values that satisfy the predicate.
static IndirectList< T >	uniq (const UList< T > &values, const bool sorted=false)
	Return an IndirectList with duplicate entries filtered out.

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::IndirectList< T >

A List with indirect addressing.

See also: Foam::UIndirectList for a version without addressing allocation.

Definition at line 120 of file IndirectList.H.

Constructor & Destructor Documentation

◆ IndirectList() [1/6]

template<class T>

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

inline

Copy construct addressing, shallow copy values reference.

Definition at line 25 of file IndirectListI.H.

References addressing(), IndirectListAddressing< labelList >::IndirectListAddressing(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IndirectList() [2/6]

template<class T>

IndirectList	(	const UList< T > &	values,
		labelList &&	addr )

inline

Move construct addressing, shallow copy values reference.

Definition at line 42 of file IndirectListI.H.

References addressing(), IndirectListAddressing< labelList >::IndirectListAddressing(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

◆ IndirectList() [3/6]

template<class T>

IndirectList	(	const UList< T > &	values,
		Foam::zero	)

inline

Zero-sized addressing, shallow copy values reference.

Definition at line 59 of file IndirectListI.H.

References addressing(), IndirectListAddressing< labelList >::IndirectListAddressing(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

◆ IndirectList() [4/6]

template<class T>

IndirectList ( const IndirectList< T > & list )

inline

Copy construct addressing, shallow copy values reference.

Definition at line 75 of file IndirectListI.H.

References addressing(), IndirectList(), IndirectListAddressing< labelList >::IndirectListAddressing(), IndirectListBase< T, labelUList >::list(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

◆ IndirectList() [5/6]

template<class T>

IndirectList ( IndirectList< T > && list )

inline

Move construct addressing, shallow copy values reference.

Definition at line 88 of file IndirectListI.H.

References addressing(), IndirectList(), IndirectListAddressing< labelList >::IndirectListAddressing(), IndirectListBase< T, labelUList >::list(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

◆ IndirectList() [6/6]

template<class T>

IndirectList ( const UIndirectList< T > & list )

inlineexplicit

Copy construct addressing, shallow copy values reference.

Definition at line 101 of file IndirectListI.H.

References addressing(), IndirectListAddressing< labelList >::IndirectListAddressing(), IndirectListBase< T, labelUList >::list(), Foam::T(), UIndirectList< T >::UIndirectList(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

Member Function Documentation

◆ subset() [1/2]

template<class T>

template<class UnaryCondition>

IndirectList< T > subset	(	const UList< T > &	values,
		const UnaryCondition &	select,
		const bool	invert = false )

static

Return an IndirectList comprising entries with positions that satisfy the condition predicate.

The condition predicate can be considered a type of mask for any given position. A boolList, bitSet, labelRange or labelHashSet all satisfy the requirements for use as position condition predicates.

Parameters

values	The source list values
select	Accept/reject predicate based on position.
invert	Invert (negate) the selection logic

◆ subset_if() [1/2]

template<class T>

template<class UnaryPredicate>

IndirectList< T > subset_if	(	const UList< T > &	values,
		const UnaryPredicate &	pred,
		const bool	invert = false )

static

Return an IndirectList comprising entries with values that satisfy the predicate.

Parameters

values	The source list values
pred	Predicate used to test the value
invert	Invert (negate) the selection logic

Referenced by Foam::createReconstructMap().

Here is the caller graph for this function:

◆ uniq()

template<class T>

Foam::IndirectList< T > uniq	(	const UList< T > &	values,
		const bool	sorted = false )

static

Return an IndirectList with duplicate entries filtered out.

Preserves the original input order, unless sorted = true

Parameters

values	The source list values
sorted	Retain sorted order instead of original order

Definition at line 180 of file IndirectListI.H.

References IndirectList(), Foam::sort(), Foam::sortedOrder(), and IndirectListBase< T, labelUList >::values().

Here is the call graph for this function:

◆ operator=()

template<class T>

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

inline

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

Definition at line 234 of file IndirectList.H.

◆ subset() [2/2]

template<class T>

template<class UnaryCondition>

Foam::IndirectList< T > subset	(	const UList< T > &	values,
		const UnaryCondition &	select,
		const bool	invert )

Definition at line 117 of file IndirectListI.H.

◆ subset_if() [2/2]

template<class T>

template<class UnaryPredicate>

Foam::IndirectList< T > subset_if	(	const UList< T > &	values,
		const UnaryPredicate &	pred,
		const bool	invert )

Definition at line 149 of file IndirectListI.H.

◆ addressing() [1/2]

template<class T>

const Addr & addressing ( ) const

inlinenoexcept

The list addressing.

Definition at line 80 of file IndirectListAddressing.H.

Referenced by SortList< T >::indices(), SortList< T >::indices(), IndirectList(), IndirectList(), IndirectList(), IndirectList(), IndirectList(), IndirectList(), perfectInterface::setRefinement(), sampledFaceZone::update(), and sampledPatch::update().

Here is the caller graph for this function:

◆ addressing() [2/2]

template<class T>

Addr & addressing ( )

inlinenoexcept

The list addressing.

Definition at line 88 of file IndirectListAddressing.H.

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

src/OpenFOAM/containers/IndirectLists/IndirectList/IndirectList.H
src/OpenFOAM/containers/IndirectLists/IndirectList/IndirectListI.H

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IndirectList() [1/6]

◆ IndirectList() [2/6]

◆ IndirectList() [3/6]

◆ IndirectList() [4/6]

◆ IndirectList() [5/6]

◆ IndirectList() [6/6]

Member Function Documentation

◆ subset() [1/2]

◆ subset_if() [1/2]

◆ uniq()

◆ operator=()

◆ subset() [2/2]

◆ subset_if() [2/2]

◆ addressing() [1/2]

◆ addressing() [2/2]