Kokkos Core Kernels Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends
Public Types | Public Member Functions
Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace > Class Template Reference

Execution policy for work over a range of an integral type. More...

#include <Kokkos_ExecPolicy.hpp>

List of all members.

Public Types

typedef Impl::ExecutionPolicyTag kokkos_tag
 Concept tag.

Public Member Functions

KOKKOS_INLINE_FUNCTION RangePolicy (const member_type work_begin, const member_type work_end)
 Total range.
KOKKOS_INLINE_FUNCTION RangePolicy (const RangePolicy &range, const int part_rank, const int part_size)
 Subrange for a partition's rank and size.

Detailed Description

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename Impl::if_c< Impl::is_execution_space< Arg0 >::value , Arg0 , Kokkos::DefaultExecutionSpace >::type>
class Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace >

Execution policy for work over a range of an integral type.

Valid template argument options:

With a specified execution space: < ExecSpace , WorkTag , { IntConst | IntType } > < ExecSpace , WorkTag , void > < ExecSpace , { IntConst | IntType } , void > < ExecSpace , void , void >

With the default execution space: < WorkTag , { IntConst | IntType } , void > < WorkTag , void , void > < { IntConst | IntType } , void , void > < void , void , void >

IntType is a fundamental integral type IntConst is an Impl::integral_constant< IntType , Blocking >

Blocking is the granularity of partitioning the range among threads.

Definition at line 84 of file Kokkos_ExecPolicy.hpp.


Member Typedef Documentation

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename Impl::if_c< Impl::is_execution_space< Arg0 >::value , Arg0 , Kokkos::DefaultExecutionSpace >::type>
typedef Impl::ExecutionPolicyTag Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace >::kokkos_tag

Concept tag.

Definition at line 151 of file Kokkos_ExecPolicy.hpp.


Constructor & Destructor Documentation

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename Impl::if_c< Impl::is_execution_space< Arg0 >::value , Arg0 , Kokkos::DefaultExecutionSpace >::type>
KOKKOS_INLINE_FUNCTION Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace >::RangePolicy ( const member_type  work_begin,
const member_type  work_end 
) [inline]

Total range.

Definition at line 164 of file Kokkos_ExecPolicy.hpp.

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename Impl::if_c< Impl::is_execution_space< Arg0 >::value , Arg0 , Kokkos::DefaultExecutionSpace >::type>
KOKKOS_INLINE_FUNCTION Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace >::RangePolicy ( const RangePolicy< Arg0, Arg1, Arg2, ExecSpace > &  range,
const int  part_rank,
const int  part_size 
) [inline]

Subrange for a partition's rank and size.

Typically used to partition a range over a group of threads.

Definition at line 176 of file Kokkos_ExecPolicy.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends