BAnd

Specific implementation of ReducerConcept performing bitwise AND operation

Header File: <Kokkos_Core.hpp>

Usage

T result;
parallel_reduce(N,Functor,BAnd<T,S>(result));

Synopsis

template<class Scalar, class Space>
class BAnd{
    public:
        typedef BAnd reducer;
        typedef typename std::remove_cv<Scalar>::type value_type;
        typedef Kokkos::View<value_type, Space> result_view_type;

        KOKKOS_INLINE_FUNCTION
        void join(value_type& dest, const value_type& src) const;

        KOKKOS_INLINE_FUNCTION
        void init(value_type& val) const;

        KOKKOS_INLINE_FUNCTION
        value_type& reference() const;

        KOKKOS_INLINE_FUNCTION
        result_view_type view() const;

        KOKKOS_INLINE_FUNCTION
        BAnd(value_type& value_);

        KOKKOS_INLINE_FUNCTION
        BAnd(const result_view_type& value_);
};

Interface

template<class Scalar, class Space>
class BAnd

Public Types

reducer

The self type

value_type

The reduction scalar type.

result_view_type

A Kokkos::View referencing the reduction result

Constructors

KOKKOS_INLINE_FUNCTION BAnd(value_type &value_);

Constructs a reducer which references a local variable as its result location.

KOKKOS_INLINE_FUNCTION BAnd(const result_view_type &value_);

Constructs a reducer which references a specific view as its result location.

Public Member Functions

KOKKOS_INLINE_FUNCTION void join(value_type &dest, const value_type &src) const;

Store bitwise and of src and dest into dest: dest = src & dest;.

KOKKOS_INLINE_FUNCTION void init(value_type &val) const;

Initialize val using the Kokkos::reduction_identity<Scalar>::land() method. The default implementation sets val=~(0).

KOKKOS_INLINE_FUNCTION value_type &reference() const;

Returns a reference to the result provided in class constructor.

KOKKOS_INLINE_FUNCTION result_view_type view() const;

Returns a view of the result place provided in class constructor.

Additional Information

• BAnd<T,S>::value_type is non-const T

• BAnd<T,S>::result_view_type is Kokkos::View<T,S,Kokkos::MemoryTraits<Kokkos::Unmanaged>>. Note that the S (memory space) must be the same as the space where the result resides.

• Requires: Scalar has operator = and operator & defined. Kokkos::reduction_identity<Scalar>::band() is a valid expression.

• In order to use BAnd with a custom type, a template specialization of Kokkos::reduction_identity<CustomType> must be defined. See Built-In Reducers with Custom Scalar Types for details