dash::halo::HaloMemory< HaloBlockT > Class Template Reference

Mangages the memory for all halo regions provided by the given HaloBlock. More...

#include <HaloMemory.h>

Public Types
using	Element_t = typename HaloBlockT::Element_t
using	ElementCoords_t = std::array< typename Pattern_t::index_type, NumDimensions >
using	HaloBuffer_t = std::vector< Element_t >
using	pattern_size_t = typename Pattern_t::size_type
using	iterator = typename HaloBuffer_t::iterator
using	const_iterator = const iterator
using	MemRange_t = std::pair< iterator, iterator >

Public Member Functions
	HaloMemory (const HaloBlockT &haloblock)
	Constructor. More...
iterator	first_element_at (region_index_t index)
	Iterator to the first halo element for the given region index. More...
MemRange_t	range_at (region_index_t index)
	Returns the range of all halo elements for the given region index. More...
iterator	begin ()
	Returns an iterator to the first halo element. More...
const_iterator	begin () const
	Returns a const iterator to the first halo element. More...
iterator	end ()
	Returns an iterator to the end of the halo elements. More...
const_iterator	end () const
	Returns a const iterator to the end of the halo elements. More...
const HaloBuffer_t &	buffer () const
	Container storing all halo elements. More...
bool	to_halo_mem_coords_check (const region_index_t region_index, ElementCoords_t &coords) const
	Converts coordinates to halo memory coordinates for a given region index and returns true if the coordinates are valid and false if not. More...
void	to_halo_mem_coords (const region_index_t region_index, ElementCoords_t &coords) const
	Converts coordinates to halo memory coordinates for a given region index. More...
pattern_size_t	offset (const region_index_t region_index, const ElementCoords_t &coords) const

Detailed Description

template<typename HaloBlockT>
class dash::halo::HaloMemory< HaloBlockT >

Mangages the memory for all halo regions provided by the given HaloBlock.

Definition at line 20 of file HaloMemory.h.

Constructor & Destructor Documentation

HaloMemory()

template<typename HaloBlockT>

dash::halo::HaloMemory< HaloBlockT >::HaloMemory ( const HaloBlockT &  haloblock )

inline

Constructor.

Definition at line 47 of file HaloMemory.h.

                                          : _haloblock(haloblock) {
    _halobuffer.resize(haloblock.halo_size());
    auto it = _halobuffer.begin();
    std::fill(_halo_offsets.begin(), _halo_offsets.end(), _halobuffer.end());
    for(const auto& region : haloblock.halo_regions()) {
      _halo_offsets[region.index()] = it;
      it += region.size();
    }
  }

Member Function Documentation

begin() [1/2]

template<typename HaloBlockT>

iterator dash::halo::HaloMemory< HaloBlockT >::begin ( )

inline

Returns an iterator to the first halo element.

Definition at line 90 of file HaloMemory.h.

{ return _halobuffer.begin(); }

begin() [2/2]

template<typename HaloBlockT>

const_iterator dash::halo::HaloMemory< HaloBlockT >::begin ( ) const

inline

Returns a const iterator to the first halo element.

Definition at line 95 of file HaloMemory.h.

{ return _halobuffer.begin(); }

buffer()

template<typename HaloBlockT>

const HaloBuffer_t& dash::halo::HaloMemory< HaloBlockT >::buffer ( ) const

inline

Container storing all halo elements.

Returns

Reference to the container storing all halo elements

Definition at line 112 of file HaloMemory.h.

{ return _halobuffer; }

end() [1/2]

template<typename HaloBlockT>

iterator dash::halo::HaloMemory< HaloBlockT >::end ( )

inline

Returns an iterator to the end of the halo elements.

Definition at line 100 of file HaloMemory.h.

{ return _halobuffer.end(); }

end() [2/2]

template<typename HaloBlockT>

const_iterator dash::halo::HaloMemory< HaloBlockT >::end ( ) const

inline

Returns a const iterator to the end of the halo elements.

Definition at line 105 of file HaloMemory.h.

{ return _halobuffer.end(); }

first_element_at()

template<typename HaloBlockT>

iterator dash::halo::HaloMemory< HaloBlockT >::first_element_at ( region_index_t  index )

inline

Iterator to the first halo element for the given region index.

Parameters

index

halo region index

Returns

Iterator to the first halo element. If no region exists the end iterator will be returned.

Definition at line 63 of file HaloMemory.h.

                                                  {
    return _halo_offsets[index];
  }

range_at()

template<typename HaloBlockT>

MemRange_t dash::halo::HaloMemory< HaloBlockT >::range_at ( region_index_t  index )

inline

Returns the range of all halo elements for the given region index.

Parameters

index

halo region index

Returns

Pair of iterator. First points ot the beginning and second to the end.

Definition at line 73 of file HaloMemory.h.

Referenced by dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::set_custom_halos(), and dash::halo::HaloMatrixWrapper< MatrixT, SigReady >::stencil_operator().

                                            {
    auto it = _halo_offsets[index];
    if(it == _halobuffer.end())
      return std::make_pair(it, it);

    auto* region = _haloblock.halo_region(index);

    DASH_ASSERT_MSG(
      region != nullptr,
      "HaloMemory manages memory for a region that seemed to be empty.");

    return std::make_pair(it, it + region->size());
  }

to_halo_mem_coords()

template<typename HaloBlockT>

void dash::halo::HaloMemory< HaloBlockT >::to_halo_mem_coords ( const region_index_t  region_index, ElementCoords_t &  coords  ) const

inline

Converts coordinates to halo memory coordinates for a given region index.

Definition at line 139 of file HaloMemory.h.

                                                             {
    const auto& extents =
      _haloblock.halo_region(region_index)->view().extents();
    for(dim_t d = 0; d < NumDimensions; ++d) {
      if(coords[d] < 0) {
        coords[d] += extents[d];
        continue;
      }

      if(static_cast<extent_t>(coords[d]) >= _haloblock.view().extent(d))
        coords[d] -= _haloblock.view().extent(d);
    }
  }

to_halo_mem_coords_check()

template<typename HaloBlockT>

bool dash::halo::HaloMemory< HaloBlockT >::to_halo_mem_coords_check ( const region_index_t  region_index, ElementCoords_t &  coords  ) const

inline

Converts coordinates to halo memory coordinates for a given region index and returns true if the coordinates are valid and false if not.

Definition at line 119 of file HaloMemory.h.

                                                                   {
    const auto& extents =
      _haloblock.halo_region(region_index)->view().extents();
    for(auto d = 0; d < NumDimensions; ++d) {
      if(coords[d] < 0)
        coords[d] += extents[d];
      else if(static_cast<extent_t>(coords[d]) >= _haloblock.view().extent(d))
        coords[d] -= _haloblock.view().extent(d);

      if(static_cast<extent_t>(coords[d]) >= extents[d] || coords[d] < 0)
        return false;
    }

    return true;
  }

---

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

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