Header: <Kokkos_StdAlgorithms.hpp>
Returns true
if at least one element in a range or rank-1 View
satisfies a target unary predicate.
Warning
This is currently inside the Kokkos::Experimental
namespace.
template <class ExecutionSpace, class InputIterator, class Predicate>
bool any_of(const ExecutionSpace& exespace, (1)
InputIterator first, InputIterator last,
Predicate predicate);
template <class ExecutionSpace, class InputIterator, class Predicate>
bool any_of(const std::string& label, const ExecutionSpace& exespace, (2)
InputIterator first, InputIterator last,
Predicate predicate);
template <class ExecutionSpace, class DataType, class... Properties,
class Predicate>
bool any_of(const ExecutionSpace& exespace, (3)
const ::Kokkos::View<DataType, Properties...>& v,
Predicate predicate);
template <class ExecutionSpace, class DataType, class... Properties,
class Predicate>
bool any_of(const std::string& label, const ExecutionSpace& exespace, (4)
const ::Kokkos::View<DataType, Properties...>& v,
Predicate predicate);
4.2
template <class TeamHandleType, class InputIterator, class Predicate>
KOKKOS_FUNCTION
bool any_of(const TeamHandleType& teamHandle, (5)
InputIterator first, InputIterator last,
Predicate predicate);
template <class TeamHandleType, class DataType, class... Properties,
class Predicate>
KOKKOS_FUNCTION
bool any_of(const TeamHandleType& teamHandle, (6)
const ::Kokkos::View<DataType, Properties...>& v,
Predicate predicate);
exespace
: execution space instanceteamHandle
: team handle instance given inside a parallel region when using a TeamPolicylabel
: string forwarded to internal parallel kernels for debugging purposes- 1: The default string is "Kokkos::any_of_iterator_api_default".
- 3: The default string is "Kokkos::any_of_view_api_default".
- NOTE: overloads accepting a team handle do not use a label internally
first, last
: range of elements to search in- must be random access iterators, e.g., returned from
Kokkos::Experimental::(c)begin/(c)end
- must represent a valid range, i.e.,
last >= first
- must be accessible from
exespace
or from the execution space associated with the team handle
- must be random access iterators, e.g., returned from
view
:- must be rank-1, and have
LayoutLeft
,LayoutRight
, orLayoutStride
- must be accessible from
exespace
or from the execution space associated with the team handle
- must be rank-1, and have
pred
: unary functor returningtrue
if an argument satisfies the desired condition.pred(v)
must be valid to be called from the execution space passed, or the execution space associated with the team handle, and convertible to bool for every argumentv
of typevalue_type
, wherevalue_type
is the value type ofIteratorType
orview
and must not modifyv
.- must conform to:
struct CustomPredicate { KOKKOS_INLINE_FUNCTION bool operator()(const value_type & v) const { return /* true if v satisfies your desired condition */; } };
Returns true
if the unary predicate returns true
for at least one element in the range or view
. Returns false
if no such element is found, or if the range or view
are empty.