A list that is sorted upon construction or when explicitly requested with the sort() method. More...
Classes | |
| class | less |
| Less function class used by the sort function. More... | |
Public Member Functions | |
| SortableListDRGEP (const List< Type > &) | |
| Construct from List, sorting the elements. Starts with indices set. More... | |
| SortableListDRGEP (const label size) | |
| Construct given size. Sort later on. More... | |
| SortableListDRGEP (const label size, const Type &) | |
| Construct given size and initial value. Sort later on. More... | |
| SortableListDRGEP (const SortableListDRGEP< Type > &) | |
| Construct as copy. More... | |
| const labelList & | indices () const |
| Return the list of sorted indices. Updated every sort. More... | |
| void | setSize (const label) |
| Size the list. If grow can cause undefined indices (until next sort) More... | |
| void | sort () |
| Sort the list (if changed after construction time) More... | |
| void | partialSort (int M) |
| Partial sort the list (if changed after construction time) More... | |
| void | stableSort () |
| Sort the list (if changed after construction time) More... | |
| void | operator= (const SortableListDRGEP< Type > &) |
 Public Member Functions inherited from List< Type > | |
| constexpr | List () noexcept |
| Default construct. More... | |
| List (const label len) | |
| Construct with given size. More... | |
| List (const label len, const Type &val) | |
| Construct with given size and value for all elements. More... | |
| List (const label len, const Foam::zero) | |
| Construct with given size initializing all elements to zero. More... | |
| List (const Foam::one, const Type &val) | |
| Construct with length=1, copying the value as the only content. More... | |
| List (const Foam::one, Type &&val) | |
| Construct with length=1, moving the value as the only content. More... | |
| List (const Foam::one, const Foam::zero) | |
| Construct with length=1, initializing content to zero. More... | |
| List (const List< Type > &list) | |
| Copy construct from list. More... | |
| List (const UList< Type > &list) | |
| Copy construct contents from list. More... | |
| List (List< Type > &list, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< Type > &list, const labelUList &indices) | |
| Copy construct subset of list. More... | |
| List (const UList< Type > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. More... | |
| List (const FixedList< Type, N > &list) | |
| Construct as copy of FixedList<T, N> More... | |
| List (const PtrList< Type > &list) | |
| Construct as copy of PtrList<T> More... | |
| List (const IndirectListBase< Type, Addr > &list) | |
| Construct as copy of IndirectList contents. More... | |
| List (std::initializer_list< Type > list) | |
| Construct from an initializer list. More... | |
| List (List< Type > &&list) noexcept | |
| Move construct from List. More... | |
| List (DynamicList< Type, SizeMin > &&list) | |
| Move construct from DynamicList. More... | |
| List (Istream &is) | |
| Construct from Istream. More... | |
| List (const SLList< Type > &list) | |
| Copy construct from SLList. More... | |
| autoPtr< List< Type > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | resize (const label len) |
| Adjust allocated size of list. More... | |
| void | resize (const label len, const Type &val) |
| Adjust allocated size of list and set val for new elements. More... | |
| void | resize (const label newLen) |
| void | resize_fill (const label len, const Type &val) |
| Adjust allocated size of list and set val for all elements. More... | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. More... | |
| void | resize_unsafe (const label len) noexcept |
| Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
| void | setSize (const label n) |
| Alias for resize() More... | |
| void | setSize (const label n, const Type &val) |
| Alias for resize() More... | |
| void | transfer (List< Type > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More... | |
| void | transfer (DynamicList< Type, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More... | |
| Type & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. More... | |
| Type & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. More... | |
| void | push_back (const Type &val) |
| Append an element at the end of the list. More... | |
| void | push_back (Type &&val) |
| Move append an element at the end of the list. More... | |
| void | push_back (const UList< Type > &list) |
| Append a List to the end of this list. More... | |
| void | push_back (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | push_uniq (const Type &val) |
| Append an element if not already in the list. More... | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. More... | |
| void | operator= (const UList< Type > &list) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< Type > &list) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (const IndirectListBase< Type, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More... | |
| void | operator= (const FixedList< Type, N > &list) |
| Copy assignment from FixedList. More... | |
| void | operator= (std::initializer_list< Type > list) |
| Assignment to an initializer list. More... | |
| void | operator= (const Type &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More... | |
| void | operator= (List< Type > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (DynamicList< Type, SizeMin > &&list) |
| Move assignment. Takes constant time. More... | |
| void | operator= (const SLList< Type > &list) |
| Copy assign from SLList in linear time. More... | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. More... | |
| void | shallowCopy (const UList< Type > &)=delete |
| No shallowCopy permitted. More... | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More... | |
| void | append (const Type &val) |
| Append an element at the end of the list. More... | |
| void | append (Type &&val) |
| Move append an element at the end of the list. More... | |
| void | append (const UList< Type > &list) |
| Append a List to the end of this list. More... | |
| void | append (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. More... | |
| label | appendUniq (const Type &val) |
| Same as push_uniq() More... | |
| Public Member Functions inherited from UList< Type > | |
| label | size () const noexcept |
| The number of elements in the container. More... | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the List as a dictionary entry with keyword. More... | |
| void | operator= (const Type &val) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More... | |
| UList (const UList< Type > &)=default | |
| Copy construct. More... | |
| constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. More... | |
| UList (Type *__restrict__ v, const label len) noexcept | |
| Construct from components. 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 Type & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list) More... | |
| Type & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list) More... | |
| const Type & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list) More... | |
| Type & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list) More... | |
| const Type * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| Type * | data () noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. More... | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. More... | |
| Type & | front () |
| Access first element of the list, position [0]. More... | |
| const Type & | front () const |
| Access first element of the list. More... | |
| Type & | back () |
| Access last element of the list, position [size()-1]. More... | |
| const Type & | back () const |
| Access last element of the list, position [size()-1]. More... | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. More... | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size) More... | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. More... | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. More... | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size) More... | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. More... | |
| bool | contains (const Type &val) const |
| True if the value is contained in the list. More... | |
| bool | contains (const Type &val, label pos, label len=-1) const |
| Is the value contained in the list? More... | |
| label | find (const Type &val) const |
| Find index of the first occurrence of the value. More... | |
| label | find (const Type &val, label pos, label len=-1) const |
| Find index of the first occurrence of the value. More... | |
| label | rfind (const Type &val, label pos=-1) const |
| Find index of the last occurrence of the value. More... | |
| void | moveFirst (const label i) |
| Move element to the first position. More... | |
| void | moveLast (const label i) |
| Move element to the last position. More... | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. More... | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. More... | |
| void | shallowCopy (Type *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. More... | |
| void | shallowCopy (const UList< Type > &list) noexcept |
| Copy the pointer and size held by the given UList. More... | |
| void | deepCopy (const UList< Type > &list) |
| Copy elements of the given UList. Sizes must match! More... | |
| void | deepCopy (const IndirectListBase< Type, Addr > &list) |
| Copy elements of the given indirect list. Sizes must match! More... | |
| SubList< Type > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. More... | |
| const SubList< Type > | slice (const label pos, label len=-1) const |
| Return SubList slice (const access) - no range checking. More... | |
| SubList< Type > | slice (const labelRange &range) |
| Return SubList slice (non-const access) - with range checking. More... | |
| const SubList< Type > | slice (const labelRange &range) const |
| Return SubList slice (const access) - with range checking. More... | |
| Type & | operator[] (const label i) |
| Return element of UList. More... | |
| const Type & | operator[] (const label i) const |
| Return element of constant UList. More... | |
| const bool & | operator[] (const label i) const |
| UPstream::commsStruct & | operator[] (const label procID) |
| const UPstream::commsStruct & | operator[] (const label procID) const |
| Foam::UPstream::commsStruct & | operator[] (const label procID) |
| const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. More... | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. More... | |
| iterator | begin (const label i) noexcept |
| Return iterator at offset i from begin, clamped to [0,size] range. More... | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | begin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cbegin (const label i) const noexcept |
| Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. More... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero) More... | |
| label | capacity () const noexcept |
| Size of the underlying storage. More... | |
| void | swap (UList< Type > &list) noexcept |
| Swap content with another UList of the same type in constant time. More... | |
| bool | operator== (const UList< Type > &list) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< Type > &list) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< Type > &list) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< Type > &list) const |
| Return true if !(a < b). Takes linear time. More... | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. More... | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
| std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
| Type & | first () |
| Access first element of the list, position [0]. More... | |
| const Type & | first () const |
| Access first element of the list. More... | |
| Type & | last () |
| Access last element of the list, position [size()-1]. More... | |
| const Type & | last () const |
| Access last element of the list, position [size()-1]. More... | |
| bool | found (const Type &val, label pos=0) const |
| Same as contains() More... | |
Additional Inherited Members | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| The value type the list contains. More... | |
| typedef Type * | pointer |
| The pointer type for non-const access to value_type items. More... | |
| typedef const Type * | const_pointer |
| The pointer type for const access to value_type items. More... | |
| typedef Type & | reference |
| The type used for storing into value_type objects. More... | |
| typedef const Type & | const_reference |
| The type used for reading from constant value_type objects. More... | |
| typedef Type * | iterator |
| Random access iterator for traversing a UList. More... | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing a UList. 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 std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access) More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access) More... | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () |
| Return a UList reference to a nullObject. More... | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. More... | |
| Protected Member Functions inherited from UList< Type > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. More... | |
| void | size (const label n) |
| Older name for setAddressableSize. More... | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. More... | |
| void | writeEntry (Ostream &os) const |
| Character list writeEntry. More... | |
| void | writeEntry (Ostream &os) const |
| 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. More... | |
| void | fill_uniform (const Type &val) |
| Assign all entries to the given value. More... | |
| void | fill_uniform (const Foam::zero) |
| Assign all entries to zero. More... | |
| UList< Type > & | operator= (const UList< Type > &)=delete |
| No copy assignment (default: shallow copy) More... | |
| void | operator= (const Foam::zero) |
| Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
| void | operator= (const Foam::zero) |
A list that is sorted upon construction or when explicitly requested with the sort() method.
Definition at line 48 of file SortableListDRGEP.H.
|
explicit |
Construct from List, sorting the elements. Starts with indices set.
to index in argument
Definition at line 27 of file SortableListDRGEP.C.
References SortableListDRGEP< Type >::sort().
|
explicit |
Construct given size. Sort later on.
Definition at line 37 of file SortableListDRGEP.C.
| SortableListDRGEP | ( | const label | size, |
| const Type & | val | ||
| ) |
Construct given size and initial value. Sort later on.
Definition at line 46 of file SortableListDRGEP.C.
| SortableListDRGEP | ( | const SortableListDRGEP< Type > & | lst | ) |
Construct as copy.
Definition at line 58 of file SortableListDRGEP.C.
|
inline |
Return the list of sorted indices. Updated every sort.
Definition at line 115 of file SortableListDRGEP.H.
Referenced by SortableListDRGEP< Type >::operator=(), and DRGEP< CompType, ThermoType >::reduceMechanism().
| void setSize | ( | const label | newSize | ) |
Size the list. If grow can cause undefined indices (until next sort)
Definition at line 70 of file SortableListDRGEP.C.
References List< T >::setSize().
| void sort | ( | ) |
Sort the list (if changed after construction time)
Definition at line 78 of file SortableListDRGEP.C.
References forAll, Foam::less(), Foam::sort(), and List< T >::transfer().
Referenced by SortableListDRGEP< Type >::SortableListDRGEP().
| void partialSort | ( | int | M | ) |
Partial sort the list (if changed after construction time)
Definition at line 99 of file SortableListDRGEP.C.
References forAll, Foam::less(), and M.
Referenced by DRGEP< CompType, ThermoType >::reduceMechanism().
| void stableSort | ( | ) |
Sort the list (if changed after construction time)
Definition at line 117 of file SortableListDRGEP.C.
References forAll, Foam::less(), Foam::stableSort(), and List< T >::transfer().
| void operator= | ( | const SortableListDRGEP< Type > & | rhs | ) |
Definition at line 141 of file SortableListDRGEP.C.
References SortableListDRGEP< Type >::indices(), and List< T >::operator=().
1.8.14 