Kokkos Core Kernels Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Types | Public Member Functions | List of all members
Kokkos::RangePolicy< Properties > Class Template Reference

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

#include <Kokkos_ExecPolicy.hpp>

Inherits PolicyTraits< Properties...>.

Classes

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

Public Types

typedef RangePolicy execution_policy
 Tag this class as an execution policy. More...
 

Public Member Functions

 RangePolicy (const typename traits::execution_space &work_space, const member_type work_begin, const member_type work_end)
 Total range. More...
 
 RangePolicy (const member_type work_begin, const member_type work_end)
 Total range. More...
 
template<class... Args>
 RangePolicy (const typename traits::execution_space &work_space, const member_type work_begin, const member_type work_end, Args...args)
 Total range. More...
 
template<class... Args>
 RangePolicy (const member_type work_begin, const member_type work_end, Args...args)
 Total range. More...
 
member_type chunk_size () const
 return chunk_size More...
 
RangePolicy set_chunk_size (int chunk_size_) const
 set chunk_size to a discrete value More...
 

Detailed Description

template<class... Properties>
class Kokkos::RangePolicy< Properties >

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 94 of file Kokkos_ExecPolicy.hpp.

Member Typedef Documentation

template<class... Properties>
typedef RangePolicy Kokkos::RangePolicy< Properties >::execution_policy

Tag this class as an execution policy.

Definition at line 110 of file Kokkos_ExecPolicy.hpp.

Constructor & Destructor Documentation

template<class... Properties>
Kokkos::RangePolicy< Properties >::RangePolicy ( const typename traits::execution_space &  work_space,
const member_type  work_begin,
const member_type  work_end 
)
inline

Total range.

Definition at line 142 of file Kokkos_ExecPolicy.hpp.

template<class... Properties>
Kokkos::RangePolicy< Properties >::RangePolicy ( const member_type  work_begin,
const member_type  work_end 
)
inline

Total range.

Definition at line 153 of file Kokkos_ExecPolicy.hpp.

template<class... Properties>
template<class... Args>
Kokkos::RangePolicy< Properties >::RangePolicy ( const typename traits::execution_space &  work_space,
const member_type  work_begin,
const member_type  work_end,
Args...  args 
)
inline

Total range.

Definition at line 160 of file Kokkos_ExecPolicy.hpp.

template<class... Properties>
template<class... Args>
Kokkos::RangePolicy< Properties >::RangePolicy ( const member_type  work_begin,
const member_type  work_end,
Args...  args 
)
inline

Total range.

Definition at line 174 of file Kokkos_ExecPolicy.hpp.

Member Function Documentation

template<class... Properties>
member_type Kokkos::RangePolicy< Properties >::chunk_size ( ) const
inline

return chunk_size

Definition at line 201 of file Kokkos_ExecPolicy.hpp.

template<class... Properties>
RangePolicy Kokkos::RangePolicy< Properties >::set_chunk_size ( int  chunk_size_) const
inline

set chunk_size to a discrete value

Definition at line 204 of file Kokkos_ExecPolicy.hpp.


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