class nd_range

Declaration

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

Declared at: include/ranges.h:354

Template Parameters

int Dims = 1

Member Variables

range<Dims> m_global_range

range<Dims> m_local_range

id<Dims> m_offset

Member Function Overview

• get_global_range() const → const range<Dims> &
• get_group_range() const → const range<Dims> &
• get_local_range() const → const range<Dims> &
• get_offset() const → const id<Dims> &
• nd_range(const range<Dims> & global_range, const range<Dims> & local_range, const id<Dims> & offset = {})
• template <int D = Dims, typename = std::enable_if_t<D == 0>>
  nd_range() noexcept → constexpr
• template <int D = Dims, typename = std::enable_if_t<D >= 1 && D <= 3>>
  nd_range(const sycl::nd_range<Dims> & s_range)
• template <int D = Dims, typename = std::enable_if_t<D >= 1 && D <= 3>>
  operator nd_range<Dimensions>() const

Friend Function Overview

• operator!=(const nd_range<Dims> & lhs, const nd_range<Dims> & rhs) → friend bool
• operator==(const nd_range<Dims> & lhs, const nd_range<Dims> & rhs) → friend bool

Member Functions

¶const range<Dims>& get_global_range() const

Declared at: include/ranges.h:382

---

¶const range<Dims>& get_group_range() const

Declared at: include/ranges.h:384

---

¶const range<Dims>& get_local_range() const

Declared at: include/ranges.h:383

---

¶const id<Dims>& get_offset() const

Declared at: include/ranges.h:385

---

¶nd_range(const range<Dims>& global_range,
         const range<Dims>& local_range,
         const id<Dims>& offset = {})

Declared at: include/ranges.h:366

Parameters

const range<Dims>& global_range

const range<Dims>& local_range

const id<Dims>& offset = {}

---

¶template <int D = Dims,
          typename = std::enable_if_t<D == 0>>
constexpr nd_range() noexcept

Declared at: include/ranges.h:357

Template Parameters

int D = Dims

= std::enable_if_t<D == 0>

---

¶template <
    int D = Dims,
    typename = std::enable_if_t<D >= 1 && D <= 3>>
nd_range(const sycl::nd_range<Dims>& s_range)

Declared at: include/ranges.h:362

Template Parameters

int D = Dims

= std::enable_if_t<D >= 1 && D <= 3>

Parameters

const sycl::nd_range<Dims>& s_range

---

¶template <
    int D = Dims,
    typename = std::enable_if_t<D >= 1 && D <= 3>>
operator nd_range<Dimensions>() const

Declared at: include/ranges.h:378

Template Parameters

int D = Dims

= std::enable_if_t<D >= 1 && D <= 3>

---

Friend Functions

¶friend bool operator!=(const nd_range<Dims>& lhs,
                       const nd_range<Dims>& rhs)

Declared at: include/ranges.h:391

Parameters

const nd_range<Dims>& lhs

const nd_range<Dims>& rhs

---

¶friend bool operator==(const nd_range<Dims>& lhs,
                       const nd_range<Dims>& rhs)

Declared at: include/ranges.h:387

Parameters

const nd_range<Dims>& lhs

const nd_range<Dims>& rhs

---