HPX - High Performance ParalleX

PrevUpHomeNext

Function template all_of

hpx::parallel::v1::all_of

Synopsis

// In header: <hpx/parallel/detail/all_any_none.hpp>


template<typename ExPolicy, typename InIter, typename F> 
  unspecified all_of(ExPolicy && policy, InIter first, InIter last, F && f);

Description

Checks if unary predicate f returns true for all elements in the range [first, last).

[Note] Note

Complexity: At most last - first applications of the predicate f

The application of function objects in parallel algorithm invoked with an execution policy object of type sequential_execution_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_execution_policy or task_execution_policy are permitted to execute in an unordered fashion in unspecified threads, and indeterminately sequenced within each thread.

Parameters:

f

Specifies the function (or function object) which will be invoked for each of the elements in the sequence specified by [first, last). The signature of this predicate should be equivalent to:

bool pred(const Type &a);


The signature does not need to have const&, but the function must not modify the objects passed to it. The type Type must be such that an object of type InIter can be dereferenced and then implicitly converted to Type.

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.

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 applies user-provided function objects.

F

The type of the function/function object to use (deduced). Unlike its sequential form, the parallel overload of all_of requires F to meet the requirements of CopyConstructible.

InIter

The type of the source iterators used (deduced). This iterator type must meet the requirements of an input iterator.

Returns:

The all_of algorithm returns a hpx::future<bool> if the execution policy is of type task_execution_policy and returns bool otherwise. The all_of algorithm returns true if the unary predicate f returns true for all elements in the range, false otherwise. It returns true if the range is empty.


PrevUpHomeNext