DPC++ Runtime
Runtime libraries for oneAPI DPC++
sycl::_V1::h_item< Dimensions > Class Template Reference

Identifies an instance of a group::parallel_for_work_item function object executing at each point in a local range passed to a parallel_for_work_item call or to the corresponding parallel_for_work_group call. More...

#include <sycl/h_item.hpp>

Collaboration diagram for sycl::_V1::h_item< Dimensions >:

Public Member Functions

 h_item ()=delete
 
 h_item (const h_item &hi)=default
 
h_itemoperator= (const h_item &hi)=default
 
item< Dimensions, false > get_global () const
 
item< Dimensions, false > get_local () const
 
item< Dimensions, false > get_logical_local () const
 
item< Dimensions, false > get_physical_local () const
 
range< Dimensionsget_global_range () const
 
size_t get_global_range (int Dimension) const
 
id< Dimensionsget_global_id () const
 
size_t get_global_id (int Dimension) const
 
range< Dimensionsget_local_range () const
 
size_t get_local_range (int Dimension) const
 
id< Dimensionsget_local_id () const
 
size_t get_local_id (int Dimension) const
 
range< Dimensionsget_logical_local_range () const
 
size_t get_logical_local_range (int Dimension) const
 
id< Dimensionsget_logical_local_id () const
 
size_t get_logical_local_id (int Dimension) const
 
range< Dimensionsget_physical_local_range () const
 
size_t get_physical_local_range (int Dimension) const
 
id< Dimensionsget_physical_local_id () const
 
size_t get_physical_local_id (int Dimension) const
 
bool operator== (const h_item &rhs) const
 
bool operator!= (const h_item &rhs) const
 

Static Public Attributes

static constexpr int dimensions = Dimensions
 

Protected Member Functions

 h_item (const item< Dimensions, false > &GL, const item< Dimensions, false > &L, const range< Dimensions > &flexLocalRange)
 
 h_item (const item< Dimensions, false > &GL, const item< Dimensions, false > &L)
 
void setLogicalLocalID (const id< Dimensions > &ID)
 

Friends

class detail::Builder
 
class group< Dimensions >
 

Detailed Description

template<int Dimensions>
class sycl::_V1::h_item< Dimensions >

Identifies an instance of a group::parallel_for_work_item function object executing at each point in a local range passed to a parallel_for_work_item call or to the corresponding parallel_for_work_group call.

Definition at line 31 of file h_item.hpp.

Constructor & Destructor Documentation

◆ h_item() [1/4]

template<int Dimensions>
sycl::_V1::h_item< Dimensions >::h_item ( )
delete

◆ h_item() [2/4]

template<int Dimensions>
sycl::_V1::h_item< Dimensions >::h_item ( const h_item< Dimensions > &  hi)
default

◆ h_item() [3/4]

template<int Dimensions>
sycl::_V1::h_item< Dimensions >::h_item ( const item< Dimensions, false > &  GL,
const item< Dimensions, false > &  L,
const range< Dimensions > &  flexLocalRange 
)
inlineprotected

Definition at line 118 of file h_item.hpp.

◆ h_item() [4/4]

template<int Dimensions>
sycl::_V1::h_item< Dimensions >::h_item ( const item< Dimensions, false > &  GL,
const item< Dimensions, false > &  L 
)
inlineprotected

Definition at line 124 of file h_item.hpp.

Member Function Documentation

◆ get_global()

template<int Dimensions>
item<Dimensions, false> sycl::_V1::h_item< Dimensions >::get_global ( ) const
inline

◆ get_global_id() [1/2]

template<int Dimensions>
id<Dimensions> sycl::_V1::h_item< Dimensions >::get_global_id ( ) const
inline

◆ get_global_id() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_global_id ( int  Dimension) const
inline

◆ get_global_range() [1/2]

template<int Dimensions>
range<Dimensions> sycl::_V1::h_item< Dimensions >::get_global_range ( ) const
inline

◆ get_global_range() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_global_range ( int  Dimension) const
inline

◆ get_local()

◆ get_local_id() [1/2]

template<int Dimensions>
id<Dimensions> sycl::_V1::h_item< Dimensions >::get_local_id ( ) const
inline

◆ get_local_id() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_local_id ( int  Dimension) const
inline

◆ get_local_range() [1/2]

template<int Dimensions>
range<Dimensions> sycl::_V1::h_item< Dimensions >::get_local_range ( ) const
inline

◆ get_local_range() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_local_range ( int  Dimension) const
inline

◆ get_logical_local()

◆ get_logical_local_id() [1/2]

template<int Dimensions>
id<Dimensions> sycl::_V1::h_item< Dimensions >::get_logical_local_id ( ) const
inline

◆ get_logical_local_id() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_logical_local_id ( int  Dimension) const
inline

◆ get_logical_local_range() [1/2]

template<int Dimensions>
range<Dimensions> sycl::_V1::h_item< Dimensions >::get_logical_local_range ( ) const
inline

◆ get_logical_local_range() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_logical_local_range ( int  Dimension) const
inline

◆ get_physical_local()

◆ get_physical_local_id() [1/2]

template<int Dimensions>
id<Dimensions> sycl::_V1::h_item< Dimensions >::get_physical_local_id ( ) const
inline

◆ get_physical_local_id() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_physical_local_id ( int  Dimension) const
inline

◆ get_physical_local_range() [1/2]

template<int Dimensions>
range<Dimensions> sycl::_V1::h_item< Dimensions >::get_physical_local_range ( ) const
inline

◆ get_physical_local_range() [2/2]

template<int Dimensions>
size_t sycl::_V1::h_item< Dimensions >::get_physical_local_range ( int  Dimension) const
inline

◆ operator!=()

template<int Dimensions>
bool sycl::_V1::h_item< Dimensions >::operator!= ( const h_item< Dimensions > &  rhs) const
inline

Definition at line 113 of file h_item.hpp.

◆ operator=()

template<int Dimensions>
h_item& sycl::_V1::h_item< Dimensions >::operator= ( const h_item< Dimensions > &  hi)
default

◆ operator==()

template<int Dimensions>
bool sycl::_V1::h_item< Dimensions >::operator== ( const h_item< Dimensions > &  rhs) const
inline

Definition at line 108 of file h_item.hpp.

◆ setLogicalLocalID()

template<int Dimensions>
void sycl::_V1::h_item< Dimensions >::setLogicalLocalID ( const id< Dimensions > &  ID)
inlineprotected

Definition at line 129 of file h_item.hpp.

References sycl::_V1::detail::Builder::updateItemIndex().

Friends And Related Function Documentation

◆ detail::Builder

template<int Dimensions>
friend class detail::Builder
friend

Definition at line 116 of file h_item.hpp.

◆ group< Dimensions >

template<int Dimensions>
friend class group< Dimensions >
friend

Definition at line 116 of file h_item.hpp.

Member Data Documentation

◆ dimensions

template<int Dimensions>
constexpr int sycl::_V1::h_item< Dimensions >::dimensions = Dimensions
staticconstexpr

Definition at line 33 of file h_item.hpp.


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