HPX - High Performance ParalleX

PrevUpHomeNext

Function template replace

hpx::parallel::v1::replace

Synopsis

// In header: <hpx/parallel/algorithms/replace.hpp>


template<typename ExPolicy, typename FwdIter, typename T> 
  unspecified replace(ExPolicy && policy, FwdIter first, FwdIter last, 
                      T const & old_value, T const & new_value);

Description

Replaces all elements satisfying specific criteria with new_value in the range [first, last).

[Note] Note

Complexity: Performs exactly last - first assignments.

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

The assignments in the parallel replace algorithm invoked with an execution policy object of type parallel_execution_policy or parallel_task_execution_policy are permitted to execute in an unordered fashion in unspecified threads, and indeterminately sequenced within each thread.

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.

new_value

Refers to the new value to use as the replacement.

old_value

Refers to the old value of the elements to replace.

policy

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

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.

T

The type of the old and new values to replace (deduced).

Returns:

The replace algorithm returns a hpx::future<void> if the execution policy is of type sequential_task_execution_policy or parallel_task_execution_policy and returns void otherwise.


PrevUpHomeNext