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

Region specification connecting RegionCoords with an extent. More...

#include <Region.h>

Public Types
using	RegionCoords_t = RegionCoords< NumDimensions >
using	region_extent_t = uint16_t

Public Member Functions
	RegionSpec (const RegionCoords_t &coords, const region_extent_t extent)
	Constructor using RegionCoords and the extent. More...
	RegionSpec (region_index_t index, const region_extent_t extent)
	Constructor using a region index and an extent. More...
constexpr region_index_t	index () const
	Returns the region index. More...
constexpr const RegionCoords_t &	coords () const
	Returns the RegionCoords. More...
constexpr region_extent_t	extent () const
	Returns the extent. More...
constexpr region_coord_t	operator[] (const region_index_t index) const
	Returns the RegionCoords for a given region index. More...
constexpr bool	operator== (const Self_t &other) const
constexpr bool	operator!= (const Self_t &other) const
dim_t	relevant_dim () const
	Returns the highest dimension with region values != 1. More...
dim_t	level () const
	returns the number of coordinates unequal the center (1) for all dimensions More...

Static Public Member Functions
template<typename StencilT >
static region_index_t	index (const StencilT &stencil)
	Returns the region index for a given StencilPoint. More...

Detailed Description

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

Region specification connecting RegionCoords with an extent.

The region extent applies to all dimensions.

Definition at line 294 of file Region.h.

Constructor & Destructor Documentation

RegionSpec() [1/2]

template<dim_t NumDimensions>

dash::halo::RegionSpec< NumDimensions >::RegionSpec ( const RegionCoords_t &  coords, const region_extent_t  extent  )

inline

Constructor using RegionCoords and the extent.

Definition at line 306 of file Region.h.

  : _coords(coords), _index(coords.index()), _extent(extent),
    _rel_dim(RegionCoords_t::relevant_dim(coords.values())),
    _level(RegionCoords_t::level(coords.values())) {}

RegionSpec() [2/2]

template<dim_t NumDimensions>

dash::halo::RegionSpec< NumDimensions >::RegionSpec ( region_index_t  index, const region_extent_t  extent  )

inline

Constructor using a region index and an extent.

Definition at line 314 of file Region.h.

  : _coords(RegionCoords_t(index)), _index(index), _extent(extent),
    _rel_dim(RegionCoords_t::relevant_dim(_coords.values())),
    _level(RegionCoords_t::level(_coords.values())) {}

Member Function Documentation

coords()

template<dim_t NumDimensions>

constexpr const RegionCoords_t& dash::halo::RegionSpec< NumDimensions >::coords ( ) const

inline

Returns the RegionCoords.

Definition at line 354 of file Region.h.

{ return _coords; }

extent()

template<dim_t NumDimensions>

constexpr region_extent_t dash::halo::RegionSpec< NumDimensions >::extent ( ) const

inline

Returns the extent.

Definition at line 359 of file Region.h.

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

{ return _extent; }

index() [1/2]

template<dim_t NumDimensions>

template<typename StencilT >

static region_index_t dash::halo::RegionSpec< NumDimensions >::index ( const StencilT &  stencil )

inlinestatic

Returns the region index for a given StencilPoint.

Definition at line 328 of file Region.h.

References dash::index().

                                                       {
    region_index_t index = 0;
    if(stencil[0] == 0)
      index = 1;
    else if(stencil[0] > 0)
      index = 2;
    for(auto d(1); d < NumDimensions; ++d) {
      if(stencil[d] < 0)
        index *= REGION_INDEX_BASE;
      else if(stencil[d] == 0)
        index = 1 + index * REGION_INDEX_BASE;
      else
        index = 2 + index * REGION_INDEX_BASE;
    }

    return index;
  }

index() [2/2]

template<dim_t NumDimensions>

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

inline

Returns the region index.

Definition at line 349 of file Region.h.

{ return _index; }

level()

template<dim_t NumDimensions>

dim_t dash::halo::RegionSpec< NumDimensions >::level ( ) const

inline

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

Definition at line 385 of file Region.h.

References dash::halo::RegionSpec< NumDimensions >::extent().

{ return _level; }

operator[]()

template<dim_t NumDimensions>

constexpr region_coord_t dash::halo::RegionSpec< NumDimensions >::operator[] ( const region_index_t  index ) const

inline

Returns the RegionCoords for a given region index.

Definition at line 364 of file Region.h.

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

                                                                        {
    return _coords[index];
  }

relevant_dim()

template<dim_t NumDimensions>

dim_t dash::halo::RegionSpec< NumDimensions >::relevant_dim ( ) const

inline

Returns the highest dimension with region values != 1.

Definition at line 379 of file Region.h.

{ return _rel_dim; }

---

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

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