Kokkos Core Kernels Package  Version of the Day
Classes | Public Types | Public Member Functions | List of all members
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>

Classes

struct  WorkRange
 Subrange for a partition's rank and size. More...
 

Public Types

typedef ExecSpace execution_space
 Tag this class as an execution policy. More...
 

Public Member Functions

 RangePolicy (const member_type work_begin, const member_type work_end)
 Total range. More...
 
 RangePolicy (const execution_space &work_space, const member_type work_begin, const member_type work_end)
 Total range. More...
 

Detailed Description

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename std::conditional < 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 85 of file Kokkos_ExecPolicy.hpp.

Member Typedef Documentation

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

Tag this class as an execution policy.

Definition at line 155 of file Kokkos_ExecPolicy.hpp.

Constructor & Destructor Documentation

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

Total range.

Definition at line 168 of file Kokkos_ExecPolicy.hpp.

template<class Arg0 = void, class Arg1 = void, class Arg2 = void, class ExecSpace = typename std::conditional < Impl::is_execution_space< Arg0 >::value , Arg0 , Kokkos::DefaultExecutionSpace >::type>
Kokkos::RangePolicy< Arg0, Arg1, Arg2, ExecSpace >::RangePolicy ( const execution_space work_space,
const member_type  work_begin,
const member_type  work_end 
)
inline

Total range.

Definition at line 178 of file Kokkos_ExecPolicy.hpp.


The documentation for this class was generated from the following file: