Template Class grid3D

Defined in File grid3D.hpp

Inheritance Relationships

Base Type

public rcppsw::ds::base_grid3D< T > (Template Class base_grid3D)

Class Documentation

template<typename T> class grid3D : public rcppsw::ds::base_grid3D<T>

A 3D grid of SOMETHING. Mainly a convenience wrapper around boost::multi_array.

Public Functions

inline explicit grid3D(const coord_type &dims)

inline grid3D(size_t x_max, size_t y_max, size_t z_max)

inline virtual T &access(size_t i, size_t j, size_t k) override

Return a reference to the element at position (i, j) in the grid.

This is provided in the base class so that the pointer/object variants of the grid (grid3D, etc.) can reduce code duplication.

inline virtual size_t xsize(void) const override: Get the size of the X dimension of the grid (i.e. what is the array index in X?)

inline virtual size_t ysize(void) const override: Get the size of the Y dimension of the grid (i.e. what is the array index in Y?)

inline virtual size_t zsize(void) const override: Get the size of the Z dimension of the grid (i.e. what is the array index in Z?)