DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::id< dimensions > Class Template Reference

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

#include <sycl/id.hpp>

Inheritance diagram for sycl::_V1::id< dimensions >:
Collaboration diagram for sycl::_V1::id< dimensions >:

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
 
bool operator== (const id< dimensions > &rhs) const
 
- Public Member Functions inherited from sycl::_V1::detail::array< 1 >
 array (typename std::enable_if_t<(N==1), size_t > dim0=0)
 
 array (typename std::enable_if_t<(N==2), size_t > dim0, size_t dim1)
 
 array ()
 
 array (typename std::enable_if_t<(N==3), size_t > dim0, size_t dim1, size_t dim2)
 
 array ()
 
 array (const array< dimensions > &rhs)=default
 
 array (array< dimensions > &&rhs)=default
 
 operator sycl::id< dimensions > () const
 
 operator sycl::range< dimensions > () const
 
size_t get (int dimension) const
 
size_t & operator[] (int dimension)
 
size_t operator[] (int dimension) const
 
array< dimensions > & operator= (const array< dimensions > &rhs)=default
 
array< dimensions > & operator= (array< dimensions > &&rhs)=default
 
bool operator== (const array< dimensions > &rhs) const
 
bool operator!= (const array< dimensions > &rhs) const
 

Friends

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

Additional Inherited Members

- Protected Member Functions inherited from sycl::_V1::detail::array< 1 >
__SYCL_ALWAYS_INLINE void check_dimension (int dimension) const
 
- Protected Attributes inherited from sycl::_V1::detail::array< 1 >
size_t common_array [dimensions]
 

Detailed Description

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

A unique identifier of an item in an index space.

Definition at line 32 of file id.hpp.

Constructor & Destructor Documentation

◆ id() [1/10]

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

◆ id() [2/10]

template<int dimensions = 1>
template<int N = dimensions>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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>
sycl::_V1::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 sycl::_V1::id< dimensions >::operator EnableIfT< ( dimensions  = = 1)

References __SYCL_ASSUME_INT.

◆ operator range< dimensions >()

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

Definition at line 96 of file id.hpp.

References std::get().

◆ operator==()

template<int dimensions = 1>
bool sycl::_V1::id< dimensions >::operator== ( const id< dimensions > &  rhs) const
inline

Definition at line 123 of file id.hpp.

References operator==().

◆ size_t()

template<int dimensions = 1>
__SYCL_ALWAYS_INLINE sycl::_V1::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 307 of file id.hpp.

◆ detail::RoundedRangeKernelWithKH

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

Definition at line 309 of file id.hpp.


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