DPC++ Runtime
Runtime libraries for oneAPI DPC++
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
sycl::_V1::ext::oneapi::experimental::root_group< Dimensions > Class Template Reference

#include <sycl/ext/oneapi/experimental/root_group.hpp>

Collaboration diagram for sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >:
Collaboration graph
[legend]

Public Types

using id_type = id< Dimensions >
 
using range_type = range< Dimensions >
 
using linear_id_type = size_t
 

Public Member Functions

id< Dimensions > get_group_id () const
 
id< Dimensions > get_local_id () const
 
range< Dimensions > get_group_range () const
 
range< Dimensions > get_local_range () const
 
range< Dimensions > get_max_local_range () const
 
size_t get_group_linear_id () const
 
size_t get_local_linear_id () const
 
size_t get_group_linear_range () const
 
size_t get_local_linear_range () const
 
bool leader () const
 

Static Public Attributes

static constexpr int dimensions = Dimensions
 
static constexpr memory_scope fence_scope = memory_scope::device
 

Friends

root_group< Dimensions > nd_item () const
 

Detailed Description

template<int Dimensions>
class sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >

Definition at line 30 of file root_group.hpp.

Member Typedef Documentation

◆ id_type

template<int Dimensions>
using sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::id_type = id<Dimensions>

Definition at line 32 of file root_group.hpp.

◆ linear_id_type

template<int Dimensions>
using sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::linear_id_type = size_t

Definition at line 34 of file root_group.hpp.

◆ range_type

template<int Dimensions>
using sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::range_type = range<Dimensions>

Definition at line 33 of file root_group.hpp.

Member Function Documentation

◆ get_group_id()

template<int Dimensions>
id<Dimensions> sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_id ( ) const
inline

Definition at line 38 of file root_group.hpp.

◆ get_group_linear_id()

template<int Dimensions>
size_t sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_linear_id ( ) const
inline

Definition at line 56 of file root_group.hpp.

◆ get_group_linear_range()

template<int Dimensions>
size_t sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_linear_range ( ) const
inline

Definition at line 60 of file root_group.hpp.

References sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_range(), and sycl::_V1::range< Dimensions >::size().

◆ get_group_range()

template<int Dimensions>
range<Dimensions> sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_range ( ) const
inline

Definition at line 42 of file root_group.hpp.

References sycl::_V1::Dimensions.

Referenced by sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_group_linear_range().

◆ get_local_id()

template<int Dimensions>
id<Dimensions> sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_id ( ) const
inline

Definition at line 40 of file root_group.hpp.

Referenced by sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::leader().

◆ get_local_linear_id()

template<int Dimensions>
size_t sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_linear_id ( ) const
inline

Definition at line 58 of file root_group.hpp.

◆ get_local_linear_range()

template<int Dimensions>
size_t sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_linear_range ( ) const
inline

Definition at line 62 of file root_group.hpp.

References sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_range(), and sycl::_V1::range< Dimensions >::size().

◆ get_local_range()

template<int Dimensions>
range<Dimensions> sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_range ( ) const
inline

Definition at line 52 of file root_group.hpp.

Referenced by sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_linear_range(), and sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_max_local_range().

◆ get_max_local_range()

template<int Dimensions>
range<Dimensions> sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_max_local_range ( ) const
inline

Definition at line 54 of file root_group.hpp.

References sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_range().

◆ leader()

template<int Dimensions>
bool sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::leader ( ) const
inline

Definition at line 64 of file root_group.hpp.

References sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::get_local_id().

Friends And Related Function Documentation

◆ nd_item

template<int Dimensions>
root_group<Dimensions> nd_item ( ) const
friend

Member Data Documentation

◆ dimensions

template<int Dimensions>
constexpr int sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::dimensions = Dimensions
staticconstexpr

Definition at line 35 of file root_group.hpp.

◆ fence_scope

template<int Dimensions>
constexpr memory_scope sycl::_V1::ext::oneapi::experimental::root_group< Dimensions >::fence_scope = memory_scope::device
staticconstexpr

Definition at line 36 of file root_group.hpp.

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