A list that is sorted upon construction or when explicitly requested with the sort() method. More...
Public Member Functions | |
SortableList () | |
Null constructor, sort later (eg, after assignment or transfer) More... | |
SortableList (const UList< T > &) | |
Construct from UList, sorting immediately. More... | |
SortableList (List< T > &&) | |
Move constructor transferring List, sorting immediately. More... | |
SortableList (const label size) | |
Construct given size. Sort later on. More... | |
SortableList (const label size, const T &) | |
Construct given size and initial value. Sort later on. More... | |
SortableList (const SortableList< T > &) | |
Copy constructor. More... | |
SortableList (SortableList< T > &&) | |
Move constructor. More... | |
SortableList (std::initializer_list< T >) | |
Construct from an initialiser list, sorting immediately. More... | |
const labelList & | indices () const |
Return the list of sorted indices. Updated every sort. More... | |
labelList & | indices () |
Return non-const access to the sorted indices. Updated every sort. More... | |
void | clear () |
Clear the list and the indices. More... | |
List< T > & | shrink () |
Clear the indices and return a reference to the underlying List. More... | |
void | sort () |
(stable) sort the list (if changed after construction time) More... | |
void | reverseSort () |
Reverse (stable) sort the list. More... | |
void | operator= (const T &) |
Assignment of all entries to the given value. More... | |
void | operator= (const UList< T > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const SortableList< T > &) |
Assignment operator. Takes linear time. More... | |
void | operator= (SortableList< T > &&) |
Move assignment operator. More... | |
void | operator= (std::initializer_list< T >) |
Assignment to an initialiser list. More... | |
Public Member Functions inherited from List< T > | |
List () | |
Null constructor. More... | |
List (const label) | |
Construct with given size. More... | |
List (const label, const T &) | |
Construct with given size and value for all elements. More... | |
List (const label, const zero) | |
Construct with given size initialising all elements to zero. More... | |
List (const List< T > &) | |
Copy constructor. More... | |
template<class T2 > | |
List (const UList< T2 > &) | |
Copy constructor from list containing another type. More... | |
List (List< T > &&) | |
Move constructor. More... | |
List (List< T > &, bool reuse) | |
Construct as copy or reuse as specified. More... | |
List (const UList< T > &, const labelUList &mapAddressing) | |
Construct as subset. More... | |
template<class InputIterator > | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. More... | |
template<unsigned Size> | |
List (const FixedList< T, Size > &) | |
Construct as copy of FixedList<T, Size> More... | |
List (const PtrList< T > &) | |
Construct as copy of PtrList<T> More... | |
List (const SLList< T > &) | |
Construct as copy of SLList<T> More... | |
List (const UIndirectList< T > &) | |
Construct as copy of UIndirectList<T> More... | |
List (const BiIndirectList< T > &) | |
Construct as copy of BiIndirectList<T> More... | |
List (std::initializer_list< T >) | |
Construct from an initialiser list. More... | |
List (Istream &) | |
Construct from Istream. More... | |
autoPtr< List< T > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | resize (const label, const T &) |
Alias for setSize(const label, const T&) More... | |
void | setSize (const label) |
Reset size of List. More... | |
void | setSize (const label, const T &) |
Reset size of List and value for new elements. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | append (const T &) |
Append an element at the end of the list. More... | |
void | append (const UList< T > &) |
Append a List at the end of this list. More... | |
void | append (const UIndirectList< T > &) |
Append a UIndirectList at the end of this list. More... | |
void | transfer (List< T > &) |
Transfer the contents of the argument List into this list. More... | |
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv> | |
void | transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. More... | |
void | transfer (SortableList< T > &) |
Transfer the contents of the argument List into this list. More... | |
T & | newElmt (const label) |
Return subscript-checked element of UList. More... | |
void | shallowCopy (const UList< T > &)=delete |
Disallow implicit shallowCopy. More... | |
void | operator= (const UList< T > &) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< T > &) |
Assignment operator. Takes linear time. More... | |
void | operator= (List< T > &&) |
Move assignment operator. More... | |
void | operator= (const SLList< T > &) |
Assignment to SLList operator. Takes linear time. More... | |
void | operator= (const UIndirectList< T > &) |
Assignment to UIndirectList operator. Takes linear time. More... | |
void | operator= (const BiIndirectList< T > &) |
Assignment to BiIndirectList operator. Takes linear time. More... | |
void | operator= (std::initializer_list< T >) |
Assignment to an initialiser list. More... | |
void | operator= (const T &) |
Assignment of all entries to the given value. More... | |
void | operator= (const zero) |
Assignment of all entries to zero. More... | |
Public Member Functions inherited from UList< T > | |
UList () | |
Null constructor. More... | |
UList (T *__restrict__ v, label size) | |
Construct from components. More... | |
UList (const UList< T > &)=default | |
Copy construct. More... | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. More... | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. More... | |
std::streamsize | byteSize () const |
Return the binary size in number of characters of the UList. More... | |
const T * | cdata () const |
Return a const pointer to the first data element,. More... | |
T * | data () |
Return a pointer to the first data element,. More... | |
T & | first () |
Return the first element of the list. More... | |
const T & | first () const |
Return first element of the list. More... | |
T & | last () |
Return the last element of the list. More... | |
const T & | last () const |
Return the last element of the list. More... | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1) More... | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size) More... | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1) More... | |
void | shallowCopy (const UList< T > &) |
Copy the pointer held by the given UList. More... | |
void | deepCopy (const UList< T > &) |
Copy elements of the given UList. More... | |
T & | operator[] (const label) |
Return element of UList. More... | |
const T & | operator[] (const label) const |
Return element of constant UList. More... | |
operator const Foam::List< T > & () const | |
Allow cast to a const List<T>&. More... | |
void | operator= (const T &) |
Assignment of all entries to the given value. More... | |
void | operator= (const zero) |
Assignment of all entries to zero. More... | |
iterator | begin () |
Return an iterator to begin traversing the UList. More... | |
iterator | end () |
Return an iterator to end traversing the UList. More... | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return 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 | 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... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
label | size () const |
Return the number of elements in the UList. More... | |
label | max_size () const |
Return size of the largest possible UList. More... | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero) More... | |
void | swap (UList< T > &) |
Swap two ULists of the same type in constant time. More... | |
bool | operator== (const UList< T > &) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< T > &) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< T > &) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< T > &) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< T > &) const |
Return true if !(a < b). Takes linear time. More... | |
const bool & | operator[] (const label i) const |
Additional Inherited Members | |
Public Types inherited from List< T > | |
typedef SubList< T > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< T > | |
typedef T | value_type |
Type of values the UList contains. More... | |
typedef T & | reference |
Type that can be used for storing into. More... | |
typedef const T & | const_reference |
Type that can be used for storing into. More... | |
typedef label | difference_type |
The type that can represent the difference between any two. More... | |
typedef label | size_type |
The type that can represent the size of a UList. More... | |
typedef T * | iterator |
Random access iterator for traversing UList. More... | |
typedef const T * | const_iterator |
Random access iterator for traversing UList. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator for reverse traversal of UList. More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. More... | |
Static Public Member Functions inherited from List< T > | |
static const List< T > & | null () |
Return a null List. More... | |
Static Public Member Functions inherited from UList< T > | |
static const UList< T > & | null () |
Return a null UList. More... | |
Protected Member Functions inherited from List< T > | |
void | size (const label) |
Override size to be inconsistent with allocated storage. More... | |
A list that is sorted upon construction or when explicitly requested with the sort() method.
Uses the Foam::stableSort() algorithm.
Definition at line 52 of file SortableList.H.
Null constructor, sort later (eg, after assignment or transfer)
Definition at line 31 of file SortableList.C.
|
explicit |
Construct from UList, sorting immediately.
Definition at line 36 of file SortableList.C.
References SortableList< T >::sort().
|
explicit |
Move constructor transferring List, sorting immediately.
Definition at line 45 of file SortableList.C.
References SortableList< T >::sort().
|
explicit |
Construct given size. Sort later on.
The indices remain empty until the list is sorted
Definition at line 54 of file SortableList.C.
SortableList | ( | const label | size, |
const T & | val | ||
) |
Construct given size and initial value. Sort later on.
The indices remain empty until the list is sorted
Definition at line 61 of file SortableList.C.
SortableList | ( | const SortableList< T > & | lst | ) |
Copy constructor.
Definition at line 68 of file SortableList.C.
SortableList | ( | SortableList< T > && | lst | ) |
Move constructor.
Definition at line 76 of file SortableList.C.
SortableList | ( | std::initializer_list< T > | values | ) |
Construct from an initialiser list, sorting immediately.
Definition at line 84 of file SortableList.C.
References SortableList< T >::sort().
|
inline |
Return the list of sorted indices. Updated every sort.
Definition at line 96 of file SortableList.H.
Referenced by binaryTree::balance(), Foam::meshCheck::checkPointNearness(), Foam::meshCheck::checkUpperTriangular(), commSchedule::commSchedule(), geomCellLooper::cut(), searchableBox::findNearestOnEdge(), triangleFuncs::intersect(), Foam::matchPoints(), SortableList< T >::operator=(), SprayCloud< CloudType >::penetration(), repatchMesh::readTriSurface(), ParSortableList< Type >::sort(), and PatchTools::sortedEdgeFaces().
|
inline |
Return non-const access to the sorted indices. Updated every sort.
Definition at line 102 of file SortableList.H.
void clear |
Clear the list and the indices.
Definition at line 96 of file SortableList.C.
References List< T >::clear().
Foam::List< T > & shrink |
Clear the indices and return a reference to the underlying List.
Definition at line 104 of file SortableList.C.
Referenced by List< T >::transfer().
void sort |
(stable) sort the list (if changed after construction time)
also resizes the indices as required
Definition at line 112 of file SortableList.C.
References forAll, Foam::sortedOrder(), and List< T >::transfer().
Referenced by binaryTree::balance(), Foam::meshCheck::checkUpperTriangular(), geomCellLooper::cut(), searchableBox::findNearestOnEdge(), triangleFuncs::intersect(), SprayCloud< CloudType >::penetration(), repatchMesh::readTriSurface(), SortableList< T >::SortableList(), and PatchTools::sortedEdgeFaces().
void reverseSort |
Reverse (stable) sort the list.
Definition at line 127 of file SortableList.C.
References forAll, Foam::sortedOrder(), and List< T >::transfer().
Assignment of all entries to the given value.
Definition at line 144 of file SortableList.C.
Assignment to UList operator. Takes linear time.
Definition at line 151 of file SortableList.C.
References List< T >::operator=().
|
inline |
Assignment operator. Takes linear time.
Definition at line 159 of file SortableList.C.
References SortableList< T >::indices(), and List< T >::operator=().
|
inline |
Move assignment operator.
Definition at line 167 of file SortableList.C.
References List< T >::operator=().
Assignment to an initialiser list.
Definition at line 175 of file SortableList.C.
References List< T >::operator=(), and Foam::sort().