# hpx/parallel/algorithms/stable_sort.hpp#

See Public API for a list of names and headers that are part of the public HPX API.

namespace hpx

Functions

template<typename RandomIt>
void stable_sort(RandomIt first, RandomIt last)#

Sorts the elements in the range [first, last) in ascending order. The relative order of equal elements is preserved. The function uses the given comparison function object comp (defaults to using operator<()).

A sequence is sorted with respect to a comparator comp and a projection proj if for every iterator i pointing to the sequence and every non-negative integer n such that i + n is a valid iterator pointing to an element of the sequence, and INVOKE(comp, INVOKE(proj, *(i + n)), INVOKE(proj, *i)) == false.

The assignments in the parallel stable_sort algorithm invoked without an execution policy object execute in sequential order in the calling thread.

Note

Complexity: O(Nlog(N)), where N = std::distance(first, last) comparisons.

Template Parameters

RandomIt – The type of the source iterators used (deduced). This iterator type must meet the requirements of a random access iterator.

Parameters
• first – Refers to the beginning of the sequence of elements the algorithm will be applied to.

• last – Refers to the end of the sequence of elements the algorithm will be applied to.

Returns

The stable_sort algorithm does not return anything.

template<typename ExPolicy, typename RandomIt>
util::detail::algorithm_result<ExPolicy>::type stable_sort(ExPolicy &&policy, RandomIt first, RandomIt last)#

Sorts the elements in the range [first, last) in ascending order. The relative order of equal elements is preserved. The function uses the given comparison function object comp (defaults to using operator<()).

A sequence is sorted with respect to a comparator comp and a projection proj if for every iterator i pointing to the sequence and every non-negative integer n such that i + n is a valid iterator pointing to an element of the sequence, and INVOKE(comp, INVOKE(proj, *(i + n)), INVOKE(proj, *i)) == false.

The application of function objects in parallel algorithm invoked with an execution policy object of type sequenced_policy execute in sequential order in the calling thread.

The application of function objects in parallel algorithm invoked with an execution policy object of type parallel_policy or parallel_task_policy are permitted to execute in an unordered fashion in unspecified threads, and indeterminately sequenced within each thread.

Note

Complexity: O(Nlog(N)), where N = std::distance(first, last) comparisons.

Template Parameters
• ExPolicy – The type of the execution policy to use (deduced). It describes the manner in which the execution of the algorithm may be parallelized and the manner in which it applies user-provided function objects.

• RandomIt – The type of the source iterators used (deduced). This iterator type must meet the requirements of a random access iterator.

Parameters
• policy – The execution policy to use for the scheduling of the iterations.

• first – Refers to the beginning of the sequence of elements the algorithm will be applied to.

• last – Refers to the end of the sequence of elements the algorithm will be applied to.

Returns

The stable_sort algorithm returns a hpx::future<void> if the execution policy is of type sequenced_task_policy or parallel_task_policy and returns nothing otherwise.

template<typename RandomIt, typename Comp, typename Proj>
void stable_sort(RandomIt first, RandomIt last, Comp &&comp, Proj &&proj)#

Sorts the elements in the range [first, last) in ascending order. The relative order of equal elements is preserved. The function uses the given comparison function object comp (defaults to using operator<()).

A sequence is sorted with respect to a comparator comp and a projection proj if for every iterator i pointing to the sequence and every non-negative integer n such that i + n is a valid iterator pointing to an element of the sequence, and INVOKE(comp, INVOKE(proj, *(i + n)), INVOKE(proj, *i)) == false.

comp has to induce a strict weak ordering on the values.

The assignments in the parallel stable_sort algorithm invoked without an execution policy object execute in sequential order in the calling thread.

Note

Complexity: O(Nlog(N)), where N = std::distance(first, last) comparisons.

Template Parameters
• RandomIt – The type of the source iterators used (deduced). This iterator type must meet the requirements of a random access iterator.

• Comp – The type of the function/function object to use (deduced).

• Proj – The type of an optional projection function. This defaults to util::projection_identity

Parameters
• first – Refers to the beginning of the sequence of elements the algorithm will be applied to.

• last – Refers to the end of the sequence of elements the algorithm will be applied to.

• comp – comp is a callable object. The return value of the INVOKE operation applied to an object of type Comp, when contextually converted to bool, yields true if the first argument of the call is less than the second, and false otherwise. It is assumed that comp will not apply any non-constant function through the dereferenced iterator.

• proj – Specifies the function (or function object) which will be invoked for each pair of elements as a projection operation before the actual predicate comp is invoked.

Returns

The stable_sort algorithm returns nothing.

template<typename ExPolicy, typename RandomIt, typename Comp, typename Proj>
parallel::util::detail::algorithm_result<ExPolicy>::type stable_sort(ExPolicy &&policy, RandomIt first, RandomIt last, Comp &&comp, Proj &&proj)#

Sorts the elements in the range [first, last) in ascending order. The relative order of equal elements is preserved. The function uses the given comparison function object comp (defaults to using operator<()).

A sequence is sorted with respect to a comparator comp and a projection proj if for every iterator i pointing to the sequence and every non-negative integer n such that i + n is a valid iterator pointing to an element of the sequence, and INVOKE(comp, INVOKE(proj, *(i + n)), INVOKE(proj, *i)) == false.

comp has to induce a strict weak ordering on the values.

The application of function objects in parallel algorithm invoked with an execution policy object of type sequenced_policy execute in sequential order in the calling thread.

The application of function objects in parallel algorithm invoked with an execution policy object of type parallel_policy or parallel_task_policy are permitted to execute in an unordered fashion in unspecified threads, and indeterminately sequenced within each thread.

Note

Complexity: O(Nlog(N)), where N = std::distance(first, last) comparisons.

Template Parameters
• ExPolicy – The type of the execution policy to use (deduced). It describes the manner in which the execution of the algorithm may be parallelized and the manner in which it applies user-provided function objects.

• RandomIt – The type of the source iterators used (deduced). This iterator type must meet the requirements of a random access iterator.

• Comp – The type of the function/function object to use (deduced).

• Proj – The type of an optional projection function. This defaults to util::projection_identity.

Parameters
• policy – The execution policy to use for the scheduling of the iterations.

• first – Refers to the beginning of the sequence of elements the algorithm will be applied to.

• last – Refers to the end of the sequence of elements the algorithm will be applied to.

• comp – comp is a callable object. The return value of the INVOKE operation applied to an object of type Comp, when contextually converted to bool, yields true if the first argument of the call is less than the second, and false otherwise. It is assumed that comp will not apply any non-constant function through the dereferenced iterator.

• proj – Specifies the function (or function object) which will be invoked for each pair of elements as a projection operation before the actual predicate comp is invoked.

Returns

The stable_sort algorithm returns a hpx::future<void> if the execution policy is of type sequenced_task_policy or parallel_task_policy and returns nothing otherwise.