DPC++ Runtime
Runtime libraries for oneAPI Data Parallel C++
cl::sycl::id< dimensions > Class Template Reference

A unique identifier of an item in an index space. More...

#include <CL/sycl/detail/array.hpp>

Public Member Functions

 id ()=default
 
template<int N = dimensions>
 id (ParamTy< N, 1, size_t > dim0)
 
template<int N = dimensions>
 id (ParamTy< N, 1, const range< dimensions >> &range_size)
 
template<int N = dimensions, bool with_offset = true>
 id (ParamTy< N, 1, const item< dimensions, with_offset >> &item)
 
template<int N = dimensions>
 id (ParamTy< N, 2, size_t > dim0, size_t dim1)
 
template<int N = dimensions>
 id (ParamTy< N, 2, const range< dimensions >> &range_size)
 
template<int N = dimensions, bool with_offset = true>
 id (ParamTy< N, 2, const item< dimensions, with_offset >> &item)
 
template<int N = dimensions>
 id (ParamTy< N, 3, size_t > dim0, size_t dim1, size_t dim2)
 
template<int N = dimensions>
 id (ParamTy< N, 3, const range< dimensions >> &range_size)
 
template<int N = dimensions, bool with_offset = true>
 id (ParamTy< N, 3, const item< dimensions, with_offset >> &item)
 
 operator range< dimensions > () const
 
__SYCL_ALWAYS_INLINE operator EnableIfT< (dimensions==1)
 
__SYCL_ALWAYS_INLINE size_t () const
 

Friends

template<typename , int , typename >
class detail::RoundedRangeKernel
 
template<typename , int , typename >
class detail::RoundedRangeKernelWithKH
 

Detailed Description

template<int dimensions = 1>
class cl::sycl::id< dimensions >

A unique identifier of an item in an index space.

Definition at line 17 of file array.hpp.

Constructor & Destructor Documentation

◆ id() [1/10]

template<int dimensions = 1>
cl::sycl::id< dimensions >::id ( )
default

◆ id() [2/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 1, size_t dim0)
inline

Definition at line 58 of file id.hpp.

◆ id() [3/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 1, const range< dimensions >> &  range_size)
inline

Definition at line 61 of file id.hpp.

◆ id() [4/10]

template<int dimensions = 1>
template<int N = dimensions, bool with_offset = true>
cl::sycl::id< dimensions >::id ( ParamTy< N, 1, const item< dimensions, with_offset >> &  item)
inline

Definition at line 65 of file id.hpp.

◆ id() [5/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 2, size_t dim0,
size_t  dim1 
)
inline

Definition at line 71 of file id.hpp.

◆ id() [6/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 2, const range< dimensions >> &  range_size)
inline

Definition at line 74 of file id.hpp.

◆ id() [7/10]

template<int dimensions = 1>
template<int N = dimensions, bool with_offset = true>
cl::sycl::id< dimensions >::id ( ParamTy< N, 2, const item< dimensions, with_offset >> &  item)
inline

Definition at line 78 of file id.hpp.

◆ id() [8/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 3, size_t dim0,
size_t  dim1,
size_t  dim2 
)
inline

Definition at line 84 of file id.hpp.

◆ id() [9/10]

template<int dimensions = 1>
template<int N = dimensions>
cl::sycl::id< dimensions >::id ( ParamTy< N, 3, const range< dimensions >> &  range_size)
inline

Definition at line 88 of file id.hpp.

◆ id() [10/10]

template<int dimensions = 1>
template<int N = dimensions, bool with_offset = true>
cl::sycl::id< dimensions >::id ( ParamTy< N, 3, const item< dimensions, with_offset >> &  item)
inline

Definition at line 92 of file id.hpp.

Member Function Documentation

◆ operator EnableIfT<()

template<int dimensions = 1>
__SYCL_ALWAYS_INLINE cl::sycl::id< dimensions >::operator EnableIfT< ( dimensions  = = 1)

◆ operator range< dimensions >()

template<int dimensions = 1>
cl::sycl::id< dimensions >::operator range< dimensions > ( ) const
inlineexplicit

Definition at line 96 of file id.hpp.

◆ size_t()

template<int dimensions = 1>
__SYCL_ALWAYS_INLINE cl::sycl::id< dimensions >::size_t ( ) const
inline

Definition at line 111 of file id.hpp.

Friends And Related Function Documentation

◆ detail::RoundedRangeKernel

template<int dimensions = 1>
template<typename , int , typename >
friend class detail::RoundedRangeKernel
friend

Definition at line 302 of file id.hpp.

◆ detail::RoundedRangeKernelWithKH

template<int dimensions = 1>
template<typename , int , typename >
friend class detail::RoundedRangeKernelWithKH
friend

Definition at line 304 of file id.hpp.


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