class region

Declaration

template <int Dims>
class region { /* full declaration omitted */ };

Description

An arbitrary-dimensional set of points described by a normalized tiling of boxes.

Declared at: include/grid.h:225

Template Parameters

int Dims

Member Variables

static const int dimensions = Dims

box_vector m_boxes

Member Aliases

• using box = detail::box<Dims>;
• using box_vector = detail::box_vector<Dims>;

Member Function Overview

• empty() const → bool
• get_area() const → size_t
• get_boxes() const & → const box_vector &
• get_effective_dims() const → int
• into_boxes() && → box_vector
• region()
• region(const box & single_box)
• region(const subrange<Dims> & single_sr)
• region(box_vector && boxes) → explicit
• region(grid_detail::normalized_t, box_vector && boxes)

Friend Function Overview

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

Member Functions

¶bool empty() const

Declared at: include/grid.h:242

---

¶size_t get_area() const

Description

Counts the number of points covered by the region.

Declared at: include/grid.h:245

---

¶const box_vector& get_boxes() const&

Declared at: include/grid.h:238

---

¶int get_effective_dims() const

Description

Returns the smallest dimensionality that *this can be region_cast to.

Declared at: include/grid.h:250

---

¶box_vector into_boxes() &&

Declared at: include/grid.h:240

---

¶region()

Declared at: include/grid.h:231

---

¶region(const box& single_box)

Declared at: include/grid.h:232

Parameters

const box& single_box

---

¶region(const subrange<Dims>& single_sr)

Declared at: include/grid.h:233

Parameters

const subrange<Dims>& single_sr

---

¶explicit region(box_vector&& boxes)

Description

Constructs a region by normalizing an arbitrary, potentially-overlapping tiling of boxes.

Declared at: include/grid.h:236

Parameters

box_vector&& boxes

---

¶region(grid_detail::normalized_t,
       box_vector&& boxes)

Declared at: include/grid.h:261

Parameters

grid_detail::normalized_t

box_vector&& boxes

---

Friend Functions

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

Declared at: include/grid.h:253

Parameters

const region<Dims>& lhs

const region<Dims>& rhs

---

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

Declared at: include/grid.h:252

Parameters

const region<Dims>& lhs

const region<Dims>& rhs

---