class nd_item

Declaration

template <int Dims = 1>
class nd_item { /* full declaration omitted */ };

Declared at: include/item.h:190

Template Parameters

int Dims = 1

Member Variables

sycl::nd_item<sycl_dims> m_sycl_item

id<Dims> m_global_id

id<Dims> m_global_offset

range<Dims> m_global_range

id<Dims> m_group_id

range<Dims> m_group_range

static const int sycl_dims = std::max(1, Dims)

Member Function Overview

• template <typename T>
  async_work_group_copy(decorated_global_ptr<T> dest, decorated_local_ptr<T> src, size_t num_elements) const → sycl::device_event
• template <typename T>
  async_work_group_copy(decorated_local_ptr<T> dest, decorated_global_ptr<T> src, size_t num_elements) const → sycl::device_event
• template <typename T>
  async_work_group_copy(decorated_local_ptr<T> dest, decorated_global_ptr<T> src, size_t num_elements, size_t src_stride) const → sycl::device_event
• template <typename T>
  async_work_group_copy(decorated_global_ptr<T> dest, decorated_local_ptr<T> src, size_t num_elements, size_t dest_stride) const → sycl::device_event
• get_global_id() const → id<Dims>
• get_global_id(int dimension) const → size_t
• get_global_linear_id() const → size_t
• get_global_range() const → range<Dims>
• get_global_range(int dimension) const → size_t
• get_group() const → group<Dims>
• get_group(int dimension) const → size_t
• get_group_linear_id() const → size_t
• get_group_range() const → range<Dims>
• get_group_range(int dimension) const → size_t
• get_local_id(int dimension) const → size_t
• get_local_id() const → id<Dims>
• get_local_linear_id() const → size_t
• get_local_range(int dimension) const → size_t
• get_local_range() const → range<Dims>
• get_nd_range() const → celerity::nd_range<Dims>
• get_offset() const → id<Dims>
• get_sub_group() const → sycl::sub_group
• nd_item()
• template <typename... DeviceEvents>
  wait_for(DeviceEvents... events) const → void
• nd_item(const sycl::nd_item<std::max(1, Dims)> & sycl_item, const range<Dims> & global_range, const id<Dims> & global_offset, const id<Dims> & chunk_offset, const range<Dims> & group_range, const id<Dims> & group_offset) → explicit

Member Functions

¶template <typename T>
sycl::device_event async_work_group_copy(
    decorated_global_ptr<T> dest,
    decorated_local_ptr<T> src,
    size_t num_elements) const

Declared at: include/item.h:236

Template Parameters

T

Parameters

decorated_global_ptr<T> dest

decorated_local_ptr<T> src

size_t num_elements

---

¶template <typename T>
sycl::device_event async_work_group_copy(
    decorated_local_ptr<T> dest,
    decorated_global_ptr<T> src,
    size_t num_elements) const

Declared at: include/item.h:231

Template Parameters

T

Parameters

decorated_local_ptr<T> dest

decorated_global_ptr<T> src

size_t num_elements

---

¶template <typename T>
sycl::device_event async_work_group_copy(
    decorated_local_ptr<T> dest,
    decorated_global_ptr<T> src,
    size_t num_elements,
    size_t src_stride) const

Declared at: include/item.h:241

Template Parameters

T

Parameters

decorated_local_ptr<T> dest

decorated_global_ptr<T> src

size_t num_elements

size_t src_stride

---

¶template <typename T>
sycl::device_event async_work_group_copy(
    decorated_global_ptr<T> dest,
    decorated_local_ptr<T> src,
    size_t num_elements,
    size_t dest_stride) const

Declared at: include/item.h:246

Template Parameters

T

Parameters

decorated_global_ptr<T> dest

decorated_local_ptr<T> src

size_t num_elements

size_t dest_stride

---

¶id<Dims> get_global_id() const

Declared at: include/item.h:194

---

¶size_t get_global_id(int dimension) const

Declared at: include/item.h:196

Parameters

int dimension

---

¶size_t get_global_linear_id() const

Declared at: include/item.h:198

---

¶range<Dims> get_global_range() const

Declared at: include/item.h:218

---

¶size_t get_global_range(int dimension) const

Declared at: include/item.h:220

Parameters

int dimension

---

¶group<Dims> get_group() const

Declared at: include/item.h:206

---

¶size_t get_group(int dimension) const

Declared at: include/item.h:208

Parameters

int dimension

---

¶size_t get_group_linear_id() const

Declared at: include/item.h:210

---

¶range<Dims> get_group_range() const

Declared at: include/item.h:212

---

¶size_t get_group_range(int dimension) const

Declared at: include/item.h:214

Parameters

int dimension

---

¶size_t get_local_id(int dimension) const

Declared at: include/item.h:202

Parameters

int dimension

---

¶id<Dims> get_local_id() const

Declared at: include/item.h:200

---

¶size_t get_local_linear_id() const

Declared at: include/item.h:204

---

¶size_t get_local_range(int dimension) const

Declared at: include/item.h:224

Parameters

int dimension

---

¶range<Dims> get_local_range() const

Declared at: include/item.h:222

---

¶celerity::nd_range<Dims> get_nd_range() const

Declared at: include/item.h:228

---

¶id<Dims> get_offset() const

Declared at: include/item.h:226

---

¶sycl::sub_group get_sub_group() const

Declared at: include/item.h:216

---

¶nd_item()

Declared at: include/item.h:192

---

¶template <typename... DeviceEvents>
void wait_for(DeviceEvents... events) const

Declared at: include/item.h:251

Template Parameters

DeviceEvents

Parameters

DeviceEvents... events

---

¶explicit nd_item(
    const sycl::nd_item<std::max(1, Dims)>&
        sycl_item,
    const range<Dims>& global_range,
    const id<Dims>& global_offset,
    const id<Dims>& chunk_offset,
    const range<Dims>& group_range,
    const id<Dims>& group_offset)

Declared at: include/item.h:275

Parameters

const sycl::nd_item<std::max(1, Dims)>& sycl_item

const range<Dims>& global_range

const id<Dims>& global_offset

const id<Dims>& chunk_offset

const range<Dims>& group_range

const id<Dims>& group_offset

---