dash::halo::StencilIteratorTest< CoordsIdxManagerT > Class Template Reference

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = Element_t
using	difference_type = typename CoordsIdxManagerT::uindex_t
using	pointer = Element_t *
using	reference = Element_t &
using	index_t = typename CoordsIdxManagerT::index_t
using	uindex_t = typename CoordsIdxManagerT::uindex_t
using	StencilP_t = StencilPoint< NumDimensions >
using	Coords_t = typename CoordsIdxManagerT::Coords_t
using	stencil_index_t = typename CoordsIdxManagerT::stencil_index_t

Public Member Functions
	StencilIteratorTest (CoordsIdxManagerT coords_mng)
	Constructor. More...
	StencilIteratorTest (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...
Element_t	operator[] (index_t n) const
	Subscript operator, returns global reference to element at given global index. More...
reference	operator[] (index_t n)
uindex_t	rpos () const
uindex_t	lpos () const
Coords_t	coords () const
CoordsIdxManagerT &	helper ()
Element_t	value_at (const stencil_index_t index_stencil)
	Returns the value for a given stencil point index (index postion in StencilSpec) More...
Element_t	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+= (index_t n)
Self_t &	operator-= (index_t n)
Self_t	operator+ (index_t n) const
Self_t	operator- (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 CoordsIdxManagerT>
class dash::halo::StencilIteratorTest< CoordsIdxManagerT >

Definition at line 655 of file StencilIterator.h.

Constructor & Destructor Documentation

StencilIteratorTest() [1/2]

template<typename CoordsIdxManagerT>

dash::halo::StencilIteratorTest< CoordsIdxManagerT >::StencilIteratorTest ( CoordsIdxManagerT  coords_mng )

inline

Constructor.

Parameters

Definition at line 685 of file StencilIterator.h.

  : _coords_mng(coords_mng) {
  }

StencilIteratorTest() [2/2]

template<typename CoordsIdxManagerT>

dash::halo::StencilIteratorTest< CoordsIdxManagerT >::StencilIteratorTest ( const Self_t &  other )

default

Copy constructor.

Member Function Documentation

ndim()

template<typename CoordsIdxManagerT>

static constexpr dim_t dash::halo::StencilIteratorTest< CoordsIdxManagerT >::ndim ( )

inlinestatic

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

See also

Global Iterator Concept

Definition at line 706 of file StencilIterator.h.

{ return NumDimensions; }

operator*()

template<typename CoordsIdxManagerT>

reference dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator* ( ) const

inline

Dereference operator.

Returns

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

Definition at line 713 of file StencilIterator.h.

{ return _coords_mng.value(); }

operator++() [1/2]

template<typename CoordsIdxManagerT>

Self_t& dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator++ ( )

inline

Prefix increment operator.

Definition at line 755 of file StencilIterator.h.

                       {
    _coords_mng.next_element();

    return *this;
  }

operator++() [2/2]

template<typename CoordsIdxManagerT>

Self_t dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 764 of file StencilIterator.h.

                         {
    Self_t result = *this;

    _coords_mng.next_element();

    return result;
  }

operator--() [1/2]

template<typename CoordsIdxManagerT>

Self_t& dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 775 of file StencilIterator.h.

                       {
    _coords_mng.set(_coords_mng.index()-1);

    return *this;
  }

operator--() [2/2]

template<typename CoordsIdxManagerT>

Self_t dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator-- ( int  )

inline

Postfix decrement operator.

Definition at line 784 of file StencilIterator.h.

                         {
     Self_t result = *this;

    _coords_mng.set(_coords_mng.index()-1);

    return result;
  }

operator=()

template<typename CoordsIdxManagerT>

Self_t& dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator= ( const Self_t &  other )

default

Assignment operator.

See also

Global Iterator Concept

operator[]()

template<typename CoordsIdxManagerT>

Element_t dash::halo::StencilIteratorTest< CoordsIdxManagerT >::operator[] ( index_t  n ) const

inline

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

See also

Global Iterator Concept

Definition at line 721 of file StencilIterator.h.

                                        {
    return _coords_mng[n];
  }

value_at()

template<typename CoordsIdxManagerT>

Element_t dash::halo::StencilIteratorTest< CoordsIdxManagerT >::value_at ( const stencil_index_t  index_stencil )

inline

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

Definition at line 741 of file StencilIterator.h.

                                                          {
    return _coords_mng.value_at(index_stencil);
  }

---

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

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