Eigen::TensorSycl::internal::ThreadProperties< StorageIndex > Struct Template Reference

ThreadProperties is a template class that provides each thread's properties within a workgroup. Please see the sycl-1.2.1 specification (https://www.khronos.org/registry/SYCL/specs/sycl-1.2.1.pdf) for the workgroup, work-items. More...

#include <TensorContractionSycl.h>

Public Member Functions

EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE ThreadProperties (const StorageIndex linearLocalThreadId_, const StorageIndex kGroupId_, const StorageIndex mGroupOffset_, const StorageIndex nGroupOffset_, const StorageIndex kGroupOffset_, const StorageIndex mLocalOffset_, const StorageIndex nLocalOffset_, const StorageIndex mGlobalOffset_, const StorageIndex nGlobalOffset_, StorageIndex kSize_, const bool is_internal_)
 

Public Attributes

const StorageIndex linearLocalThreadId
 
const StorageIndex kGroupId
 
const StorageIndex mGroupOffset
 
const StorageIndex nGroupOffset
 
const StorageIndex kGroupOffset
 
const StorageIndex mLocalOffset
 
const StorageIndex nLocalOffset
 
const StorageIndex mGlobalOffset
 
const StorageIndex nGlobalOffset
 
StorageIndex kSize
 
const bool is_internal
 

Detailed Description

template<typename StorageIndex>
struct Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >

ThreadProperties is a template class that provides each thread's properties within a workgroup. Please see the sycl-1.2.1 specification (https://www.khronos.org/registry/SYCL/specs/sycl-1.2.1.pdf) for the workgroup, work-items.

Template Parameters
StorageIndexdetermines the StorageIndex Type
Parameters
linearLocalThreadIddetermines the linearized location of a thread within a work-group
kGroupIddetermines the logical group id in a k dimension of the flattened tensor. It will be > 1 when tall/skinny algorithm is used
mGroupOffsetdetermines the logical start position of all thread within a workgroup for the m dimension of the flattened tensor.
kGroupOffsetdetermines the logical start position of all thread within a workgroup for the k dimension of the flattened tensor. It will be > 1 when tall/skinny algorithm is used.
mLocalOffsetdetermines the logical start position of each thread within a workgroup for the m dimension of a flattened tensor. The position determines the distance of each thread within the workgroup from each other independent from their global position.
nLocalOffsetdetermines the logical start position of each thread within a workgroup for the n dimension of a flattened tensor. The position determines the distance of each thread within the workgroup from each other independent from their global position.
mGlobalOffsetdetermines the logical start position of each thread a thread for the m dimension on a flattened tensor
nGlobalOffsetdetermines the logical start position of each thread a thread for the n dimension on a flattened tensor
kSize: determine the number of the k elements of the flattened Tensor to be processed by each thread for the given tensor block. This is !=K dimension of Flattened Tensor when Tall/Skinny matrix is used.
is_internal: this will determined if the thread within the work-group computes an internal block of tensor or the edge blocks. When it is internal, there is no need to check the boundaries and all the if stantement can be resolve by compiler.

Constructor & Destructor Documentation

◆ ThreadProperties()

template<typename StorageIndex >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::ThreadProperties ( const StorageIndex  linearLocalThreadId_,
const StorageIndex  kGroupId_,
const StorageIndex  mGroupOffset_,
const StorageIndex  nGroupOffset_,
const StorageIndex  kGroupOffset_,
const StorageIndex  mLocalOffset_,
const StorageIndex  nLocalOffset_,
const StorageIndex  mGlobalOffset_,
const StorageIndex  nGlobalOffset_,
StorageIndex  kSize_,
const bool  is_internal_ 
)
inline
391  : linearLocalThreadId(linearLocalThreadId_),
392  kGroupId(kGroupId_),
393  mGroupOffset(mGroupOffset_),
394  nGroupOffset(nGroupOffset_),
395  kGroupOffset(kGroupOffset_),
396  mLocalOffset(mLocalOffset_),
397  nLocalOffset(nLocalOffset_),
398  mGlobalOffset(mGlobalOffset_),
399  nGlobalOffset(nGlobalOffset_),
400  kSize(kSize_),
401  is_internal(is_internal_) {}
const StorageIndex mGroupOffset
Definition: TensorContractionSycl.h:376
const StorageIndex nGroupOffset
Definition: TensorContractionSycl.h:377
const StorageIndex mLocalOffset
Definition: TensorContractionSycl.h:379
const StorageIndex kGroupId
Definition: TensorContractionSycl.h:375
const StorageIndex linearLocalThreadId
Definition: TensorContractionSycl.h:374
const StorageIndex nLocalOffset
Definition: TensorContractionSycl.h:380
StorageIndex kSize
Definition: TensorContractionSycl.h:383
const StorageIndex kGroupOffset
Definition: TensorContractionSycl.h:378
const StorageIndex mGlobalOffset
Definition: TensorContractionSycl.h:381
const bool is_internal
Definition: TensorContractionSycl.h:384
const StorageIndex nGlobalOffset
Definition: TensorContractionSycl.h:382

Member Data Documentation

◆ is_internal

template<typename StorageIndex >
const bool Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::is_internal

◆ kGroupId

template<typename StorageIndex >
const StorageIndex Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::kGroupId

◆ kGroupOffset

◆ kSize

◆ linearLocalThreadId

template<typename StorageIndex >
const StorageIndex Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::linearLocalThreadId

◆ mGlobalOffset

◆ mGroupOffset

◆ mLocalOffset

template<typename StorageIndex >
const StorageIndex Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::mLocalOffset

◆ nGlobalOffset

◆ nGroupOffset

◆ nLocalOffset

template<typename StorageIndex >
const StorageIndex Eigen::TensorSycl::internal::ThreadProperties< StorageIndex >::nLocalOffset

The documentation for this struct was generated from the following file: