Indirect access to a sub-section of a list. More...
Public Member Functions | |
IndirectSubList (const UList< T > &values) | |
Construct from UList, the entire size. More... | |
IndirectSubList (const UList< T > &values, const labelRange &addr) | |
Construct from values list and range. More... | |
const Addr & | addressing () const noexcept |
The list addressing. More... | |
Addr & | addressing () noexcept |
The list addressing. More... | |
Public Member Functions inherited from IndirectListBase< T, labelRange > | |
IndirectListBase ()=delete | |
No default construct. More... | |
IndirectListBase (const UList< T > &values, const labelRange &addr) | |
Store references to the values list and the addressing array. 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 labelRange & | 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 |
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 |
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... | |
List< T > | list () const |
Return the addressed elements as a List. More... | |
label | find (const T &val, label pos=0) 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... | |
bool | contains (const T &val, label pos=0) const |
Is the value contained in the list? More... | |
List< T > | operator() () const |
Return the addressed elements as a List. 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= (const 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< T, labelRange > &rhs) |
Deep copy values from a list of the addressed elements. More... | |
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... | |
const_iterator | begin () const |
Return a const_iterator at begin of list. More... | |
iterator | end () |
Return an iterator at end of list. More... | |
const_iterator | end () const |
Return a const_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... | |
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... | |
Additional Inherited Members | |
Public Types inherited from IndirectListBase< T, labelRange > | |
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 labelRange | addressing_type |
The addressing type (non-stl definition) More... | |
Protected Member Functions inherited from IndirectListBase< T, labelRange > | |
void | copyList (const ListType &rhs) |
Deep copy values from the list. More... | |
Indirect access to a sub-section of a list.
In many cases, using a Foam::SubList provides a simpler and more efficient means of accessing a sub-list. There are, however, some advantages of a IndirectSubList:
Definition at line 41 of file IndirectListsFwd.H.
|
inlineexplicit |
Construct from UList, the entire size.
Definition at line 69 of file IndirectSubList.H.
|
inline |
Construct from values list and range.
Definition at line 83 of file IndirectSubList.H.
|
inlinenoexcept |
The list addressing.
Definition at line 80 of file IndirectListAddressing.H.
|
inlinenoexcept |
The list addressing.
Definition at line 88 of file IndirectListAddressing.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.