Index manager for a container of data arranged on a >=2-dim grid. More...
#include <GridContainerIndices.h>
Public Member Functions | |
Grid structure | |
bool | hasY (typename Base_t::CellDimIndex_t index) const |
Returns whether the specified y index is valid. More... | |
size_t | sizeY () const |
Returns the number of cells on the y axis of the grid. More... | |
Public Member Functions inherited from util::GridContainerIndicesBase1D< DIMS > | |
bool | hasX (typename Base_t::CellDimIndex_t index) const |
Returns whether the specified x index is valid. More... | |
size_t | sizeX () const |
Returns the number of cells on the x axis of the grid. More... | |
Public Member Functions inherited from util::details::GridContainerIndicesBase< DIMS > | |
GridContainerIndicesBase (std::array< size_t, dims()> const &new_dims) | |
Constructor: specifies the size of the container and allocates it. More... | |
bool | has (CellIndexOffset_t index) const |
Returns whether the specified index is valid. More... | |
size_t | size () const |
Returns the number of cells in the grid. More... | |
CellIndex_t | operator[] (CellID_t id) const |
Returns the index of the element from its cell coordinates (no check!) More... | |
CellIndexOffset_t | offset (CellID_t const &origin, CellID_t const &cellID) const |
Returns the difference in index of cellID respect to origin. More... | |
Private Types | |
using | Base_t = GridContainerIndicesBase1D< DIMS > |
Additional Inherited Members | |
Public Types inherited from util::details::GridContainerIndicesBase< DIMS > | |
using | CellIndex_t = typename IndexManager_t::LinIndex_t |
type of index for direct access to the cell More... | |
using | CellIndexOffset_t = std::ptrdiff_t |
type of difference between indices More... | |
using | CellDimIndex_t = CellIndexOffset_t |
type of difference between indices along a dimension More... | |
using | CellID_t = std::array< CellDimIndex_t, dims()> |
type of cell coordinate (x, y, z) More... | |
Static Public Member Functions inherited from util::details::GridContainerIndicesBase< DIMS > | |
static constexpr unsigned int | dims () |
Returns the number of dimensions in this object. More... | |
Protected Member Functions inherited from util::details::GridContainerIndicesBase< DIMS > | |
CellIndex_t | index (CellID_t id) const |
Returns the index of the element from its cell coordinates (no check!) More... | |
Protected Attributes inherited from util::details::GridContainerIndicesBase< DIMS > | |
IndexManager_t | indices |
the actual worker More... | |
Index manager for a container of data arranged on a >=2-dim grid.
Definition at line 128 of file GridContainerIndices.h.
|
private |
Definition at line 132 of file GridContainerIndices.h.
|
inline |
Returns whether the specified y index is valid.
Definition at line 142 of file GridContainerIndices.h.
|
inline |
Returns the number of cells on the y axis of the grid.
Definition at line 146 of file GridContainerIndices.h.