cl::sycl::id< dims > Class Template Reference
dims-dimensional index More...
#include <id.h>
Inheritance diagram for cl::sycl::id< dims >:
Public Member Functions | |
COMPUTECPP_CONSTEXPR_CPP14 | id () noexcept |
Initializes all values to zero. More... | |
constexpr | id (const base_t &other) noexcept |
Copy constructor from the base class. More... | |
template<class... indexesTs> | |
constexpr | id (size_t firstIndex, indexesTs... indexes) noexcept |
Initializes values per dimension. More... | |
COMPUTECPP_CONSTEXPR_CPP14 | id (const detail::index_array &other) noexcept |
Implicit conversion from an index_array. More... | |
COMPUTECPP_CONSTEXPR_CPP14 | id (const range< dims > &other) noexcept |
Implicit conversion from a range. More... | |
id (const detail::item_base &index) | |
Implicit conversion from an item_base. More... | |
COMPUTECPP_CONSTEXPR_CPP14 | operator detail::index_array () const noexcept |
Implicit conversion to an index_array. More... | |
Detailed Description
template<int dims = 1>
class cl::sycl::id< dims >
dims-dimensional index
- Note
- SYCL only supports dims to be 1, 2, or 3. Using a higher dimension is a Codeplay extension.
- Template Parameters
-
dims Number of index dimensions
Constructor & Destructor Documentation
◆ id() [1/6]
template<int dims = 1>
|
inlinenoexcept |
◆ id() [2/6]
template<int dims = 1>
|
inlinenoexcept |
◆ id() [3/6]
template<int dims = 1>
template<class... indexesTs>
|
inlinenoexcept |
Initializes values per dimension.
All values must be specified.
- Template Parameters
-
indexesTs Indexes are passed as a parameter pack to allow for any dimension
- Parameters
-
firstIndex Value for first dimension (minimum dimension is 1) indexes Values for second and further dimensions
◆ id() [4/6]
template<int dims = 1>
|
inlinenoexcept |
◆ id() [5/6]
template<int dims>
|
noexcept |
◆ id() [6/6]
template<int dims = 1>
|
inline |
Member Function Documentation
◆ operator detail::index_array()
template<int dims = 1>
|
inlinenoexcept |
The documentation for this class was generated from the following files: