Template Struct MultidimSpace

• Defined in File multidim_space.hpp

Struct Documentation

template<typename Impl>
struct ripple::MultidimSpace

The MultidimSpace defines an interface for classes when define a multidimensional space.

Template Parameters

• Impl: The implementation of the interface.

Public Functions

constexpr auto padding() noexcept -> size_t&

Gets a reference to the amount of padding for each side of each dimension in the space.

Return

A reference to the amount of padding for a side of the dimension.

constexpr auto padding() const noexcept -> size_t

Gets the amount of padding for each side of each dimension in the space.

Return

The amount of padding per side of the size.

constexpr auto dim_padding() const noexcept -> size_t

Gets the total amount of padding for each dimension, which is the sum of the padding on each side of the dimension.

Return

The amount of padding per dimension.

constexpr auto dimensions() const noexcept -> size_t

Gets the number of dimensions in the space.

Return

The number of dimensions in the space.

template<typename Dim>
constexpr auto size(Dim &&dim) const noexcept -> size_t

Gets the size of the given dimension, including the padding.

Return

The total number of elements in the dimension, including padding.

Parameters

• dim: The dimension to get the size of.

Template Parameters

• Dim: The type of the dimension.

constexpr auto size() const noexcept -> size_t

Gets the total size of the N dimensional space i.e the total number of elements in the space, including the padding for each of the dimensions.

Return

The total number of elements in the space, including padding elements.

template<typename Dim>
constexpr auto internal_size(Dim &&dim) const noexcept -> size_t

Gets the size of the given dimension, excluding padded elements.

Return

The number of elements in the dimension, excluding padding elements.

Parameters

• dim: The dimension to get the size oAf.

Template Parameters

• Dim: The type of the dimension.

constexpr auto internal_size() const noexcept -> size_t

Gets the total internal size of the N dimensional space i.e the total number of elements in the space, exluding any padding elements.

template<typename Dim>
constexpr auto step(Dim &&dim) const noexcept -> size_t

Gets the step size to from one element in given dimension to the next element in the same dimension.

Return

The step size between successive elements in the same dimension.

Parameters

• dim: The dimension to get the step size in.

Template Parameters

• Dim: The type of the dimension.