any_of

Header: <Kokkos_StdAlgorithms.hpp>

Description

Returns true if at least one element in a range or rank-1 View satisfies a target unary predicate.

Interface

Warning

This is currently inside the Kokkos::Experimental namespace.

Overload set accepting execution space

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);

Overload set accepting a team handle

New in version 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);

Parameters and Requirements

• exespace: execution space instance

• teamHandle: team handle instance given inside a parallel region when using a TeamPolicy

• label: 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

• view:

  • must be rank-1, and have LayoutLeft, LayoutRight, or LayoutStride

  • must be accessible from exespace or from the execution space associated with the team handle

• pred: unary functor returning true 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 argument v of type value_type, where value_type is the value type of IteratorType or view and must not modify v.

  • must conform to:

  struct CustomPredicate
  {
    KOKKOS_INLINE_FUNCTION
    bool operator()(const value_type & v) const {
      return /* true if v satisfies your desired condition */;
    }
  };
  

Return Value

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.