Implementation of PSRS parallel sorting routine. More...
#include <ParSortableList.H>
Public Member Functions | |
| ParSortableList (const UList< Type > &) | |
| Construct from List, sorting the elements. | |
| ParSortableList (const label size) | |
| Construct given size. Sort later on. | |
| void | sort () |
| (stable) sort the list (if changed after construction time) | |
| const labelList & | indices () const |
| Return the list of sorted point indices. | |
| const labelList & | procs () const |
| Return the list of processor number. | |
| Public Member Functions inherited from List< Type > | |
| constexpr | List () noexcept |
| Default construct. | |
| List (const label len) | |
| Construct with given size. | |
| List (const label len, const Type &val) | |
| Construct with given size and value for all elements. | |
| List (const label len, Foam::zero) | |
| Construct with given size initializing all elements to zero. | |
| List (Foam::one, const Type &val) | |
| Construct with length=1, copying the value as the only content. | |
| List (Foam::one, Type &&val) | |
| Construct with length=1, moving the value as the only content. | |
| List (Foam::one, Foam::zero) | |
| Construct with length=1, initializing content to zero. | |
| List (const List< Type > &list) | |
| Copy construct from list. | |
| List (const UList< Type > &list) | |
| Copy construct contents from list. | |
| List (List< Type > &list, bool reuse) | |
| Construct as copy or re-use as specified. | |
| List (const UList< Type > &list, const labelUList &indices) | |
| Copy construct subset of list. | |
| List (const UList< Type > &list, const FixedList< label, N > &indices) | |
| Copy construct subset of list. | |
| List (const FixedList< Type, N > &list) | |
| Construct as copy of FixedList<T, N>. | |
| List (const UPtrList< Type > &list) | |
| Construct as copy of UPtrList<T> content. | |
| List (const IndirectListBase< Type, Addr > &list) | |
| Construct as copy of IndirectList contents. | |
| List (std::initializer_list< Type > list) | |
| Construct from an initializer list. | |
| List (List< Type > &&list) noexcept | |
| Move construct from List. | |
| List (DynamicList< Type, SizeMin > &&list) | |
| Move construct from DynamicList. | |
| List (Istream &is) | |
| Construct from Istream. | |
| autoPtr< List< Type > > | clone () const |
| Clone. | |
| ~List () | |
| Destructor. | |
| void | clear () |
| Clear the list, i.e. set size to zero. | |
| void | resize (const label len) |
| Adjust allocated size of list. | |
| void | resize (const label len, const Type &val) |
| Adjust allocated size of list and set val for new elements. | |
| void | resize_copy (label count, const label len) |
| Change allocated size of list, retaining the first count elements. | |
| void | resize_fill (const label len, const Type &val) |
| Adjust allocated size of list and set val for all elements. | |
| void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. | |
| void | transfer (List< Type > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| void | transfer (DynamicList< Type, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. | |
| Type & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. | |
| Type & | emplace_back (Args &&... args) |
| Construct an element at the end of the list, return reference to the new list element. | |
| void | push_back (const Type &val) |
| Append an element at the end of the list. | |
| void | push_back (Type &&val) |
| Move append an element at the end of the list. | |
| void | push_back (const UList< Type > &list) |
| Append a List to the end of this list. | |
| void | push_back (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | push_uniq (const Type &val) |
| Append an element if not already in the list. | |
| void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. | |
| void | operator= (const UList< Type > &list) |
| Assignment to UList operator. Takes linear time. | |
| void | operator= (const List< Type > &list) |
| Assignment operator. Takes linear time. | |
| void | operator= (const IndirectListBase< Type, Addr > &list) |
| Assignment from IndirectList. Takes linear time. | |
| void | operator= (const FixedList< Type, N > &list) |
| Copy assignment from FixedList. | |
| void | operator= (std::initializer_list< Type > list) |
| Assignment to an initializer list. | |
| void | operator= (const Type &val) |
| Assignment of all entries to the given value. | |
| void | operator= (Foam::zero) |
| Assignment of all entries to zero. | |
| void | operator= (List< Type > &&list) |
| Move assignment. Takes constant time. | |
| void | operator= (DynamicList< Type, SizeMin > &&list) |
| Move assignment. Takes constant time. | |
| Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. | |
| void | shallowCopy (const UList< Type > &)=delete |
| No shallowCopy permitted. | |
| bool | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. | |
| void | append (const Type &val) |
| Append an element at the end of the list. | |
| void | append (Type &&val) |
| Move append an element at the end of the list. | |
| void | append (const UList< Type > &list) |
| Append a List to the end of this list. | |
| void | append (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. | |
| label | appendUniq (const Type &val) |
| Same as push_uniq(). | |
| void | setSize (label n) |
| Alias for resize(). | |
| void | setSize (label n, const Type &val) |
| Alias for resize(). | |
| List (const Expression::ListExpression< E > &expr) | |
| Construct from value expression. | |
| void | operator= (const Expression::ListExpression< E > &expr) |
| Assign values from expression. | |
| void | resize (const label len) |
| Public Member Functions inherited from UList< Type > | |
| UList (const UList< Type > &) noexcept=default | |
| Copy construct, shallow copy. | |
| UList< Type > & | operator= (const UList< Type > &)=delete |
| No copy assignment (default: shallow copy). | |
| 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. | |
| 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. | |
| const Type & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list). | |
| const Type & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list). | |
| const Type * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. | |
| Type * | data () noexcept |
| Return pointer to the underlying array serving as data storage. | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. | |
| Type & | front () |
| Access first element of the list, position [0]. | |
| Type & | back () |
| Access last element of the list, position [size()-1]. | |
| std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. | |
| std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size). | |
| void | checkSize (const label size) const |
| Check size is within valid range [0,size]. | |
| void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,size). | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. | |
| bool | contains (const Type &val) const |
| True if the value is contained in the list. | |
| label | find (const Type &val) const |
| Find index of the first occurrence of the value. | |
| label | rfind (const Type &val, label pos=-1) const |
| Find index of the last occurrence of the value. | |
| void | moveFirst (const label i) |
| Move element to the first position. | |
| void | moveLast (const label i) |
| Move element to the last position. | |
| void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. | |
| void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. | |
| void | shallowCopy (Type *__restrict__ ptr, const label len) noexcept |
| Copy the pointer and size. | |
| void | deepCopy (const UList< Type > &list) |
| Copy elements of the given UList. Sizes must match! | |
| SubList< Type > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. | |
| Type & | operator[] (const label i) |
| Return element of UList. | |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. | |
| iterator | end () noexcept |
| Return an iterator to end traversing the UList. | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. | |
| const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. | |
| bool | empty () const noexcept |
| True if List is empty (ie, size() is zero). | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| void | swap (UList< Type > &list) noexcept |
| Swap content with another UList of the same type in constant time. | |
| bool | operator== (const UList< Type > &list) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UList< Type > &list) const |
| The opposite of the equality operation. Takes linear time. | |
| bool | operator< (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator> (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. | |
| bool | operator<= (const UList< Type > &list) const |
| Return true if !(a > b). Takes linear time. | |
| bool | operator>= (const UList< Type > &list) const |
| Return true if !(a < b). Takes linear time. | |
| Istream & | readList (Istream &is) |
| Read List contents from Istream. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. | |
| bool | all () const |
| True if all entries are 'true' or if the list is empty. | |
| bool | any () const |
| True if any entries are 'true'. | |
| bool | none () const |
| True if no entries are 'true'. | |
| bool | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. | |
| bool | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. | |
| bool | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. | |
| std::string_view | view () const |
| Return a string_view of the charList. Content is non-modifiable. | |
| Type & | first () |
| Access first element of the list, position [0]. | |
| Type & | last () |
| Access last element of the list, position [size()-1]. | |
| bool | found (const Type &val, label pos=0) const |
| Same as contains(). | |
| auto | expr () const |
| Wrap value as expression. | |
Additional Inherited Members | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| The value type the list contains. | |
| typedef Type * | pointer |
| The pointer type for non-const access to value_type items. | |
| typedef const Type * | const_pointer |
| The pointer type for const access to value_type items. | |
| typedef Type & | reference |
| The type used for storing into value_type objects. | |
| typedef const Type & | const_reference |
| The type used for reading from constant value_type objects. | |
| typedef Type * | iterator |
| Random access iterator for traversing a UList. | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing a UList. | |
| typedef label | size_type |
| The type to represent the size of a UList. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access). | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access). | |
| using | is_List |
| Have unique tag. | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () noexcept |
| Return a null List (reference to a nullObject). Behaves like an empty List. | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () noexcept |
| Return a null UList (reference to a nullObject). Behaves like an empty UList. | |
| static constexpr label | max_size () noexcept |
| The size of the largest possible UList. | |
| Protected Member Functions inherited from UList< Type > | |
| void | setAddressableSize (const label n) noexcept |
| Set addressed size to be inconsistent with allocated storage. | |
| void | size (const label n) |
| Older name for setAddressableSize. | |
| void | writeEntry (Ostream &os) const |
| Write the UList with its compound type. | |
| 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. | |
| void | fill_uniform (const Type &val) |
| Assign all entries to the given value. | |
Implementation of PSRS parallel sorting routine.
From "On the Versatility of Parallel Sorting by Regular Sampling" Xiaobo Li et. all.
Construct from list of things to sort (uses SortableList, 'thing' should implement >, ==).
Will contain sorted data and in
Can also be constructed from size, filled at ease and then sort()'ed.
Definition at line 67 of file ParSortableList.H.
| ParSortableList | ( | const UList< Type > & | values | ) |
Construct from List, sorting the elements.
Definition at line 121 of file ParSortableList.C.
References sort().
| ParSortableList | ( | const label | size | ) |
Construct given size. Sort later on.
Definition at line 132 of file ParSortableList.C.
References UList< Type >::size().
| void sort | ( | ) |
(stable) sort the list (if changed after construction time)
Definition at line 143 of file ParSortableList.C.
References UPstream::allProcs(), UPstream::broadcast, UPstream::buffered, Foam::ListListOps::combine(), Foam::endl(), forAll, UPstream::gatherList, SortableList< T >::indices(), UPstream::master(), UPstream::myProcNo(), n, UPstream::nProcs(), UList< Type >::operator[](), Foam::Pout, Foam::reduce(), List< T >::setSize(), setSize(), UList< T >::size(), UList< Type >::size(), Foam::sort(), and write().
Referenced by ParSortableList().
|
inline |
Return the list of sorted point indices.
Definition at line 212 of file ParSortableList.H.
|
inline |
Return the list of processor number.
Definition at line 220 of file ParSortableList.H.
1.16.1 