hpx/parallel/container_algorithms/iota.hpp

Defined in header hpx/parallel/container_algorithms/iota.hpp.

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

namespace hpx

namespace ranges

Functions

template<typename FwdIter, typename Sent, typename T>
iota_result<FwdIter, T> iota(FwdIter first, Sent last, T value)

Fills the range [first, last) with sequentially increasing values, starting with value and repetitively evaluating ++value.

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

Note

Complexity: Exactly std::distance(first, last) assignments and increments.

Template Parameters:

• FwdIter – The type of the source iterators used (deduced). This iterator type must meet the requirements of an input or output iterator.

• Sent – The type of the source sentinel (deduced). This sentinel type must be a sentinel for FwdIter.

• T – The type of the target value. This type must meet the requirements of weakly incrementable.

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.

• value – The value to be stored in the first element.

Returns:

The iota algorithm returns a hpx::ranges::iota_result containing the final iterator and the final value.

template<typename ExPolicy, typename FwdIter, typename Sent, typename T>
hpx::parallel::util::detail::algorithm_result_t<ExPolicy, iota_result<FwdIter, T>> iota(ExPolicy &&policy, FwdIter first, Sent last, T value)

Fills the range [first, last) with sequentially increasing values, starting with value and repetitively evaluating ++value.

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

The assignments in the parallel iota 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: Exactly std::distance(first, last) assignments and increments.

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 assignments.

• FwdIter – The type of the source iterators used (deduced). This iterator type must meet the requirements of a forward iterator.

• Sent – The type of the source sentinel (deduced). This sentinel type must be a sentinel for FwdIter.

• T – The type of the target value. This type must meet the requirements of weakly incrementable.

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.

• value – The value to be stored in the first element.

Returns:

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

template<typename Range, typename T>
iota_result<typename hpx::traits::range_traits<Range>::iterator_type, T> iota(Range &&r, T value)

Fills the range r with sequentially increasing values, starting with value and repetitively evaluating ++value.

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

Note

Complexity: Exactly std::ranges::distance(r) assignments and increments.

Template Parameters:

• Range – The type of the source range used (deduced). The iterators extracted from this range type must meet the requirements of an input or output iterator

• T – The type of the target value. This type must meet the requirements of weakly incrementable.

Parameters:

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

• value – The value to be stored in the first element.

Returns:

The iota algorithm returns a hpx::ranges::iota_result containing the final iterator and the final value.

template<typename ExPolicy, typename Range, typename T>
hpx::parallel::util::detail::algorithm_result_t<ExPolicy, iota_result<typename hpx::traits::range_traits<Range>::iterator_type, T>> iota(ExPolicy &&policy, Range &&r, T value)

Fills the range r with sequentially increasing values, starting with value and repetitively evaluating ++value.

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

The assignments in the parallel iota 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: Exactly std::ranges::distance(r) assignments and increments.

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 assignments.

• Range – The type of the source range used (deduced). The iterators extracted from this range type must meet the requirements of a forward iterator.

• T – The type of the target value. This type must meet the requirements of weakly incrementable.

Parameters:

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

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

• value – The value to be stored in the first element.

Returns:

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