Public Member Functions | List of all members
SortableList< T > Class Template Reference

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

Inheritance diagram for SortableList< T >:
Inheritance graph
[legend]
Collaboration diagram for SortableList< T >:
Collaboration graph
[legend]

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 (const Xfer< List< T > > &)
 Construct from transferred 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 > &)
 Construct as copy. More...
 
const labelListindices () const
 Return the list of sorted indices. Updated every sort. More...
 
labelListindices ()
 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...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container as a plain List. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const SortableList< T > &)
 Assignment operator. Takes linear time. 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 List< T > &)
 Copy constructor. More...
 
 List (const Xfer< List< T > > &)
 Construct by transferring the parameter contents. More...
 
 List (List< T > &, bool reUse)
 Construct as copy or re-use 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 (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...
 
Xfer< List< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< T > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. 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 Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< T > &)
 Assign elements to those from UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (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...
 
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...
 
template<>
const bool & operator[] (const label i) const
 

Additional Inherited Members

- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_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 Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef Treverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Tconst_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...
 

Detailed Description

template<class T>
class Foam::SortableList< T >

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

Uses the Foam::stableSort() algorithm.

Source files

Definition at line 65 of file List.H.

Constructor & Destructor Documentation

Null constructor, sort later (eg, after assignment or transfer)

Definition at line 31 of file SortableList.C.

SortableList ( const UList< T > &  values)
explicit

Construct from UList, sorting immediately.

Definition at line 36 of file SortableList.C.

References SortableList< T >::sort().

Here is the call graph for this function:

SortableList ( const Xfer< List< T > > &  values)
explicit

Construct from transferred List, sorting immediately.

Definition at line 45 of file SortableList.C.

References SortableList< T >::sort().

Here is the call graph for this function:

SortableList ( const label  size)
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)

Construct as copy.

Definition at line 68 of file SortableList.C.

Member Function Documentation

const labelList& indices ( ) const
inline
labelList& indices ( )
inline

Return non-const access to the sorted indices. Updated every sort.

Definition at line 96 of file SortableList.H.

References SortableList< T >::clear(), SortableList< T >::operator=(), SortableList< T >::reverseSort(), SortableList< T >::shrink(), SortableList< T >::sort(), Foam::T(), and SortableList< T >::xfer().

Here is the call graph for this function:

void clear ( )

Clear the list and the indices.

Definition at line 79 of file SortableList.C.

References List< T >::clear().

Referenced by SortableList< T >::indices().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::List< T > & shrink ( )

Clear the indices and return a reference to the underlying List.

Definition at line 87 of file SortableList.C.

References List< T >::clear().

Referenced by SortableList< T >::indices(), and List< T >::transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

void sort ( )

(stable) sort the list (if changed after construction time)

also resizes the indices as required

Definition at line 95 of file SortableList.C.

References forAll, UList< T >::operator[](), List< T >::size(), Foam::sortedOrder(), and List< T >::transfer().

Referenced by triSurface::checkEdges(), searchableBox::findNearestOnEdge(), SortableList< T >::indices(), triangleFuncs::intersect(), KinematicCloud< CloudType >::penetration(), faceCollapser::setRefinement(), SortableList< T >::SortableList(), and PatchTools::sortedEdgeFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

void reverseSort ( )

Reverse (stable) sort the list.

Definition at line 110 of file SortableList.C.

References forAll, UList< T >::operator[](), List< T >::size(), Foam::sortedOrder(), and List< T >::transfer().

Referenced by SortableList< T >::indices().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::Xfer< Foam::List< T > > xfer ( )
inline

Transfer contents to the Xfer container as a plain List.

Definition at line 125 of file SortableList.C.

Referenced by SortableList< T >::indices().

Here is the caller graph for this function:

void operator= ( const T t)
inline

Assignment of all entries to the given value.

Definition at line 134 of file SortableList.C.

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

Referenced by SortableList< T >::indices().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const UList< T > &  rhs)
inline

Assignment from UList operator. Takes linear time.

Definition at line 141 of file SortableList.C.

References List< T >::clear(), and List< T >::operator=().

Here is the call graph for this function:

void operator= ( const SortableList< T > &  rhs)
inline

Assignment operator. Takes linear time.

Definition at line 149 of file SortableList.C.

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

Here is the call graph for this function:


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