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

N-Dimensional region coordinates and associated indices for all possible Halo/Boundary regions of a HaloBlock. More...

#include <Region.h>

Public Types
using	Coords_t = std::array< uint8_t, NumDimensions >
using	CoordsVec_t = std::vector< Self_t >
using	RegIndDepVec_t = std::vector< region_index_t >
using	RegIndexDim_t = std::pair< region_index_t, region_index_t >

Public Member Functions
	RegionCoords ()
	Default Constructor. More...
template<typename... Values>
	RegionCoords (region_coord_t value, Values... values)
	Constructor allows custom coordinate values and calculates the fitting region index. More...
	RegionCoords (region_index_t index)
	Constructor takes a region index to set up the region coordinates. More...
constexpr region_index_t	index () const
dim_t	level ()
	returns the number of coordinates unequal to the center (1) for all dimensions More...
constexpr bool	operator== (const Self_t &other) const
constexpr bool	operator!= (const Self_t &other) const
constexpr const std::array< region_coord_t, NumDimensions > &	values () const
	Return value with all dimensions as array of NumDimensions elements. More...
region_coord_t	dim (dim_t dimension) const
	The value in the given dimension. More...
constexpr region_coord_t	operator[] (size_t dimension) const
	Subscript operator, access to value in dimension given by index. More...
region_coord_t &	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 region_index_t	center_index ()
static Coords_t	center_coords ()
static constexpr RegIndexDim_t	index (dim_t dim)
	Returns a region index for a given dimension and RegionPos. More...
static constexpr region_index_t	index (dim_t dim, RegionPos pos)
	Returns a region index for a given dimension and RegionPos. More...
template<typename StencilPointT >
static constexpr region_index_t	index (const StencilPointT &stencil)
	Returns a region index for a given dimension and RegionPos. More...
static region_index_t	index (const Coords_t &coords)
	Returns the region index for a given RegionCoords. More...
static Coords_t	coords (const region_index_t index)
static dim_t	relevant_dim (const Coords_t &coords)
	Returns the highest dimension with region values != 1. More...
static dim_t	level (const Coords_t &coords)
	auto max = stencil.max(); level = 0 -> center (1,1) level = 1 -> main regions (e.g. More...
static RegIndDepVec_t	boundary_dependencies (region_index_t index)
static constexpr dim_t	ndim ()
	The number of dimensions of the value. More...

Detailed Description

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

N-Dimensional region coordinates and associated indices for all possible Halo/Boundary regions of a HaloBlock.

The center (all values = 1) is the local NArray memory block used by the HaloBlock.

Example for 2-D

.----—..----—..----—. | 0 || 1 || 2 <-|– region index | (0,0) || (0,1) || (0,2)<|– region coordinates | NW || N || NE <|– north east (only for explanation) '----—''----—''----—' .----—..----—..----—. | 3 || 4 || 5 | | (1,0) || (1,1) || (1,2) | | W || C || E | '----—''----—''----—' .----—..----—..----—. | 6 || 7 || 8 | | (2,0) || (2,1) || (2,2) | | SW || S || SE | '----—''----—''----—'

Definition at line 40 of file Region.h.

Constructor & Destructor Documentation

RegionCoords() [1/3]

template<dim_t NumDimensions>

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

inline

Default Constructor.

All region coordinate values are 1 and pointing to the center.

Definition at line 61 of file Region.h.

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

RegionCoords() [2/3]

template<dim_t NumDimensions>

template<typename... Values>

dash::halo::RegionCoords< NumDimensions >::RegionCoords ( region_coord_t  value, Values...  values  )

inline

Constructor allows custom coordinate values and calculates the fitting region index.

Definition at line 72 of file Region.h.

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

RegionCoords() [3/3]

template<dim_t NumDimensions>

dash::halo::RegionCoords< NumDimensions >::RegionCoords ( region_index_t  index )

inline

Constructor takes a region index to set up the region coordinates.

Definition at line 79 of file Region.h.

                                     {
    this->_values = Self_t::coords(index);
  }

Member Function Documentation

coords()

template<dim_t NumDimensions>

static Coords_t dash::halo::RegionCoords< NumDimensions >::coords ( const region_index_t  index )

inlinestatic

Parameters

index

region index

Returns

region coordinates

Definition at line 181 of file Region.h.

References dash::index().

                                                     {
    Coords_t       coords{};
    region_index_t index_tmp =index;
    for(auto i = (NumDimensions - 1); i >= 1; --i) {
      auto res  = std::div(static_cast<long>(index_tmp), static_cast<long>(REGION_INDEX_BASE));
      coords[i] = res.rem;
      index_tmp = res.quot;
    }
    coords[0] = index_tmp;

    return coords;
  }

dim()

region_coord_t dash::Dimensional< region_coord_t , 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];
  }

index() [1/5]

template<dim_t NumDimensions>

constexpr region_index_t dash::halo::RegionCoords< NumDimensions >::index ( ) const

inline

Returns

region index

Definition at line 97 of file Region.h.

References dash::halo::RegionCoords< NumDimensions >::index().

Referenced by dash::halo::RegionCoords< NumDimensions >::index(), and dash::halo::RegionSpec< NumDimensions >::operator[]().

{ return index(this->_values); }

index() [2/5]

template<dim_t NumDimensions>

static constexpr RegIndexDim_t dash::halo::RegionCoords< NumDimensions >::index ( dim_t  dim )

inlinestatic

Returns a region index for a given dimension and RegionPos.

Definition at line 102 of file Region.h.

                                                  {
    RegIndexDim_t index_dim = std::make_pair(0,0);

    for(dim_t d = 0; d < NumDimensions; ++d)
      if(dim == d) {
        index_dim.first = index_dim.first * REGION_INDEX_BASE;
        index_dim.second = 2 + index_dim.second * REGION_INDEX_BASE;
      }
      else {
        index_dim.first = 1 + index_dim.first * REGION_INDEX_BASE;
        index_dim.second = 1 + index_dim.second * REGION_INDEX_BASE;
      }

    return index_dim;
  }

index() [3/5]

template<dim_t NumDimensions>

static constexpr region_index_t dash::halo::RegionCoords< NumDimensions >::index ( dim_t  dim, RegionPos  pos  )

inlinestatic

Returns a region index for a given dimension and RegionPos.

Definition at line 121 of file Region.h.

                                                                  {
    region_coord_t coord = (pos == RegionPos::PRE) ? 0 : 2;

    region_index_t index = 0;
    for(dim_t d = 0; d < NumDimensions; ++d)
      if(dim == d)
        index = coord + index * REGION_INDEX_BASE;
      else
        index = 1 + index * REGION_INDEX_BASE;

    return index;
  }

index() [4/5]

template<dim_t NumDimensions>

template<typename StencilPointT >

static constexpr region_index_t dash::halo::RegionCoords< NumDimensions >::index ( const StencilPointT &  stencil )

inlinestatic

Returns a region index for a given dimension and RegionPos.

Definition at line 138 of file Region.h.

References dash::index().

                                                                      {
    region_index_t index = 0;
    for(dim_t d = 0; d < NumDimensions; ++d) {
      if(stencil[d] < 0) {
        index *= REGION_INDEX_BASE;
        continue;
      }

      if(stencil[d] > 0) {
        index = 2 + index * REGION_INDEX_BASE;
        continue;
      }

      index = 1 + index * REGION_INDEX_BASE;
    }

    return index;
  }

index() [5/5]

template<dim_t NumDimensions>

static region_index_t dash::halo::RegionCoords< NumDimensions >::index ( const Coords_t &  coords )

inlinestatic

Returns the region index for a given RegionCoords.

Returns

region index

Definition at line 162 of file Region.h.

References dash::index().

                                                      {
    region_index_t index = coords[0];
    for(dim_t d = 1; d < NumDimensions; ++d) {
      // in case a wrong region coordinate was set
      if(coords[d] > 2) {
        index = coords[d] + index * REGION_INDEX_BASE;
      } else {
        index = coords[d] + index * REGION_INDEX_BASE;
      }
    }

    return index;
  }

level() [1/2]

template<dim_t NumDimensions>

static dim_t dash::halo::RegionCoords< NumDimensions >::level ( const Coords_t &  coords )

inlinestatic

auto max = stencil.max(); level = 0 -> center (1,1) level = 1 -> main regions (e.g.

2D: (0,1) (2,1) (1,0) (1,2) level = 2 e.g. 2D corner regions or 3D edge regions ... for dimensions higher than 2D relevant

Definition at line 213 of file Region.h.

                                             {
    dim_t level = 0;
    for(auto d = 0; d < NumDimensions; ++d) {
      if(coords[d] != 1)
        ++level;
    }
    return level;
  }

level() [2/2]

template<dim_t NumDimensions>

dim_t dash::halo::RegionCoords< NumDimensions >::level ( )

inline

returns the number of coordinates unequal to the center (1) for all dimensions

level = 0 -> center (1,1) level = 1 -> main regions (e.g. 2D: (0,1) (2,1) (1,0) (1,2) level = 2 e.g. 2D corner regions or 3D edge regions ... for dimensions higher than 2D relevant

Definition at line 231 of file Region.h.

References dash::index(), and dash::halo::RegionCoords< NumDimensions >::level().

Referenced by dash::halo::RegionCoords< NumDimensions >::level().

{ return level(this->_values); }

ndim()

static constexpr dim_t dash::Dimensional< region_coord_t , 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< region_coord_t , 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< region_coord_t , 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 region_coord_t dash::Dimensional< region_coord_t , 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]

region_coord_t & dash::Dimensional< region_coord_t , 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< region_coord_t , NumDimensions >::rank ( ) const

inlineinherited

The number of dimensions of the value.

Definition at line 200 of file Dimensional.h.

                               {
    return NumDimensions;
  }

relevant_dim()

template<dim_t NumDimensions>

static dim_t dash::halo::RegionCoords< NumDimensions >::relevant_dim ( const Coords_t &  coords )

inlinestatic

Returns the highest dimension with region values != 1.

Definition at line 197 of file Region.h.

                                                    {
    dim_t dim = 1;
    for(auto d = 1; d < NumDimensions; ++d) {
      if(coords[d] != 1)
        dim = d + 1;
    }

    return dim;
  }

values()

constexpr const std::array<region_coord_t , NumDimensions>& dash::Dimensional< region_coord_t , 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/Region.h