The cl::sycl::nd_item object is a container for all information about a work-item. More...

#include <base.h>

Inheritance diagram for cl::sycl::nd_item< dimensions >:

Public Member Functions
	nd_item (const nd_item &rhs)=default
	copy constructor is public More...

template<int dimensions2>
	nd_item (const nd_item< dimensions2 > &rhs)
	Copy Constructor from nd_item<dims> More...

	nd_item (const detail::nd_item_base &i)

experimental::sub_group	get_sub_group () const
	Access to the subgroup functionality. More...

void	sub_group_barrier (access::fence_space accessSpace=access::fence_space::global_and_local) const
	Access to subgroup barrier. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_global_id(unsigned) instead.") size_t get_global(unsigned int dimension) const
	Returns the global id for a specific dimension. More...

size_t	get_global_id (unsigned int dimension) const
	Returns the global id for a specific dimension. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_global_id() instead.") id< dimensions > get_global() const
	Return the global id for all dimension. More...

id< dimensions >	get_global_id () const
	Return the global id for all dimension. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_local_id(unsigned) instead.") size_t get_local(unsigned int dimension) const
	Returns the local id for a specific dimension. More...

size_t	get_local_id (unsigned int dimension) const
	Returns the local id for a specific dimension. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_local_id() instead.") id< dimensions > get_local() const
	Return the local id for all dimension. More...

id< dimensions >	get_local_id () const
	Return the local id for all dimension. More...

size_t	get_global_range (int dimension) const
	Get the global range for a specified dimension. More...

range< dimensions >	get_global_range () const
	Get the global range of the enqueued nd_range. More...

size_t	get_local_range (int dimension) const
	Get the local range for a specified dimension. More...

range< dimensions >	get_local_range () const
	Get the local range of the enqueued nd_range. More...

size_t	get_group (unsigned int dim) const
	Returns the current group id in a given dimension. More...

group< dimensions >	get_group () const
	Returns the group. More...

id< dimensions >	get_offset () const
	Get the offset of the enqueued nd_range. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_group_range() instead.") range< dimensions > get_num_groups() const
	Returns the group range of the enqueued nd_range. More...

range< dimensions >	get_group_range () const
	Returns the group range of the enqueued nd_range. More...

	COMPUTECPP_DEPRECATED_BY_SYCL_VER (201703, "Use nd_item::get_group_range(unsigned) instead.") size_t get_num_groups(int dimension) const
	Returns the group range of the enqueued nd_range for a specific dimension. More...

size_t	get_group_range (int dimension) const
	Returns the group range of the enqueued nd_range for a specific dimension. More...

size_t	get_group_linear_id () const
	Returns the group linear id. More...

nd_range< dimensions >	get_nd_range () const
	Returns the enqueued nd_range. More...

template<typename dataT >
device_event	async_work_group_copy (local_ptr< dataT > dest, global_ptr< dataT > src, size_t numElements, size_t srcStride=1) const
	Asynchronous work group copy from a local pointer to global. More...

template<typename dataT >
device_event	async_work_group_copy (global_ptr< dataT > dest, local_ptr< dataT > src, size_t numElements, size_t destStride=1) const
	Asynchronous work group copy from a local pointer to global. More...

	COMPUTECPP_DEPRECATED_API ("Deprecated Codeplay extension, use the codeplay_await_dma_transfer free " "function instead.") void codeplay_await_dma_transfer() const
	Waits until codeplay_begin_dma_transfer completes. More...

template<class dataT , int sourceDim, int destinationDim, access::mode sourceMode, access::placeholder isPlaceholderSrc>
	COMPUTECPP_DEPRECATED_API ("Deprecated Codeplay extension, use the codeplay_begin_dma_transfer free " "function instead.") void codeplay_begin_dma_transfer(const accessor< dataT
	Performs an asynchronous copy from global memory plane to subgroup local memory. More...

	detail::assert_plane_range ()

	detail::assert_read_mode ()

	COMPUTECPP_NOT_IMPLEMENTED ("ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host.")

template<class dataT , int dim, access::mode sourceMode, access::placeholder isPlaceholderSrc>
	COMPUTECPP_DEPRECATED_API ("Deprecated Codeplay extension, use the codeplay_begin_dma_transfer free " "function instead.") void codeplay_begin_dma_transfer(const accessor< dataT
	Performs an asynchronous copy from a global memory plane to subgroup local memory. More...

	detail::assert_read_mode ()

	COMPUTECPP_NOT_IMPLEMENTED ("ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host.")

template<class dataT , int sourceDim, int destinationDim, access::mode destinationMode, access::placeholder isPlaceholderDst>
	COMPUTECPP_DEPRECATED_API ("Deprecated Codeplay extension, use the codeplay_begin_dma_transfer free " "function instead.") void codeplay_begin_dma_transfer(const accessor< dataT
	Performs an asynchronous copy from subgroup local memory to a global memory plane. More...

	detail::assert_plane_range ()

	detail::assert_write_mode ()

	COMPUTECPP_NOT_IMPLEMENTED ("ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host.")

template<class dataT , int dim, access::mode destinationMode, access::placeholder isPlaceholderDst>
	COMPUTECPP_DEPRECATED_API ("Deprecated Codeplay extension, use the codeplay_begin_dma_transfer free " "function instead.") void codeplay_begin_dma_transfer(const multi_ptr< dataT
	Performs an asynchronous copy from subgroup local memory to a global memory plane. More...

	detail::assert_write_mode ()

	COMPUTECPP_NOT_IMPLEMENTED ("ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host.")

template<typename... eventTN>
void	wait_for (eventTN... events) const
	Waits on each given device_event. More...

Public Attributes
	sourceDim

	sourceMode

	COMPUTECPP_ACCESS_TARGET_DEVICE

isPlaceholderSrc &	source

isPlaceholderSrc const accessor< dataT, destinationDim, access::mode::read_write, access::target::subgroup_local > &	destination

isPlaceholderSrc const accessor< dataT, destinationDim, access::mode::read_write, access::target::subgroup_local > const range< 2 >	copyBounds

isPlaceholderSrc const accessor< dataT, destinationDim, access::mode::read_write, access::target::subgroup_local > const range< 2 > size_t	offset

isPlaceholderSrc const accessor< dataT, destinationDim, access::mode::read_write, access::target::subgroup_local > const range< 2 > size_t size_t	stride

void	source

void	destination

void	copyBounds

void	offset

void	stride

	dim

isPlaceholderSrc const multi_ptr< dataT, access::address_space::subgroup_local_space >	destination

isPlaceholderSrc const multi_ptr< dataT, access::address_space::subgroup_local_space > const range< 2 >	copyBounds

isPlaceholderSrc const multi_ptr< dataT, access::address_space::subgroup_local_space > const range< 2 > size_t	offset

isPlaceholderSrc const multi_ptr< dataT, access::address_space::subgroup_local_space > const range< 2 > size_t size_t	stride

access::target::subgroup_local &	source

access::target::subgroup_local const accessor< dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > &	destination

access::target::subgroup_local const accessor< dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 >	copyBounds

access::target::subgroup_local const accessor< dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 > size_t	offset

access::target::subgroup_local const accessor< dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 > size_t size_t	stride

access::address_space::subgroup_local_space	source

access::address_space::subgroup_local_space const accessor< dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > &	destination

access::address_space::subgroup_local_space const accessor< dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 >	copyBounds

access::address_space::subgroup_local_space const accessor< dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 > size_t	offset

access::address_space::subgroup_local_space const accessor< dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst > const range< 2 > size_t size_t	stride

Protected Types
using	base_t = detail::nd_item_base

Protected Member Functions
	nd_item ()=delete
	This constructor should not be called. More...

item< dimensions >	get_global_item () const
	Get an item object embedding global information from this nd_range. More...

item< dimensions >	get_local_item () const
	Get an item object embedding local information from this nd_range. More...

id< dimensions >	get_group_id () const
	Retrieves the group ID. More...

bool	is_zero_id () const
	Checks if the ID of this nd_item is all zeros. More...

Friends
bool	operator== (const nd_item &lhs, const nd_item &rhs)
	Equality operator. More...

bool	operator!= (const nd_item &lhs, const nd_item &rhs)
	Non-equality operator. More...

Detailed Description

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

The cl::sycl::nd_item object is a container for all information about a work-item.

The cl::sycl::nd_item object is used within the handler::parallel_for functions. The cl::sycl::item object can return information about the local and global sizes of an enqueued nd_range as well as the local and global ids of the work item.

Definition at line 45 of file base.h.

Member Typedef Documentation

◆ base_t

template<int dimensions = 1>

using cl::sycl::nd_item< dimensions >::base_t = detail::nd_item_base

protected

Definition at line 208 of file item.h.

Constructor & Destructor Documentation

◆ nd_item() [1/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::nd_item ( )

protecteddelete

This constructor should not be called.

nd_item has to be constructed from the runtime.

Warning: Cannot be used (deleted).

◆ nd_item() [2/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::nd_item ( const nd_item< dimensions > & rhs )

default

copy constructor is public

◆ nd_item() [3/4]

template<int dimensions = 1>

template<int dimensions2>

cl::sycl::nd_item< dimensions >::nd_item ( const nd_item< dimensions2 > & rhs )

inline

Copy Constructor from nd_item<dims>

copies the given nd_item with the same dimensionality. If the dimensionality is different, a compiler error is produced.

Definition at line 258 of file item.h.

◆ nd_item() [4/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::nd_item ( const detail::nd_item_base & i )

inline

Definition at line 268 of file item.h.

Member Function Documentation

◆ async_work_group_copy() [1/2]

template<int dimensions = 1>

template<typename dataT >

device_event cl::sycl::nd_item< dimensions >::async_work_group_copy	(	local_ptr< dataT >	dest,
		global_ptr< dataT >	src,
		size_t	numElements,
		size_t	srcStride = `1`
	)		const

inline

Asynchronous work group copy from a local pointer to global.

Template Parameters

dataT Data type of the pointer

Parameters

dest	Pointer to the destination in local memory
src	Pointer to the source in global memory
numElements	Number of elements to copy
destStride	Stride in the origin

Todo:: Use builtins

Definition at line 516 of file item.h.

◆ async_work_group_copy() [2/2]

template<int dimensions = 1>

template<typename dataT >

device_event cl::sycl::nd_item< dimensions >::async_work_group_copy	(	global_ptr< dataT >	dest,
		local_ptr< dataT >	src,
		size_t	numElements,
		size_t	destStride = `1`
	)		const

inline

Asynchronous work group copy from a local pointer to global.

Template Parameters

dataT Data type of the pointer

Parameters

dest	Pointer to the destination in global memory
src	Pointer to the source in local memory
numElements	Number of elements to copy
destStride	Stride in the destination

Todo:: Use builtins

Definition at line 532 of file item.h.

◆ COMPUTECPP_DEPRECATED_API() [1/5]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_API	(	"Deprecated Codeplay	extension,
		use the codeplay_await_dma_transfer free " "function instead."
	)		const

inline

Waits until codeplay_begin_dma_transfer completes.

Definition at line 541 of file item.h.

◆ COMPUTECPP_DEPRECATED_API() [2/5]

template<int dimensions = 1>

template<class dataT , int sourceDim, int destinationDim, access::mode sourceMode, access::placeholder isPlaceholderSrc>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_API	(	"Deprecated Codeplay	extension,
		use the codeplay_begin_dma_transfer free " "function instead."
	)		const

Performs an asynchronous copy from global memory plane to subgroup local memory.

Parameters

source	The region of memory to copy data from.
destination	The region of memory to write the data to.
copyBounds	The shape of the region.
offset	The offset into the planar region of memory.
stride	The subgroup local memory stride.

◆ COMPUTECPP_DEPRECATED_API() [3/5]

template<int dimensions = 1>

template<class dataT , int dim, access::mode sourceMode, access::placeholder isPlaceholderSrc>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_API	(	"Deprecated Codeplay	extension,
		use the codeplay_begin_dma_transfer free " "function instead."
	)		const

Performs an asynchronous copy from a global memory plane to subgroup local memory.

Parameters

source	The region of memory to copy data from.
destination	The region of memory to write the data to.
copyBounds	The shape of the region.
offset	The offset into the planar region of memory.
stride	The subgroup local memory stride.

◆ COMPUTECPP_DEPRECATED_API() [4/5]

template<int dimensions = 1>

template<class dataT , int sourceDim, int destinationDim, access::mode destinationMode, access::placeholder isPlaceholderDst>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_API	(	"Deprecated Codeplay	extension,
		use the codeplay_begin_dma_transfer free " "function instead."
	)		const

Performs an asynchronous copy from subgroup local memory to a global memory plane.

Parameters

source	The region of memory to copy data from.
destination	The region of memory to write the data to.
copyBounds	The shape of the region.
offset	The offset into the planar region of memory.
stride	The subgroup local memory stride.

◆ COMPUTECPP_DEPRECATED_API() [5/5]

template<int dimensions = 1>

template<class dataT , int dim, access::mode destinationMode, access::placeholder isPlaceholderDst>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_API	(	"Deprecated Codeplay	extension,
		use the codeplay_begin_dma_transfer free " "function instead."
	)		const

Performs an asynchronous copy from subgroup local memory to a global memory plane.

Parameters

source	The region of memory to copy data from.
destination	The region of memory to write the data to.
copyBounds	The shape of the region.
offset	The offset into the planar region of memory.
stride	The subgroup local memory stride.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [1/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_global_id(unsigned) instead."
	)		const

inline

Returns the global id for a specific dimension.

Parameters

dimension of global id to return. Must be in the range [0,2].

Returns: the global id for the specified dimension.

Definition at line 352 of file item.h.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [2/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_global_id() instead."
	)		const

inline

Return the global id for all dimension.

Returns: An id object representing the global id for all dimension.

Definition at line 369 of file item.h.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [3/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_local_id(unsigned) instead."
	)		const

inline

Returns the local id for a specific dimension.

Parameters

dimension of local id to return. Must be in the range [0,2].

Returns: the local id for the specified dimension.

Definition at line 382 of file item.h.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [4/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_local_id() instead."
	)		const

inline

Return the local id for all dimension.

Returns: An id object representing the local id for all dimension.

Definition at line 399 of file item.h.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [5/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_group_range() instead."
	)		const

inline

Returns the group range of the enqueued nd_range.

Returns: the value of the group range for all dimensions.

Definition at line 463 of file item.h.

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [6/6]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_DEPRECATED_BY_SYCL_VER	(	201703	,
		"Use nd_item< dimensions >::get_group_range(unsigned) instead."
	)		const

inline

Returns the group range of the enqueued nd_range for a specific dimension.

Parameters

dimension of the range to be returned. Must be in the range [0,2]

Returns: the value of the group range for all dimensions.

Definition at line 479 of file item.h.

◆ COMPUTECPP_NOT_IMPLEMENTED() [1/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_NOT_IMPLEMENTED ( "ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host." )

◆ COMPUTECPP_NOT_IMPLEMENTED() [2/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_NOT_IMPLEMENTED ( "ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host." )

◆ COMPUTECPP_NOT_IMPLEMENTED() [3/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_NOT_IMPLEMENTED ( "ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host." )

◆ COMPUTECPP_NOT_IMPLEMENTED() [4/4]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_NOT_IMPLEMENTED ( "ComputeCpp has not yet implemented codeplay_begin_dma_transfer " "for host." )

◆ detail::assert_plane_range() [1/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_plane_range ( )

◆ detail::assert_plane_range() [2/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_plane_range ( )

◆ detail::assert_read_mode() [1/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_read_mode ( )

◆ detail::assert_read_mode() [2/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_read_mode ( )

◆ detail::assert_write_mode() [1/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_write_mode ( )

◆ detail::assert_write_mode() [2/2]

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::detail::assert_write_mode ( )

◆ get_global_id() [1/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_global_id ( unsigned int dimension ) const

inline

Returns the global id for a specific dimension.

Parameters

dimension of global id to return. Must be in the range [0,2].

Returns: the global id for the specified dimension.

Definition at line 362 of file item.h.

◆ get_global_id() [2/2]

template<int dimensions = 1>

id<dimensions> cl::sycl::nd_item< dimensions >::get_global_id ( ) const

inline

Return the global id for all dimension.

Returns: An id object representing the global id for all dimension.

Definition at line 376 of file item.h.

◆ get_global_item()

template<int dimensions = 1>

item<dimensions> cl::sycl::nd_item< dimensions >::get_global_item ( ) const

inlineprotected

Get an item object embedding global information from this nd_range.

Returns: A global item object.

Definition at line 218 of file item.h.

◆ get_global_range() [1/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_global_range ( int dimension ) const

inline

Get the global range for a specified dimension.

Parameters

dimension of the global range to be returned. Must be in the range [0,2].

Returns: the value of the global range for the specified dimension.

Definition at line 413 of file item.h.

◆ get_global_range() [2/2]

template<int dimensions = 1>

range<dimensions> cl::sycl::nd_item< dimensions >::get_global_range ( ) const

inline

Get the global range of the enqueued nd_range.

Returns: the values of the global range for all dimensions.

Definition at line 420 of file item.h.

◆ get_group() [1/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_group ( unsigned int dim ) const

inline

Returns the current group id in a given dimension.

Parameters

dimension of the id to be returned. Must be in the range [0,2].

Returns: the value of the group range in the specified dimension.

Definition at line 444 of file item.h.

◆ get_group() [2/2]

template<int dimensions = 1>

group<dimensions> cl::sycl::nd_item< dimensions >::get_group ( ) const

inline

Returns the group.

Returns: A group object.

Definition at line 449 of file item.h.

◆ get_group_id()

template<int dimensions = 1>

id<dimensions> cl::sycl::nd_item< dimensions >::get_group_id ( ) const

inlineprotected

Retrieves the group ID.

Returns: ID of the group associated with this object

Definition at line 232 of file item.h.

◆ get_group_linear_id()

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_group_linear_id ( ) const

inline

Returns the group linear id.

Returns: the group linear id.

Definition at line 497 of file item.h.

◆ get_group_range() [1/2]

template<int dimensions = 1>

range<dimensions> cl::sycl::nd_item< dimensions >::get_group_range ( ) const

inline

Returns the group range of the enqueued nd_range.

Returns: the value of the group range for all dimensions.

Definition at line 470 of file item.h.

◆ get_group_range() [2/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_group_range ( int dimension ) const

inline

Returns the group range of the enqueued nd_range for a specific dimension.

Parameters

dimension of the range to be returned. Must be in the range [0,2]

Returns: the value of the group range for all dimensions.

Definition at line 490 of file item.h.

◆ get_local_id() [1/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_local_id ( unsigned int dimension ) const

inline

Returns the local id for a specific dimension.

Parameters

dimension of local id to return. Must be in the range [0,2].

Returns: the local id for the specified dimension.

Definition at line 392 of file item.h.

◆ get_local_id() [2/2]

template<int dimensions = 1>

id<dimensions> cl::sycl::nd_item< dimensions >::get_local_id ( ) const

inline

Return the local id for all dimension.

Returns: An id object representing the local id for all dimension.

Definition at line 406 of file item.h.

◆ get_local_item()

template<int dimensions = 1>

item<dimensions> cl::sycl::nd_item< dimensions >::get_local_item ( ) const

inlineprotected

Get an item object embedding local information from this nd_range.

Returns: A local item object.

Definition at line 225 of file item.h.

◆ get_local_range() [1/2]

template<int dimensions = 1>

size_t cl::sycl::nd_item< dimensions >::get_local_range ( int dimension ) const

inline

Get the local range for a specified dimension.

Parameters

dimension of the local range to be returned. Must be in the range [0,2].

Returns: the value of the local range for the specified dimension.

Definition at line 429 of file item.h.

◆ get_local_range() [2/2]

template<int dimensions = 1>

range<dimensions> cl::sycl::nd_item< dimensions >::get_local_range ( ) const

inline

Get the local range of the enqueued nd_range.

Returns: the values of the local range for all dimensions.

Definition at line 436 of file item.h.

◆ get_nd_range()

template<int dimensions = 1>

nd_range<dimensions> cl::sycl::nd_item< dimensions >::get_nd_range ( ) const

inline

Returns the enqueued nd_range.

Returns: the enqueued nd_range.

Definition at line 502 of file item.h.

◆ get_offset()

template<int dimensions = 1>

id<dimensions> cl::sycl::nd_item< dimensions >::get_offset ( ) const

inline

Get the offset of the enqueued nd_range.

Returns: The offset.

Definition at line 458 of file item.h.

◆ get_sub_group()

template<int dimensions = 1>

experimental::sub_group cl::sycl::nd_item< dimensions >::get_sub_group ( ) const

inline

Access to the subgroup functionality.

Returns: A new instance of the class sub_group

Definition at line 274 of file item.h.

◆ is_zero_id()

template<int dimensions = 1>

bool cl::sycl::nd_item< dimensions >::is_zero_id ( ) const

inlineprotected

Checks if the ID of this nd_item is all zeros.

Returns: True if current ID is (0, 0, 0)

Definition at line 239 of file item.h.

◆ sub_group_barrier()

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::sub_group_barrier ( access::fence_space accessSpace = access::fence_space::global_and_local ) const

inline

Access to subgroup barrier.

Parameters

accessSpace Barrier fence space

Definition at line 326 of file item.h.

◆ wait_for()

template<int dimensions = 1>

template<typename... eventTN>

void cl::sycl::nd_item< dimensions >::wait_for ( eventTN... events ) const

inline

Waits on each given device_event.

Template Parameters

eventTN Pack of device_event types

Parameters

events Pack of device_events

Definition at line 717 of file item.h.

Friends And Related Function Documentation

◆ operator!=

template<int dimensions = 1>

bool operator!=	(	const nd_item< dimensions > &	lhs,
		const nd_item< dimensions > &	rhs
	)

friend

Non-equality operator.

Parameters

rhs	Object to compare to

Returns: True if at least one member variable not the same as the corresponding rhs member variable

Definition at line 344 of file item.h.

◆ operator==

template<int dimensions = 1>

bool operator==	(	const nd_item< dimensions > &	lhs,
		const nd_item< dimensions > &	rhs
	)

friend

Equality operator.

Parameters

rhs	Object to compare to

Returns: True if all member variables are equal to rhs member variables

Definition at line 335 of file item.h.

Member Data Documentation

◆ COMPUTECPP_ACCESS_TARGET_DEVICE

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::COMPUTECPP_ACCESS_TARGET_DEVICE

Definition at line 566 of file item.h.

◆ copyBounds [1/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::copyBounds

Definition at line 566 of file item.h.

◆ copyBounds [2/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::copyBounds

Definition at line 583 of file item.h.

◆ copyBounds [3/5]

template<int dimensions = 1>

isPlaceholderSrc const multi_ptr<dataT, access::address_space::subgroup_local_space> const range<2> cl::sycl::nd_item< dimensions >::copyBounds

Definition at line 606 of file item.h.

◆ copyBounds [4/5]

template<int dimensions = 1>

access::target::subgroup_local const accessor<dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> cl::sycl::nd_item< dimensions >::copyBounds

Definition at line 645 of file item.h.

◆ copyBounds [5/5]

template<int dimensions = 1>

access::address_space::subgroup_local_space const accessor<dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> cl::sycl::nd_item< dimensions >::copyBounds

Definition at line 687 of file item.h.

◆ destination [1/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::destination

Definition at line 566 of file item.h.

◆ destination [2/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::destination

Definition at line 582 of file item.h.

◆ destination [3/5]

template<int dimensions = 1>

isPlaceholderSrc const multi_ptr<dataT, access::address_space::subgroup_local_space> cl::sycl::nd_item< dimensions >::destination

Definition at line 606 of file item.h.

◆ destination [4/5]

template<int dimensions = 1>

access::target::subgroup_local const accessor<dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst>& cl::sycl::nd_item< dimensions >::destination

Definition at line 645 of file item.h.

◆ destination [5/5]

template<int dimensions = 1>

access::address_space::subgroup_local_space const accessor<dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst>& cl::sycl::nd_item< dimensions >::destination

Definition at line 687 of file item.h.

◆ dim

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::dim

Definition at line 606 of file item.h.

◆ offset [1/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::offset

Definition at line 566 of file item.h.

◆ offset [2/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::offset

Definition at line 584 of file item.h.

◆ offset [3/5]

template<int dimensions = 1>

isPlaceholderSrc const multi_ptr<dataT, access::address_space::subgroup_local_space> const range<2> size_t cl::sycl::nd_item< dimensions >::offset

Definition at line 606 of file item.h.

◆ offset [4/5]

template<int dimensions = 1>

access::target::subgroup_local const accessor<dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> size_t cl::sycl::nd_item< dimensions >::offset

Definition at line 645 of file item.h.

◆ offset [5/5]

template<int dimensions = 1>

access::address_space::subgroup_local_space const accessor<dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> size_t cl::sycl::nd_item< dimensions >::offset

Definition at line 687 of file item.h.

◆ source [1/4]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::source

Definition at line 566 of file item.h.

◆ source [2/4]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::source

Definition at line 581 of file item.h.

◆ source [3/4]

template<int dimensions = 1>

access::target::subgroup_local& cl::sycl::nd_item< dimensions >::source

Definition at line 645 of file item.h.

◆ source [4/4]

template<int dimensions = 1>

access::address_space::subgroup_local_space cl::sycl::nd_item< dimensions >::source

Definition at line 687 of file item.h.

◆ sourceDim

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::sourceDim

Definition at line 566 of file item.h.

◆ sourceMode

template<int dimensions = 1>

cl::sycl::nd_item< dimensions >::sourceMode

Definition at line 566 of file item.h.

◆ stride [1/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::stride

Initial value:

{
    detail::assert_plane_range<sourceDim>()

Definition at line 570 of file item.h.

◆ stride [2/5]

template<int dimensions = 1>

void cl::sycl::nd_item< dimensions >::stride

Definition at line 585 of file item.h.

◆ stride [3/5]

template<int dimensions = 1>

isPlaceholderSrc const multi_ptr<dataT, access::address_space::subgroup_local_space> const range<2> size_t size_t cl::sycl::nd_item< dimensions >::stride

Initial value:

{
    detail::assert_plane_range<dim>()

Definition at line 610 of file item.h.

◆ stride [4/5]

template<int dimensions = 1>

access::target::subgroup_local const accessor<dataT, destinationDim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> size_t size_t cl::sycl::nd_item< dimensions >::stride

Initial value:

{
    detail::assert_plane_range<sourceDim>()

Definition at line 650 of file item.h.

◆ stride [5/5]

template<int dimensions = 1>

access::address_space::subgroup_local_space const accessor<dataT, dim, destinationMode, COMPUTECPP_ACCESS_TARGET_DEVICE, isPlaceholderDst> const range<2> size_t size_t cl::sycl::nd_item< dimensions >::stride

Initial value:

{
    detail::assert_plane_range<dim>()

Definition at line 691 of file item.h.

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

menu_bookReference

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Friends

Detailed Description

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

Member Typedef Documentation

◆ base_t

Constructor & Destructor Documentation

◆ nd_item() [1/4]

◆ nd_item() [2/4]

◆ nd_item() [3/4]

◆ nd_item() [4/4]

Member Function Documentation

◆ async_work_group_copy() [1/2]

◆ async_work_group_copy() [2/2]

◆ COMPUTECPP_DEPRECATED_API() [1/5]

◆ COMPUTECPP_DEPRECATED_API() [2/5]

◆ COMPUTECPP_DEPRECATED_API() [3/5]

◆ COMPUTECPP_DEPRECATED_API() [4/5]

◆ COMPUTECPP_DEPRECATED_API() [5/5]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [1/6]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [2/6]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [3/6]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [4/6]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [5/6]

◆ COMPUTECPP_DEPRECATED_BY_SYCL_VER() [6/6]

◆ COMPUTECPP_NOT_IMPLEMENTED() [1/4]

◆ COMPUTECPP_NOT_IMPLEMENTED() [2/4]

◆ COMPUTECPP_NOT_IMPLEMENTED() [3/4]

◆ COMPUTECPP_NOT_IMPLEMENTED() [4/4]

◆ detail::assert_plane_range() [1/2]

◆ detail::assert_plane_range() [2/2]

◆ detail::assert_read_mode() [1/2]

◆ detail::assert_read_mode() [2/2]

◆ detail::assert_write_mode() [1/2]

◆ detail::assert_write_mode() [2/2]

◆ get_global_id() [1/2]

◆ get_global_id() [2/2]

◆ get_global_item()

◆ get_global_range() [1/2]

◆ get_global_range() [2/2]

◆ get_group() [1/2]

◆ get_group() [2/2]

◆ get_group_id()

◆ get_group_linear_id()

◆ get_group_range() [1/2]

◆ get_group_range() [2/2]

◆ get_local_id() [1/2]

◆ get_local_id() [2/2]

◆ get_local_item()

◆ get_local_range() [1/2]

◆ get_local_range() [2/2]

◆ get_nd_range()

◆ get_offset()

◆ get_sub_group()

◆ is_zero_id()

◆ sub_group_barrier()

◆ wait_for()

Friends And Related Function Documentation

◆ operator!=

◆ operator==

Member Data Documentation

◆ COMPUTECPP_ACCESS_TARGET_DEVICE

◆ copyBounds [1/5]

◆ copyBounds [2/5]

◆ copyBounds [3/5]

◆ copyBounds [4/5]

◆ copyBounds [5/5]

◆ destination [1/5]

◆ destination [2/5]

◆ destination [3/5]

◆ destination [4/5]

◆ destination [5/5]

◆ dim

◆ offset [1/5]

◆ offset [2/5]

◆ offset [3/5]

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