kamping::plugin::SampleSort< Comm, DefaultContainerType > Class Template Reference

Plugin that adds a canonical sample sort to the communicator. More...

#include <sort.hpp>

Inheritance diagram for kamping::plugin::SampleSort< Comm, DefaultContainerType >:

Collaboration diagram for kamping::plugin::SampleSort< Comm, DefaultContainerType >:

Public Member Functions
template<typename T , typename Allocator , typename Compare = std::less<T>>
void	sort (std::vector< T, Allocator > &data, Compare comp=Compare{})
	Sort the vector based on a binary comparison function (std::less by default).
template<typename RandomIt , typename OutputIt , typename Compare = std::less<typename std::iterator_traits<RandomIt>::value_type>>
void	sort (RandomIt begin, RandomIt end, OutputIt out, Compare comp=Compare{})
	Sort the elements in [begin, end) using a binary comparison function (std::less by default).

Detailed Description

template<typename Comm, template< typename... > typename DefaultContainerType>
class kamping::plugin::SampleSort< Comm, DefaultContainerType >

Plugin that adds a canonical sample sort to the communicator.

Template Parameters

Type	of the communicator that is extended by the plugin.
DefaultContainerType	Default container type of the original communicator.

Member Function Documentation

sort() [1/2]

template<typename Comm , template< typename... > typename DefaultContainerType>

template<typename RandomIt , typename OutputIt , typename Compare = std::less<typename std::iterator_traits<RandomIt>::value_type>>

void kamping::plugin::SampleSort< Comm, DefaultContainerType >::sort ( RandomIt begin, RandomIt end, OutputIt out, Compare comp = Compare{} )

inline

Sort the elements in [begin, end) using a binary comparison function (std::less by default).

The order of equal elements in not guaranteed to be preserved. The binary comparison function has to be true if the first argument is less than the second.

Template Parameters

RandomIt	Iterator type of the container containing the elements that are sorted.
OutputIt	Iterator type of the output iterator.
Compare	Type of the binary comparison function (std::less<> by default).

Parameters

begin	Start of the range of elements to sort.
end	Element after the last element to be sorted.
out	Output iterator used to output the sorted elements.
comp	Binary comparison function used to determine the order of elements.

sort() [2/2]

template<typename Comm , template< typename... > typename DefaultContainerType>

template<typename T , typename Allocator , typename Compare = std::less<T>>

void kamping::plugin::SampleSort< Comm, DefaultContainerType >::sort ( std::vector< T, Allocator > & data, Compare comp = Compare{} )

inline

Sort the vector based on a binary comparison function (std::less by default).

The order of equal elements is not guaranteed to be preserved. The binary comparison function has to be true if the first argument is less than the second.

Template Parameters

T	Type of elements to be sorted.
Allocator	Allocator of the vector.
Compare	Type of the binary comparison function (std::less<T> by default).

Parameters

data	Vector containing the data to be sorted.
comp	Binary comparison function used to determine the order of elements.

---

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

• include/kamping/plugin/sort.hpp