SortableListEFA< Type > Class Template Reference

A list that is sorted upon construction or when explicitly requested with the sort() method. More...

Inheritance diagram for SortableListEFA< Type >:
[legend]
Collaboration diagram for SortableListEFA< Type >:
[legend]

Classes

class  more
 Less function class used by the sort function. More...
 

Public Member Functions

 SortableListEFA (const List< Type > &)
 Construct from List, sorting the elements. Starts with indices set. More...
 
 SortableListEFA (const label size)
 Construct given size. Sort later on. More...
 
 SortableListEFA (const label size, const Type &)
 Construct given size and initial value. Sort later on. More...
 
 SortableListEFA (const SortableListEFA< Type > &)
 Construct as copy. More...
 
const labelListindices () 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, int start)
 Partial sort the list (if changed after construction time) More...
 
void stableSort ()
 Sort the list (if changed after construction time) More...
 
void operator= (const SortableListEFA< Type > &)
 
- Public Member Functions inherited from List< Type >
constexpr List () noexcept
 Null constructor. 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 > &a)
 Copy construct from list. More...
 
 List (const UList< Type > &a)
 Copy construct contents from list. More...
 
 List (List< Type > &a, 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 (InputIterator begIter, InputIterator endIter)
 Construct given begin/end iterators. 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 SLList< Type > &list)
 Construct as copy of SLList<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)
 Move construct from List. More...
 
 List (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< Type > &&list)
 Move construct from SortableList. More...
 
 List (SLList< Type > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< Type > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
void resize (const label newSize)
 Adjust allocated size of list. More...
 
void resize (const label newSize, const Type &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newSize)
 
void setSize (const label newSize)
 Alias for resize(const label) More...
 
void setSize (const label newSize, const Type &val)
 Alias for resize(const label, const T&) More...
 
void clear ()
 Clear the list, i.e. set size to zero. 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...
 
void transfer (List< Type > &list)
 
void transfer (DynamicList< Type, SizeMin > &list)
 
void transfer (SortableList< Type > &list)
 
Type & newElmt (const label i)
 
void operator= (const UList< Type > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Type > &list)
 Assignment to SLList 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= (SortableList< Type > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< Type > &&list)
 Move assignment. Takes constant time. 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...
 

Additional Inherited Members

- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List< Type >
static const List< Type > & null ()
 Return a null List. More...
 

Detailed Description

template<class Type>
class Foam::SortableListEFA< Type >

A list that is sorted upon construction or when explicitly requested with the sort() method.

Source files

Definition at line 52 of file SortableListEFA.H.

Constructor & Destructor Documentation

◆ SortableListEFA() [1/4]

SortableListEFA ( const List< Type > &  values)
explicit

Construct from List, sorting the elements. Starts with indices set.

to index in argument

Definition at line 33 of file SortableListEFA.C.

References SortableListEFA< Type >::sort().

Here is the call graph for this function:

◆ SortableListEFA() [2/4]

SortableListEFA ( const label  size)
explicit

Construct given size. Sort later on.

Definition at line 43 of file SortableListEFA.C.

References forAll.

◆ SortableListEFA() [3/4]

SortableListEFA ( const label  size,
const Type &  val 
)

Construct given size and initial value. Sort later on.

Definition at line 56 of file SortableListEFA.C.

References forAll.

◆ SortableListEFA() [4/4]

SortableListEFA ( const SortableListEFA< Type > &  lst)

Construct as copy.

Definition at line 69 of file SortableListEFA.C.

References forAll.

Member Function Documentation

◆ indices()

const labelList& indices ( ) const
inline

Return the list of sorted indices. Updated every sort.

Definition at line 104 of file SortableListEFA.H.

Referenced by SortableListEFA< Type >::operator=(), and EFA< CompType, ThermoType >::reduceMechanism().

Here is the caller graph for this function:

◆ setSize()

void setSize ( const label  newSize)

Size the list. If grow can cause undefined indices (until next sort)

Definition at line 85 of file SortableListEFA.C.

References List< T >::setSize().

Here is the call graph for this function:

◆ sort()

void sort ( )

Sort the list (if changed after construction time)

Definition at line 93 of file SortableListEFA.C.

References forAll, Foam::less(), Foam::sort(), and List< T >::transfer().

Referenced by SortableListEFA< Type >::SortableListEFA().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ partialSort()

void partialSort ( int  M,
int  start 
)

Partial sort the list (if changed after construction time)

Definition at line 114 of file SortableListEFA.C.

References M.

Referenced by EFA< CompType, ThermoType >::reduceMechanism().

Here is the caller graph for this function:

◆ stableSort()

void stableSort ( )

Sort the list (if changed after construction time)

Definition at line 127 of file SortableListEFA.C.

References forAll, Foam::less(), Foam::stableSort(), and List< T >::transfer().

Here is the call graph for this function:

◆ operator=()

void operator= ( const SortableListEFA< Type > &  rhs)

Definition at line 150 of file SortableListEFA.C.

References SortableListEFA< Type >::indices(), and List< T >::operator=().

Here is the call graph for this function:

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