dash::halo::GlobalBoundarySpec< NumDimensions > Class Template Reference

Global boundary property specification for every dimension. More...

#include <Halo.h>

Public Member Functions
	GlobalBoundarySpec ()
	Default constructor. More...
template<typename... Values>
constexpr	GlobalBoundarySpec (BoundaryProp value, Values... values)
	Constructor to define custom BoundaryProp values. More...
constexpr const std::array< BoundaryProp, NumDimensions > &	values () const
	Return value with all dimensions as array of NumDimensions elements. More...
BoundaryProp	dim (dim_t dimension) const
	The value in the given dimension. More...
constexpr BoundaryProp	operator[] (size_t dimension) const
	Subscript operator, access to value in dimension given by index. More...
BoundaryProp &	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...

Detailed Description

template<dim_t NumDimensions>
class dash::halo::GlobalBoundarySpec< NumDimensions >

Global boundary property specification for every dimension.

Definition at line 23 of file Halo.h.

Constructor & Destructor Documentation

GlobalBoundarySpec() [1/2]

template<dim_t NumDimensions>

dash::halo::GlobalBoundarySpec< NumDimensions >::GlobalBoundarySpec ( )

inline

Default constructor.

All BoundaryProp = BoundaryProp::NONE

Definition at line 34 of file Halo.h.

                       {
    for(dim_t i = 0; i < NumDimensions; ++i) {
      this->_values[i] = BoundaryProp::NONE;
    }
  }

GlobalBoundarySpec() [2/2]

template<dim_t NumDimensions>

template<typename... Values>

constexpr dash::halo::GlobalBoundarySpec< NumDimensions >::GlobalBoundarySpec ( BoundaryProp  value, Values...  values  )

inline

Constructor to define custom BoundaryProp values.

Definition at line 43 of file Halo.h.

  : Base_t::Dimensional(value, values...) {}

Member Function Documentation

dim()

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

inlineinherited

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.

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

ndim()

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

inlinestaticinherited

The number of dimensions of the value.

Definition at line 207 of file Dimensional.h.

                                {
    return NumDimensions;
  }

operator!=()

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

inlineinherited

Equality comparison operator.

Definition at line 193 of file Dimensional.h.

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

operator==()

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

inlineinherited

Equality comparison operator.

Definition at line 186 of file Dimensional.h.

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

operator[]() [1/2]

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

inlineinherited

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]

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

inlineinherited

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()

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

inlineinherited

The number of dimensions of the value.

Definition at line 200 of file Dimensional.h.

                               {
    return NumDimensions;
  }

values()

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

inlineinherited

Return value with all dimensions as array of NumDimensions elements.

Definition at line 142 of file Dimensional.h.

                                                                        {
    return _values;
  }

---

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

• /tmp/tmporruphar/dash/include/dash/halo/Halo.h