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)

__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

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

Static Public Attributes
static constexpr int	dimensions = Dimensions

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 36 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 65 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 68 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 72 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 78 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 81 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 85 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 91 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 95 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 99 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, and sycl::_V1::detail::array< 1 >::common_array.

◆ operator==()

template<int Dimensions = 1>

bool sycl::_V1::id< Dimensions >::operator== ( const id< Dimensions > & rhs ) const

inline

Definition at line 120 of file id.hpp.

References sycl::_V1::detail::array< dimensions >::operator==().

◆ size_t()

template<int Dimensions = 1>

__SYCL_ALWAYS_INLINE sycl::_V1::id< Dimensions >::size_t ( ) const

inline

Definition at line 108 of file id.hpp.

Member Data Documentation

◆ dimensions

template<int Dimensions = 1>

constexpr int sycl::_V1::id< Dimensions >::dimensions = Dimensions

staticconstexpr

Definition at line 38 of file id.hpp.

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

include/sycl/detail/array.hpp
include/sycl/id.hpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ id() [1/10]

◆ id() [2/10]

◆ id() [3/10]

◆ id() [4/10]

◆ id() [5/10]

◆ id() [6/10]

◆ id() [7/10]

◆ id() [8/10]

◆ id() [9/10]

◆ id() [10/10]

Member Function Documentation

◆ operator EnableIfT<()

◆ operator==()

◆ size_t()

Member Data Documentation

◆ dimensions

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