A non-owning sub-view of a List (allocated or unallocated storage). More...

#include <SubList.H>

Inheritance diagram for SubList< T >:

[legend]

Collaboration diagram for SubList< T >:

Public Member Functions
	SubList () noexcept=default
	Default construct, zero-sized and nullptr.
	SubList (const SubList< T > &) noexcept=default
	Copy construct, shallow copy.
	SubList (const UList< T > &list) noexcept
	Construct from UList, the entire size.
template<unsigned N>
	SubList (const FixedList< T, N > &list) noexcept
	Construct from FixedList, the entire size.
	SubList (const UList< T > &list, const label len)
	Construct from UList and sub-list size, start at 0.
	SubList (const UList< T > &list, const label len, const label start)
	Construct from UList, sub-list size and start index.
	SubList (const UList< T > &list, const labelRange &range)
	Construct from UList and a (start,size) range.
	SubList (const labelRange &range, const UList< T > &list)
	Construct from UList and a (start,size) range, but bypassing run-time range checking.
UList< T > &	reset (std::nullptr_t) noexcept
	Reset to zero-sized and nullptr.
UList< T > &	reset (const UList< T > &list) noexcept
	Reset to use entire UList.
UList< T > &	reset (const UList< T > &list, const label len)
	Reset to use UList with sub-list size, start at 0.
UList< T > &	reset (const UList< T > &list, const label len, const label start)
	Reset to use UList with sub-list size and start index.
UList< T > &	reset (const UList< T > &list, const labelRange &range)
	Reset to use UList with a (start,size) range.
UList< T > &	reset (const labelRange &range, const UList< T > &list)
	Reset to use UList with a (start,size) range, but bypassing run-time range checking.
	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&.
void	operator= (const SubList< T > &list)
	Copy assign entries (deep copy) from given sub-list. Sizes must match!
void	operator= (const UList< T > &list)
	Copy assign entries (deep copy) from given list. Sizes must match!
template<class Addr>
void	operator= (const IndirectListBase< T, Addr > &list)
	Copy assign entries from given indirect list. Sizes must match!
void	operator= (const T &val)
	Assign all entries to the given value.
void	operator= (Foam::zero)
	Assign all entries to zero.
Public Member Functions inherited from UList< T >
	UList (const UList< T > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< T > &&) noexcept=default
	Move construct, shallow copy.
UList< T > &	operator= (const UList< T > &)=delete
	No copy assignment (default: shallow copy).
UList< T > &	operator= (UList< T > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (T *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< T > &&) noexcept
	Move construct from a SubList, shallow copy.
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.
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.
const T &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
T &	fcValue (const label i)
	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).
T &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const T *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
T *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
T &	front ()
	Access first element of the list, position [0].
const T &	front () const
	Access first element of the list.
T &	back ()
	Access last element of the list, position [size()-1].
const T &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const T &val) const
	True if the value is contained in the list.
bool	contains (const T &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const T &val) const
	Find index of the first occurrence of the value.
label	find (const T &val, label pos, 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.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (T *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< T > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< T > &list)
	Copy elements of the given UList. Sizes must match!
template<class Addr>
void	deepCopy (const IndirectListBase< T, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< T >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< T >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< T >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< T >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
T &	operator[] (const label i)
	Return element of UList.
const T &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< T > & () const
	Allow cast to a const List<T>&.
void	operator= (const T &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< T > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< T > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< T > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< T > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< T > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< T > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	all () const
	True if all entries are 'true' or if the list is empty.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	any () const
	True if any entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	none () const
	True if no entries are 'true'.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_bool_v<TypeT>>>
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
template<class TypeT = T, class = std::enable_if_t<stdFoam::is_char_v<TypeT>>>
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
T &	first ()
	Access first element of the list, position [0].
const T &	first () const
	Access first element of the list.
T &	last ()
	Access last element of the list, position [size()-1].
const T &	last () const
	Access last element of the list, position [size()-1].
bool	found (const T &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
template<typename E>
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.

Static Public Member Functions
static const SubList< T > &	null () noexcept
	Return a null SubList (reference to a nullObject). Behaves like an empty SubList.
Static Public Member Functions inherited from UList< T >
static const UList< T > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

Additional Inherited Members
Public Types inherited from UList< T >
typedef T	value_type
	The value type 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 T *	iterator
	Random access iterator for traversing a UList.
typedef const T *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List = void
	Have unique tag.
Protected Member Functions inherited from UList< T >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const T &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Detailed Description

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

A non-owning sub-view of a List (allocated or unallocated storage).

Source files

Definition at line 58 of file SubList.H.

Constructor & Destructor Documentation

◆ SubList() [1/8]

template<class T>

SubList ( )

defaultnoexcept

Default construct, zero-sized and nullptr.

Referenced by operator=(), SubList(), and SubList().

Here is the caller graph for this function:

◆ SubList() [2/8]

template<class T>

SubList ( const SubList< T > & )

defaultnoexcept

Copy construct, shallow copy.

◆ SubList() [3/8]

template<class T>

SubList ( const UList< T > & list )

inlineexplicitnoexcept

Construct from UList, the entire size.

Definition at line 27 of file SubListI.H.

References Foam::noexcept, Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ SubList() [4/8]

template<class T>

template<unsigned N>

SubList ( const FixedList< T, N > & list )

inlineexplicitnoexcept

Construct from FixedList, the entire size.

Definition at line 38 of file SubListI.H.

References Foam::noexcept, Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ SubList() [5/8]

template<class T>

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

inline

Construct from UList and sub-list size, start at 0.

Definition at line 48 of file SubListI.H.

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

Here is the call graph for this function:

◆ SubList() [6/8]

template<class T>

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

inline

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

Definition at line 63 of file SubListI.H.

References UList< T >::cdata(), UList< T >::checkRange(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ SubList() [7/8]

template<class T>

SubList	(	const UList< T > &	list,
		const labelRange &	range )

inline

Construct from UList and a (start,size) range.

The range is subsetted with the list size itself to ensure that the result always addresses a valid section of the list.

Definition at line 79 of file SubListI.H.

References UList< T >::checkRange(), range, UList< T >::size(), SubList(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ SubList() [8/8]

template<class T>

SubList	(	const labelRange &	range,
		const UList< T > &	list )

inline

Construct from UList and a (start,size) range, but bypassing run-time range checking.

Definition at line 96 of file SubListI.H.

References range, UList< T >::size(), SubList(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

Member Function Documentation

◆ null()

template<class T>

const SubList< T > & null ( )

inlinestaticnoexcept

Return a null SubList (reference to a nullObject). Behaves like an empty SubList.

Definition at line 70 of file SubList.H.

◆ reset() [1/6]

template<class T>

Foam::UList< T > & reset ( std::nullptr_t )

inlinenoexcept

Reset to zero-sized and nullptr.

Definition at line 109 of file SubListI.H.

References UList< T >::shallowCopy().

Here is the call graph for this function:

◆ reset() [2/6]

template<class T>

Foam::UList< T > & reset ( const UList< T > & list )

inlinenoexcept

Reset to use entire UList.

Definition at line 117 of file SubListI.H.

References UList< T >::shallowCopy(), and UList< T >::UList().

Here is the call graph for this function:

◆ reset() [3/6]

template<class T>

Foam::UList< T > & reset	(	const UList< T > &	list,
		const label	len )

inline

Reset to use UList with sub-list size, start at 0.

Definition at line 128 of file SubListI.H.

References UList< T >::cdata(), UList< T >::checkSize(), UList< T >::shallowCopy(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ reset() [4/6]

template<class T>

Foam::UList< T > & reset	(	const UList< T > &	list,
		const label	len,
		const label	start )

inline

Reset to use UList with sub-list size and start index.

Definition at line 144 of file SubListI.H.

References UList< T >::UList().

Here is the call graph for this function:

◆ reset() [5/6]

template<class T>

Foam::UList< T > & reset	(	const UList< T > &	list,
		const labelRange &	range )

inline

Reset to use UList with a (start,size) range.

The range is subsetted with the list size itself to ensure that the result always addresses a valid section of the list.

Definition at line 165 of file SubListI.H.

References UList< T >::cdata(), UList< T >::checkRange(), range, UList< T >::shallowCopy(), IntRange< IntType >::size(), UList< T >::size(), IntRange< IntType >::start(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

◆ reset() [6/6]

template<class T>

Foam::UList< T > & reset	(	const labelRange &	range,
		const UList< T > &	list )

inline

Reset to use UList with a (start,size) range, but bypassing run-time range checking.

Definition at line 189 of file SubListI.H.

References UList< T >::cdata(), UList< T >::checkRange(), range, UList< T >::shallowCopy(), Foam::T(), and UList< T >::UList().

Here is the call graph for this function:

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

template<class T>

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

inline

Allow cast to a const List<T>&.

Definition at line 204 of file SubList.H.

◆ operator=() [1/5]

template<class T>

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

inline

Copy assign entries (deep copy) from given sub-list. Sizes must match!

Definition at line 211 of file SubListI.H.

References SubList().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/5]

template<class T>

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

inline

Copy assign entries (deep copy) from given list. Sizes must match!

Definition at line 218 of file SubListI.H.

References UList< T >::deepCopy(), and UList< T >::UList().

Here is the call graph for this function:

◆ operator=() [3/5]

template<class T>

template<class Addr>

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

inline

Copy assign entries from given indirect list. Sizes must match!

Definition at line 226 of file SubListI.H.

References UList< T >::deepCopy().

Here is the call graph for this function:

◆ operator=() [4/5]

template<class T>

void operator= ( const T & val )

inline

Assign all entries to the given value.

Definition at line 233 of file SubListI.H.

References UList< T >::operator=(), and Foam::T().

Here is the call graph for this function:

◆ operator=() [5/5]

template<class T>

void operator= ( Foam::zero )

inline

Assign all entries to zero.

Definition at line 240 of file SubListI.H.

References UList< T >::operator=().

Here is the call graph for this function:

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SubList() [1/8]

◆ SubList() [2/8]

◆ SubList() [3/8]

◆ SubList() [4/8]

◆ SubList() [5/8]

◆ SubList() [6/8]

◆ SubList() [7/8]

◆ SubList() [8/8]

Member Function Documentation

◆ null()

◆ reset() [1/6]

◆ reset() [2/6]

◆ reset() [3/6]

◆ reset() [4/6]

◆ reset() [5/6]

◆ reset() [6/6]

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

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]