Public Types
using	iterator_category = std::random_access_iterator_tag

using	value_type = ElementT

using	difference_type = typename PatternT::index_type

using	pointer = ElementT *

using	reference = ElementT &

using	HaloMemory_t = HaloMemory< HaloBlock_t >

using	pattern_index_t = typename PatternT::index_type

using	LocalLayout_t = CartesianIndexSpace< NumDimensions, MemoryArrange, pattern_index_t >

using	StencilP_t = StencilPoint< NumDimensions >

using	ElementCoords_t = std::array< pattern_index_t, NumDimensions >

using	signed_pattern_size_t = typename std::make_signed< pattern_size_t >::type

using	StencilOffsets_t = std::array< signed_pattern_size_t, NumStencilPoints >

using	StencilSpecViews_t = StencilSpecificViews< HaloBlock_t, StencilSpecT >

using	BoundaryViews_t = typename StencilSpecViews_t::BoundaryViews_t

Public Member Functions
	StencilIterator (ElementT local_memory, HaloMemory_t halomemory, const StencilSpecT stencil_spec, const StencilOffsets_t stencil_offsets, const ViewSpec_t &view_local, const ViewSpec_t &view_scope, pattern_index_t idx)
	Constructor. More...

	StencilIterator (ElementT local_memory, HaloMemory_t halomemory, const StencilSpecT stencil_spec, const StencilOffsets_t stencil_offsets, const ViewSpec_t &view_local, const BoundaryViews_t &boundary_views, pattern_index_t idx)
	Constructor. More...

	StencilIterator (const Self_t &other)=default
	Copy constructor. More...

Self_t &	operator= (const Self_t &other)=default
	Assignment operator. More...

reference	operator* () const
	Dereference operator. More...

reference	operator[] (pattern_index_t n) const
	Subscript operator, returns global reference to element at given global index. More...

pattern_index_t	rpos () const

pattern_index_t	lpos () const

ElementCoords_t	coords () const

bool	is_halo_value (const region_index_t index_stencil)

ElementT	value_at (const region_index_t index_stencil)
	Returns the value for a given stencil point index (index postion in StencilSpec) More...

ElementT	value_at (const StencilP_t &stencil)

Self_t &	operator++ ()
	Prefix increment operator. More...

Self_t	operator++ (int)
	Postfix increment operator. More...

Self_t &	operator-- ()
	Prefix decrement operator. More...

Self_t	operator-- (int)
	Postfix decrement operator. More...

Self_t &	operator+= (pattern_index_t n)

Self_t &	operator-= (pattern_index_t n)

Self_t	operator+ (pattern_index_t n) const

Self_t	operator- (pattern_index_t n) const

difference_type	operator- (const Self_t &other) const

bool	operator< (const Self_t &other) const

bool	operator<= (const Self_t &other) const

bool	operator> (const Self_t &other) const

bool	operator>= (const Self_t &other) const

bool	operator== (const Self_t &other) const

bool	operator!= (const Self_t &other) const

Static Public Member Functions
static constexpr dim_t	ndim ()
	The number of dimensions of the iterator's underlying pattern. More...

Detailed Description

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>
class dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >

Definition at line 871 of file StencilIterator.h.

Constructor & Destructor Documentation

◆ StencilIterator() [1/3]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::StencilIterator	(	ElementT *	local_memory,
		HaloMemory_t *	halomemory,
		const StencilSpecT *	stencil_spec,
		const StencilOffsets_t *	stencil_offsets,
		const ViewSpec_t &	view_local,
		const ViewSpec_t &	view_scope,
		pattern_index_t	idx
	)

inline

Constructor.

Parameters

local_memory	Pointer to the begining of the local NArray memory
halomemory	HaloMemory instance for loacl halo memory
stencil_spec	StencilSpec to use
stencil_offsets	stencil offsets for every stencil point
view_local	local SpecView including all local elements
view_scope	ViewSpec to use
idx	position of the iterator

Definition at line 917 of file StencilIterator.h.

   : _halomemory(halomemory), _stencil_spec(stencil_spec),
     _stencil_offsets(stencil_offsets), _view(view_scope),
     _local_memory(local_memory),
     _local_layout(view_local.extents()), _idx(idx) {
     _size = _view.size();
     if(_idx < _size)
       set_coords();
 
     const auto ext_max = stencil_spec->minmax_distances(FastestDimension);
     if(Scope == StencilViewScope::INNER) {
       _ext_dim_reduced = std::make_pair(
         _view.offset(FastestDimension),
         _local_layout.extent(FastestDimension) - ext_max.second - 1);
     } else {
       _ext_dim_reduced =
         std::make_pair(std::abs(ext_max.first),
                        _view.extent(FastestDimension) - ext_max.second - 1);
     }
   }

◆ StencilIterator() [2/3]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::StencilIterator	(	ElementT *	local_memory,
		HaloMemory_t *	halomemory,
		const StencilSpecT *	stencil_spec,
		const StencilOffsets_t *	stencil_offsets,
		const ViewSpec_t &	view_local,
		const BoundaryViews_t &	boundary_views,
		pattern_index_t	idx
	)

inline

Constructor.

Parameters

local_memory	Pointer to the begining of the local NArray memory
halomemory	HaloMemory instance for halo memory elements
stencil_spec	StencilSpec to use
stencil_offsets	stencil offsets for every stencil point
view_local	local SpecView including all local elements
boundary_views	all relevant boundary views
idx	position of the iterator

Definition at line 953 of file StencilIterator.h.

   : _halomemory(halomemory), _stencil_spec(stencil_spec),
     _stencil_offsets(stencil_offsets),
     _view(view_local.extents()),
     _boundary_views(boundary_views),
     _local_memory(local_memory),
     _local_layout(view_local.extents()), _idx(idx) {
     _size = 0;
     for(const auto& view : boundary_views)
       _size += view.size();
 
     if(_idx < _size)
       set_coords();
 
     const auto ext_max = stencil_spec->minmax_distances(FastestDimension);
 
     _ext_dim_reduced =
       std::make_pair(std::abs(ext_max.first),
                      _view.extent(FastestDimension) - ext_max.second - 1);
   }

◆ StencilIterator() [3/3]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::StencilIterator ( const Self_t & other )

default

Copy constructor.

Member Function Documentation

◆ ndim()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

static constexpr dim_t dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::ndim ( )

inlinestatic

The number of dimensions of the iterator's underlying pattern.

See also: Global Iterator Concept

Definition at line 995 of file StencilIterator.h.

995 { return NumDimensions; }

◆ operator*()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

reference dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator* ( ) const

inline

Dereference operator.

Returns: A global reference to the element at the iterator's position.

Definition at line 1002 of file StencilIterator.h.

1002 { return *_current_lmemory_addr; }

◆ operator++() [1/2]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

Self_t& dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator++ ( )

inline

Prefix increment operator.

Definition at line 1059 of file StencilIterator.h.

                        {
     ++_idx;
     next_element();
 
     return *this;
   }

◆ operator++() [2/2]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

Self_t dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator++ ( int )

inline

Postfix increment operator.

Definition at line 1069 of file StencilIterator.h.

                          {
     Self_t result = *this;
     ++_idx;
     next_element();
 
     return result;
   }

◆ operator--() [1/2]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

Self_t& dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 1080 of file StencilIterator.h.

                        {
     --_idx;
     set_coords();
 
     return *this;
   }

◆ operator--() [2/2]

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

Self_t dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator-- ( int )

inline

Postfix decrement operator.

Definition at line 1090 of file StencilIterator.h.

                          {
     Self_t result = *this;
     --_idx;
     if(_idx < _size) {
       _coords = set_coords(_idx);
       set_offsets();
     }
 
     return result;
   }

◆ operator=()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

Self_t& dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator= ( const Self_t & other )

default

Assignment operator.

See also: Global Iterator Concept

◆ operator[]()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

reference dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::operator[] ( pattern_index_t n ) const

inline

Subscript operator, returns global reference to element at given global index.

See also: Global Iterator Concept

Definition at line 1010 of file StencilIterator.h.

                                                 {
     auto coords = set_coords(_idx + n);
     return _local_memory[_local_layout.at(coords)];
   }

◆ value_at()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>

ElementT dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >::value_at ( const region_index_t index_stencil )

inline

Returns the value for a given stencil point index (index postion in StencilSpec)

Definition at line 1040 of file StencilIterator.h.

                                                         {
     return *(_stencil_mem_ptr[index_stencil]);
   }

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

/tmp/tmporruphar/dash/include/dash/halo/iterator/StencilIterator.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope> class dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >

Constructor & Destructor Documentation

◆ StencilIterator() [1/3]

◆ StencilIterator() [2/3]

◆ StencilIterator() [3/3]

Member Function Documentation

◆ ndim()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator=()

◆ operator[]()

◆ value_at()

template<typename ElementT, typename PatternT, typename GlobMemT, typename StencilSpecT, StencilViewScope Scope>
class dash::halo::StencilIterator< ElementT, PatternT, GlobMemT, StencilSpecT, Scope >