swap_ranges.hpp#

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

namespace hpx

Functions

template<typename FwdIter1, typename FwdIter2> FwdIter2 swap_ranges(FwdIter1 first1, FwdIter1 last1, FwdIter2 first2)#

Exchanges elements between range [first1, last1) and another range starting at first2.

The swap operations in the parallel swap_ranges algorithm invoked without an execution policy object execute in sequential order in the calling thread.

Note

Complexity: Linear in the distance between first1 and last1

Template Parameters

FwdIter1 – The type of the first range of iterators to swap (deduced). This iterator type must meet the requirements of an forward iterator.
FwdIter2 – The type of the second range of iterators to swap (deduced). This iterator type must meet the requirements of an forward iterator.

Parameters

first1 – Refers to the beginning of the first sequence of elements the algorithm will be applied to.
last1 – Refers to the end of the first sequence of elements the algorithm will be applied to.
first2 – Refers to the beginning of the second sequence of elements the algorithm will be applied to.

Returns

The swap_ranges algorithm returns FwdIter2. The swap_ranges algorithm returns iterator to the element past the last element exchanged in the range beginning with first2.

template<typename ExPolicy, typename FwdIter1, typename FwdIter2> parallel::util::detail::algorithm_result<ExPolicy, FwdIter2>::type swap_ranges(ExPolicy &&policy, FwdIter1 first1, FwdIter1 last1, FwdIter2 first2)#

Exchanges elements between range [first1, last1) and another range starting at first2.

The swap operations in the parallel swap_ranges algorithm invoked with an execution policy object of type sequenced_policy execute in sequential order in the calling thread.

The swap operations in the parallel swap_ranges 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: Linear in the distance between first1 and last1

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 executes the swap operations.
FwdIter1 – The type of the first range of iterators to swap (deduced). This iterator type must meet the requirements of an forward iterator.
FwdIter2 – The type of the second range of iterators to swap (deduced). This iterator type must meet the requirements of an forward iterator.

Parameters

policy – The execution policy to use for the scheduling of the iterations.
first1 – Refers to the beginning of the first sequence of elements the algorithm will be applied to.
last1 – Refers to the end of the first sequence of elements the algorithm will be applied to.
first2 – Refers to the beginning of the second sequence of elements the algorithm will be applied to.

Returns

The swap_ranges algorithm returns a hpx::future<FwdIter2> if the execution policy is of type parallel_task_policy and returns FwdIter2 otherwise. The swap_ranges algorithm returns iterator to the element past the last element exchanged in the range beginning with first2.