hpx::remove

Defined in header hpx/algorithm.hpp.

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

See also:

• hpx::remove_if

template<typename FwdIter, typename T = typename std::iterator_traits<FwdIter>::value_type>
FwdIter hpx::remove(FwdIter first, FwdIter last, T const &value)

Removes all elements satisfying specific criteria from the range [first, last) and returns a past-the-end iterator for the new end of the range. This version removes all elements that are equal to value.

The assignments in the parallel remove algorithm execute in sequential order in the calling thread.

Note

Complexity: Performs not more than last - first assignments, exactly last - first applications of the operator==().

Template Parameters:

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

• T – The type of the value to remove (deduced). This value type must meet the requirements of CopyConstructible.

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 – Specifies the value of elements to remove.

Returns:

The remove algorithm returns a FwdIter. The remove algorithm returns the iterator to the new end of the range.

template<typename ExPolicy, typename FwdIter, typename T = typename std::iterator_traits<FwdIter>::value_type>
hpx::parallel::util::detail::algorithm_result_t<ExPolicy, FwdIter> hpx::remove(ExPolicy &&policy, FwdIter first, FwdIter last, T const &value)

Removes all elements satisfying specific criteria from the range [first, last) and returns a past-the-end iterator for the new end of the range. This version removes all elements that are equal to value. Executed according to the policy.

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

The assignments in the parallel remove 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: Performs not more than last - first assignments, exactly last - first applications of the operator==().

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 an forward iterator.

• T – The type of the value to remove (deduced). This value type must meet the requirements of CopyConstructible.

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 – Specifies the value of elements to remove.

Returns:

The remove algorithm returns a hpx::future<FwdIter> if the execution policy is of type sequenced_task_policy or parallel_task_policy and returns FwdIter otherwise. The remove algorithm returns the iterator to the new end of the range.