dash::Dimensional< ElementType, NumDimensions > Class Template Reference

Base class for dimensional attributes, stores an n-dimensional value with identical type all dimensions. More...

#include <Dimensional.h>

Public Member Functions
template<typename ... Values>
constexpr	Dimensional (ElementType &value, Values ... values)
	Constructor, expects one value for every dimension. More...
constexpr	Dimensional (std::array< ElementType, NumDimensions > values)
	Constructor, expects array containing values for every dimension. More...
constexpr	Dimensional (const self_t &other)=default
self_t &	operator= (const self_t &other)=default
constexpr const std::array< ElementType, NumDimensions > &	values () const
	Return value with all dimensions as array of NumDimensions elements. More...
ElementType	dim (dim_t dimension) const
	The value in the given dimension. More...
constexpr ElementType	operator[] (size_t dimension) const
	Subscript operator, access to value in dimension given by index. More...
ElementType &	operator[] (size_t dimension)
	Subscript assignment operator, access to value in dimension given by index. More...
constexpr bool	operator== (const self_t &other) const
	Equality comparison operator. More...
constexpr bool	operator!= (const self_t &other) const
	Equality comparison operator. More...
constexpr dim_t	rank () const
	The number of dimensions of the value. More...

Static Public Member Functions
static constexpr dim_t	ndim ()
	The number of dimensions of the value. More...

Friends
template<typename E_ , dim_t ND_>
std::ostream &	operator<< (std::ostream &os, const Dimensional< E_, ND_ > &dimensional)

Detailed Description

template<typename ElementType, dim_t NumDimensions>
class dash::Dimensional< ElementType, NumDimensions >

Base class for dimensional attributes, stores an n-dimensional value with identical type all dimensions.

Different from a SizeSpec or cartesian space, a Dimensional does not define metric/scalar extents or a size, but just a vector of possibly non-scalar attributes.

Template Parameters

ElementType	The type of the contained values
NumDimensions	The number of dimensions

See also

SizeSpec

CartesianIndexSpace

Definition at line 101 of file Dimensional.h.

Constructor & Destructor Documentation

Dimensional() [1/2]

template<typename ElementType, dim_t NumDimensions>

template<typename ... Values>

constexpr dash::Dimensional< ElementType, NumDimensions >::Dimensional ( ElementType &  value, Values ...  values  )

inline

Constructor, expects one value for every dimension.

Definition at line 119 of file Dimensional.h.

  : _values {{ value, (ElementType)values... }} {
    static_assert(
      sizeof...(values) == NumDimensions-1,
      "Invalid number of arguments");
  }

Dimensional() [2/2]

template<typename ElementType, dim_t NumDimensions>

constexpr dash::Dimensional< ElementType, NumDimensions >::Dimensional ( std::array< ElementType, NumDimensions >  values )

inline

Constructor, expects array containing values for every dimension.

Definition at line 130 of file Dimensional.h.

    : _values(std::move(values))
  {
  }

Member Function Documentation

dim()

template<typename ElementType, dim_t NumDimensions>

ElementType dash::Dimensional< ElementType, NumDimensions >::dim ( dim_t  dimension ) const

inline

The value in the given dimension.

Parameters

dimension

The dimension

Returns

The value in the given dimension

Definition at line 152 of file Dimensional.h.

Referenced by dash::ViewSpec< NumDimensions, int >::set_rank().

                                         {
    DASH_ASSERT_LT(
      dimension, NumDimensions,
      "Dimension for Dimensional::extent() must be lower than " <<
      NumDimensions);
    return _values[dimension];
  }

ndim()

template<typename ElementType, dim_t NumDimensions>

static constexpr dim_t dash::Dimensional< ElementType, NumDimensions >::ndim ( )

inlinestatic

The number of dimensions of the value.

Definition at line 207 of file Dimensional.h.

Referenced by dash::ViewSpec< NumDimensions, int >::ViewSpec().

                                {
    return NumDimensions;
  }

operator!=()

template<typename ElementType, dim_t NumDimensions>

constexpr bool dash::Dimensional< ElementType, NumDimensions >::operator!= ( const self_t &  other ) const

inline

Equality comparison operator.

Definition at line 193 of file Dimensional.h.

                                                        {
    return !(*this == other);
  }

operator==()

template<typename ElementType, dim_t NumDimensions>

constexpr bool dash::Dimensional< ElementType, NumDimensions >::operator== ( const self_t &  other ) const

inline

Equality comparison operator.

Definition at line 186 of file Dimensional.h.

                                                        {
    return this == &other || _values == other._values;
  }

operator[]() [1/2]

template<typename ElementType, dim_t NumDimensions>

constexpr ElementType dash::Dimensional< ElementType, NumDimensions >::operator[] ( size_t  dimension ) const

inline

Subscript operator, access to value in dimension given by index.

Alias for dim.

Parameters

dimension

The dimension

Returns

The value in the given dimension

Definition at line 167 of file Dimensional.h.

                                                           {
    return _values[dimension];
  }

operator[]() [2/2]

template<typename ElementType, dim_t NumDimensions>

ElementType& dash::Dimensional< ElementType, NumDimensions >::operator[] ( size_t  dimension )

inline

Subscript assignment operator, access to value in dimension given by index.

Alias for dim.

Parameters

dimension

The dimension

Returns

A reference to the value in the given dimension

Definition at line 179 of file Dimensional.h.

                                             {
    return _values[dimension];
  }

rank()

template<typename ElementType, dim_t NumDimensions>

constexpr dim_t dash::Dimensional< ElementType, NumDimensions >::rank ( ) const

inline

The number of dimensions of the value.

Definition at line 200 of file Dimensional.h.

                               {
    return NumDimensions;
  }

values()

template<typename ElementType, dim_t NumDimensions>

constexpr const std::array<ElementType, NumDimensions>& dash::Dimensional< ElementType, NumDimensions >::values ( ) const

inline

Return value with all dimensions as array of NumDimensions elements.

Definition at line 142 of file Dimensional.h.

Referenced by dash::Dimensional< Distribution, NumDimensions >::Dimensional(), and dash::TilePattern< NumDimensions, Arrangement, IndexType >::underfilled_blocksize().

                                                                        {
    return _values;
  }

---

The documentation for this class was generated from the following file:

• /tmp/tmporruphar/dash/include/dash/Dimensional.h