Global iterator on an index set specified by a view modifier. More...

#include <GlobViewIter.h>

Public Types
typedef ElementType	value_type

typedef ReferenceType	reference

typedef ReferenceType::const_type	const_reference

typedef PointerType	pointer

typedef PointerType::const_type	const_pointer

typedef pointer::local_type	local_type

typedef pointer::const_local_type	const_local_type

typedef PatternType	pattern_type

typedef PatternType::index_type	index_type

typedef PatternType::size_type	size_type

typedef std::integral_constant< bool, true >	has_view

Public Member Functions
constexpr	GlobViewIter ()
	Default constructor. More...

template<class GlobStaticMemT_ >
constexpr	GlobViewIter (GlobStaticMemT_ *gmem, const PatternType &pat, const ViewSpecType &viewspec, IndexType position=0, IndexType view_index_offset=0)
	Constructor, creates a global iterator on global memory following the element order specified by the given pattern and view spec. More...

template<class GlobStaticMemT_ >
constexpr	GlobViewIter (GlobStaticMemT_ *gmem, const PatternType &pat, IndexType position=0, IndexType view_index_offset=0)
	Constructor, creates a global iterator on global memory following the element order specified by the given pattern and view spec. More...

template<class P_ , class GM_ , class Ptr_ , class Ref_ >
constexpr	GlobViewIter (const GlobIter< nonconst_value_type, P_, GM_, Ptr_, Ref_ > &other, const ViewSpecType &viewspec, IndexType view_offs=0)
	Constructor, creates a global view iterator from a global iterator. More...

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >
constexpr	GlobViewIter (const GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > &other)
	Copy constructor. More...

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >
constexpr	GlobViewIter (GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > &&other)
	Move constructor. More...

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >
self_t &	operator= (const GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > &other)
	Assignment operator. More...

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >
self_t &	operator= (GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > &&other)
	Move-assignment operator. More...

	operator const_pointer () const
	Type conversion operator to `GlobPtr`. More...

	operator pointer ()
	Type conversion operator to `GlobPtr`. More...

dart_gptr_t	dart_gptr () const
	Explicit conversion to `dart_gptr_t`. More...

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

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

reference	operator[] (index_type g_index)
	Subscript operator, returns global reference to element at given global index. More...

const_reference	operator[] (index_type g_index) const
	Subscript operator, returns global reference to element at given global index. More...

constexpr bool	is_local () const
	Checks whether the element referenced by this global iterator is in the calling unit's local memory. More...

local_type	local () const
	Convert global iterator to native pointer. More...

const_global_type	global () const
	Map iterator to global index domain by projecting the iterator's view. More...

global_type	global ()
	Map iterator to global index domain by projecting the iterator's view. More...

constexpr index_type	pos () const noexcept
	Position of the iterator in its view's iteration space and the view's offset in global index space. More...

index_type	rpos () const noexcept
	Position of the iterator in its view's iteration space, disregarding the view's offset in global index space. More...

index_type	gpos () const
	Position of the iterator in global index range. More...

pattern_type::local_index_t	lpos () const
	Unit and local offset at the iterator's position. More...

bool	is_relative () const noexcept
	Whether the iterator's position is relative to a view. More...

ViewSpecType	viewspec () const
	The view that specifies this iterator's index range. More...

constexpr const GlobMemType &	globmem () const noexcept
	The instance of `GlobStaticMem` used by this iterator to resolve addresses in global memory. More...

GlobMemType &	globmem () noexcept
	The instance of `GlobStaticMem` used by this iterator to resolve addresses in global memory. More...

self_t &	operator++ () noexcept
	Prefix increment operator. More...

self_t	operator++ (int) noexcept
	Postfix increment operator. More...

self_t &	operator-- () noexcept
	Prefix decrement operator. More...

self_t	operator-- (int) noexcept
	Postfix decrement operator. More...

self_t &	operator+= (index_type n) noexcept

self_t &	operator-= (index_type n) noexcept

self_t	operator+ (index_type n) const noexcept

self_t	operator- (index_type n) const noexcept

index_type	operator+ (const self_t &other) const noexcept

index_type	operator- (const self_t &other) const

bool	operator< (const self_t &other) const noexcept

bool	operator<= (const self_t &other) const noexcept

bool	operator> (const self_t &other) const noexcept

bool	operator>= (const self_t &other) const noexcept

bool	operator== (const self_t &other) const noexcept

bool	operator!= (const self_t &other) const noexcept

constexpr const PatternType &	pattern () const noexcept

constexpr dash::Team &	team () const noexcept

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

Friends
template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >
std::ostream &	operator<< (std::ostream &os, const GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > &it)

Detailed Description

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>
class dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >

Global iterator on an index set specified by a view modifier.

Implemented concept:: Global Iterator Concept

Definition at line 40 of file GlobViewIter.h.

Constructor & Destructor Documentation

◆ GlobViewIter() [1/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter ( )

inline

Default constructor.

Definition at line 162 of file GlobViewIter.h.

   : _globmem(nullptr)
   , _pattern(nullptr)
   , _viewspec(nullptr)
   , _idx(0)
   , _view_idx_offset(0)
   , _max_idx(0)
   , _myid(dash::Team::All().myid())
   { }

◆ GlobViewIter() [2/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<class GlobStaticMemT_ >

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter	(	GlobStaticMemT_ *	gmem,
		const PatternType &	pat,
		const ViewSpecType &	viewspec,
		IndexType	position = `0`,
		IndexType	view_index_offset = `0`
	)

inline

Constructor, creates a global iterator on global memory following the element order specified by the given pattern and view spec.

Definition at line 177 of file GlobViewIter.h.

   : _globmem(reinterpret_cast<GlobMemType *>(gmem))
   , _pattern(&pat)
   , _viewspec(&viewspec)
   , _idx(position)
   , _view_idx_offset(view_index_offset)
   , _max_idx(viewspec.size() - 1)
   , _myid(pat.team().myid())
   { }

◆ GlobViewIter() [3/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<class GlobStaticMemT_ >

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter	(	GlobStaticMemT_ *	gmem,
		const PatternType &	pat,
		IndexType	position = `0`,
		IndexType	view_index_offset = `0`
	)

inline

Constructor, creates a global iterator on global memory following the element order specified by the given pattern and view spec.

Definition at line 197 of file GlobViewIter.h.

   : _globmem(reinterpret_cast<GlobMemType *>(gmem))
   , _pattern(&pat)
   , _viewspec(nullptr)
   , _idx(position)
   , _view_idx_offset(view_index_offset)
   , _max_idx(pat.size() - 1)
   , _myid(dash::Team::GlobalUnitID())
   { }

◆ GlobViewIter() [4/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<class P_ , class GM_ , class Ptr_ , class Ref_ >

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter	(	const GlobIter< nonconst_value_type, P_, GM_, Ptr_, Ref_ > &	other,
		const ViewSpecType &	viewspec,
		IndexType	view_offs = `0`
	)

inline

Constructor, creates a global view iterator from a global iterator.

Definition at line 219 of file GlobViewIter.h.

   : _globmem(other._globmem)
   , _pattern(other._pattern)
   , _viewspec(&viewspec)
   , _idx(other._idx)
   , _view_idx_offset(view_offs)
   , _max_idx(other._max_idx)
   , _myid(other._myid)
   { }

◆ GlobViewIter() [5/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter ( const GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > & other )

inline

Copy constructor.

Definition at line 241 of file GlobViewIter.h.

   : _globmem        (other._globmem)
   , _pattern        (other._pattern)
   , _viewspec       (other._viewspec)
   , _idx            (other._idx)
   , _view_idx_offset(other._view_idx_offset)
   , _max_idx        (other._max_idx)
   , _myid           (other._myid)
   { }

◆ GlobViewIter() [6/6]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >

constexpr dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::GlobViewIter ( GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > && other )

inline

Move constructor.

Definition at line 262 of file GlobViewIter.h.

   : _globmem        (std::move(other._globmem))
   , _pattern        (std::move(other._pattern))
   , _viewspec       (std::move(other._viewspec))
   , _idx            (std::move(other._idx))
   , _view_idx_offset(std::move(other._view_idx_offset))
   , _max_idx        (std::move(other._max_idx))
   , _myid           (std::move(other._myid))
   { }

Member Function Documentation

◆ dart_gptr()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

dart_gptr_t dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::dart_gptr ( ) const

inline

Explicit conversion to dart_gptr_t.

Returns: A DART global pointer to the element at the iterator's position

Definition at line 419 of file GlobViewIter.h.

Referenced by dash::GlobViewIter< ElementT, PatternT, GlobMemT >::operator--().

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.dart_gptr()", _idx);
     typedef typename pattern_type::local_index_t
       local_pos_t;
     IndexType idx    = _idx;
     IndexType offset = 0;
     // Convert iterator position (_idx) to local index and unit.
     if (_idx > _max_idx) {
       // Global iterator pointing past the range indexed by the pattern
       // which is the case for .end() iterators.
       idx     = _max_idx;
       offset += _idx - _max_idx;
       DASH_LOG_TRACE_VAR("GlobViewIter.dart_gptr", _max_idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.dart_gptr", idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.dart_gptr", offset);
     }
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(idx);
     } else {
       // Viewspec projection required:
       DASH_LOG_TRACE_VAR("GlobViewIter.dart_gptr", _viewspec);
       auto glob_coords = coords(idx);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE("GlobViewIter.dart_gptr",
                    "unit:",        local_pos.unit,
                    "local index:", local_pos.index);
     // Global pointer to element at given position:
     auto const    dart_pointer = _get_pointer_at(local_pos);
     const_pointer gptr(dart_pointer);
     DASH_LOG_TRACE_VAR("GlobIter.dart_gptr >", gptr);
     return (gptr + offset).dart_gptr();
   }

◆ global() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

const_global_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::global ( ) const

inline

Map iterator to global index domain by projecting the iterator's view.

Definition at line 594 of file GlobViewIter.h.

   {
     auto g_idx = gpos();
     return const_global_type(
              _globmem,
              *_pattern,
              g_idx
            );
   }

◆ global() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

global_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::global ( )

inline

Map iterator to global index domain by projecting the iterator's view.

Definition at line 607 of file GlobViewIter.h.

   {
     return global_type(
              _globmem,
              *_pattern,
              gpos()
            );
   }

◆ globmem() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

constexpr const GlobMemType& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::globmem ( ) const

inlinenoexcept

The instance of GlobStaticMem used by this iterator to resolve addresses in global memory.

Definition at line 731 of file GlobViewIter.h.

   {
     return *_globmem;
   }

◆ globmem() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

GlobMemType& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::globmem ( )

inlinenoexcept

The instance of GlobStaticMem used by this iterator to resolve addresses in global memory.

Definition at line 740 of file GlobViewIter.h.

   {
     return *_globmem;
   }

◆ gpos()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

index_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::gpos ( ) const

inline

Position of the iterator in global index range.

Projects iterator position from its view spec to global index domain.

Definition at line 638 of file GlobViewIter.h.

Referenced by dash::GlobViewIter< ElementT, PatternT, GlobMemT >::global().

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.gpos()", _idx);
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos >", _idx);
       return _idx;
     } else {
       IndexType idx    = _idx;
       IndexType offset = 0;
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos", *_viewspec);
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos", _max_idx);
       // Convert iterator position (_idx) to local index and unit.
       if (_idx > _max_idx) {
         // Global iterator pointing past the range indexed by the pattern
         // which is the case for .end() iterators.
         idx    = _max_idx;
         offset = _idx - _max_idx;
       }
       // Viewspec projection required:
       auto g_coords = coords(idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos", _idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos", g_coords);
       auto g_idx    = _pattern->global_at(g_coords);
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos", g_idx);
       g_idx += offset;
       DASH_LOG_TRACE_VAR("GlobViewIter.gpos >", g_idx);
       return g_idx;
     }
   }

◆ is_local()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

constexpr bool dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::is_local ( ) const

inline

Checks whether the element referenced by this global iterator is in the calling unit's local memory.

Definition at line 539 of file GlobViewIter.h.

   {
     return (_myid == lpos().unit);
   }

◆ is_relative()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

bool dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::is_relative ( ) const

inlinenoexcept

Whether the iterator's position is relative to a view.

Definition at line 711 of file GlobViewIter.h.

   {
     return _viewspec != nullptr;
   }

◆ local()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

local_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::local ( ) const

inline

Convert global iterator to native pointer.

Definition at line 547 of file GlobViewIter.h.

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.local=()", _idx);
     typedef typename pattern_type::local_index_t
       local_pos_t;
     IndexType idx    = _idx;
     IndexType offset = 0;
     DASH_LOG_TRACE_VAR("GlobViewIter.local=", _max_idx);
     // Convert iterator position (_idx) to local index and unit.
     if (_idx > _max_idx) {
       // Global iterator pointing past the range indexed by the pattern
       // which is the case for .end() iterators.
       idx     = _max_idx;
       offset += _idx - _max_idx;
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.local=", idx);
     DASH_LOG_TRACE_VAR("GlobViewIter.local=", offset);
 
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(idx);
     } else {
       DASH_LOG_TRACE_VAR("GlobViewIter.local=", *_viewspec);
       // Viewspec projection required:
       auto glob_coords = coords(idx);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.local= >", local_pos.unit);
     DASH_LOG_TRACE_VAR("GlobViewIter.local= >", local_pos.index);
     if (_myid != local_pos.unit) {
       // Iterator position does not point to local element
       return nullptr;
     }
 
     auto* lbegin = dash::local_begin(
         static_cast<pointer>(_globmem->begin()), _pattern->team().myid());
 
     DASH_ASSERT(lbegin);
 
     return std::next(lbegin, local_pos.index + offset);
   }

◆ lpos()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

pattern_type::local_index_t dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::lpos ( ) const

inline

Unit and local offset at the iterator's position.

Projects iterator position from its view spec to global index domain.

Definition at line 673 of file GlobViewIter.h.

Referenced by dash::GlobViewIter< ElementT, PatternT, GlobMemT >::is_local(), and dash::GlobViewIter< ElementT, PatternT, GlobMemT >::operator--().

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.lpos()", _idx);
     typedef typename pattern_type::local_index_t
       local_pos_t;
     IndexType idx    = _idx;
     IndexType offset = 0;
     // Convert iterator position (_idx) to local index and unit.
     if (_idx > _max_idx) {
       // Global iterator pointing past the range indexed by the pattern
       // which is the case for .end() iterators.
       idx    = _max_idx;
       offset = _idx - _max_idx;
       DASH_LOG_TRACE_VAR("GlobViewIter.lpos", _max_idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.lpos", idx);
       DASH_LOG_TRACE_VAR("GlobViewIter.lpos", offset);
     }
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(idx);
     } else {
       // Viewspec projection required:
       DASH_LOG_TRACE_VAR("GlobViewIter.lpos", *_viewspec);
       auto glob_coords = coords(idx);
       local_pos        = _pattern->local_index(glob_coords);
     }
     local_pos.index += offset;
     DASH_LOG_TRACE("GlobViewIter.lpos >",
                    "unit:",        local_pos.unit,
                    "local index:", local_pos.index);
     return local_pos;
   }

◆ ndim()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

static dim_t dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::ndim ( )

inlinestatic

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

Definition at line 323 of file GlobViewIter.h.

   {
     return NumDimensions;
   }

◆ operator const_pointer()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator const_pointer ( ) const

inlineexplicit

Type conversion operator to GlobPtr.

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

Definition at line 333 of file GlobViewIter.h.

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer()", _idx);
     typedef typename pattern_type::local_index_t
       local_pos_t;
     IndexType idx    = _idx;
     IndexType offset = 0;
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer", _max_idx);
     // Convert iterator position (_idx) to local index and unit.
     if (_idx > _max_idx) {
       // Global iterator pointing past the range indexed by the pattern
       // which is the case for .end() iterators.
       idx     = _max_idx;
       offset += _idx - _max_idx;
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer", idx);
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer", offset);
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(idx);
     } else {
       // Viewspec projection required:
       auto glob_coords = coords(idx);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer >",
                        local_pos.unit);
     DASH_LOG_TRACE_VAR("GlobViewIter.const_pointer >",
                        local_pos.index + offset);
     // Create global pointer from unit and local offset:
     auto const    dart_pointer = _get_pointer_at(local_pos);
     const_pointer gptr(dart_pointer);
     gptr += offset;
     return gptr;
   }

◆ operator pointer()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator pointer ( )

inlineexplicit

Type conversion operator to GlobPtr.

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

Definition at line 376 of file GlobViewIter.h.

   {
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer()", _idx);
     typedef typename pattern_type::local_index_t
       local_pos_t;
     IndexType idx    = _idx;
     IndexType offset = 0;
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer", _max_idx);
     // Convert iterator position (_idx) to local index and unit.
     if (_idx > _max_idx) {
       // Global iterator pointing past the range indexed by the pattern
       // which is the case for .end() iterators.
       idx     = _max_idx;
       offset += _idx - _max_idx;
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer", idx);
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer", offset);
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(idx);
     } else {
       // Viewspec projection required:
       auto glob_coords = coords(idx);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer >", local_pos.unit);
     DASH_LOG_TRACE_VAR("GlobViewIter.pointer >", local_pos.index + offset);
     // Create global pointer from unit and local offset:
 
     auto const    dart_pointer = _get_pointer_at(local_pos);
     pointer gptr(dart_pointer);
     gptr += offset;
     return gptr;
   }

◆ operator*() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

reference dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator* ( )

inline

Dereference operator.

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

Definition at line 462 of file GlobViewIter.h.

   {
     return this->operator[](_idx);
   }

◆ operator*() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

const_reference dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator* ( ) const

inline

Dereference operator.

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

Definition at line 472 of file GlobViewIter.h.

   {
     return this->operator[](_idx);
   }

◆ operator++() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

self_t& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator++ ( )

inlinenoexcept

Prefix increment operator.

Definition at line 748 of file GlobViewIter.h.

   {
     ++_idx;
     return *this;
   }

◆ operator++() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

self_t dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator++ ( int )

inlinenoexcept

Postfix increment operator.

Definition at line 757 of file GlobViewIter.h.

   {
     self_t result = *this;
     ++_idx;
     return result;
   }

◆ operator--() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

self_t& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator-- ( )

inlinenoexcept

Prefix decrement operator.

Definition at line 767 of file GlobViewIter.h.

   {
     --_idx;
     return *this;
   }

◆ operator--() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

self_t dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator-- ( int )

inlinenoexcept

Postfix decrement operator.

Definition at line 776 of file GlobViewIter.h.

   {
     self_t result = *this;
     --_idx;
     return result;
   }

◆ operator=() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >

self_t& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator= ( const GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > & other )

inline

Assignment operator.

Definition at line 283 of file GlobViewIter.h.

   {
     _globmem         = other._globmem;
     _pattern         = other._pattern;
     _viewspec        = other._viewspec;
     _idx             = other._idx;
     _view_idx_offset = other._view_idx_offset;
     _max_idx         = other._max_idx;
     _myid            = other._myid;
 
     return *this;
   }

◆ operator=() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

template<typename T_ , class P_ , class GM_ , class Ptr_ , class Ref_ >

self_t& dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator= ( GlobViewIter< T_, P_, GM_, Ptr_, Ref_ > && other )

inline

Move-assignment operator.

Definition at line 306 of file GlobViewIter.h.

   {
     _globmem         = std::move(other._globmem);
     _pattern         = std::move(other._pattern);
     _viewspec        = std::move(other._viewspec);
     _idx             = std::move(other._idx);
     _view_idx_offset = std::move(other._view_idx_offset);
     _max_idx         = std::move(other._max_idx);
     _myid            = std::move(other._myid);
     // no ownership to transfer
     return *this;
   }

◆ operator[]() [1/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

reference dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator[] ( index_type g_index )

inline

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

Parameters

g_index The global position of the element

Definition at line 481 of file GlobViewIter.h.

Referenced by dash::GlobViewIter< ElementT, PatternT, GlobMemT >::operator*().

   {
     typedef typename pattern_type::local_index_t
       local_pos_t;
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(g_index);
     } else {
       // Viewspec projection required:
       auto glob_coords = coords(g_index);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE("GlobViewIter.[]",
                    "(index:", g_index, " voffset:", _view_idx_offset, ") ->",
                    "(unit:", local_pos.unit, " index:", local_pos.index, ")");
     // Global reference to element at given position:
 
     auto const    dart_pointer = _get_pointer_at(local_pos);
     return reference(dart_pointer);
   }

◆ operator[]() [2/2]

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

const_reference dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::operator[] ( index_type g_index ) const

inline

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

Parameters

g_index The global position of the element

Definition at line 510 of file GlobViewIter.h.

   {
     typedef typename pattern_type::local_index_t
       local_pos_t;
     // Global index to local index and unit:
     local_pos_t local_pos;
     if (_viewspec == nullptr) {
       // No viewspec mapping required:
       local_pos        = _pattern->local(g_index);
     } else {
       // Viewspec projection required:
       auto glob_coords = coords(g_index);
       local_pos        = _pattern->local_index(glob_coords);
     }
     DASH_LOG_TRACE("GlobViewIter.[]",
                    "(index:", g_index, " voffset:", _view_idx_offset, ") ->",
                    "(unit:", local_pos.unit, " index:", local_pos.index, ")");
     // Global reference to element at given position:
 
     auto const dart_pointer = _get_pointer_at(local_pos);
     return const_reference(dart_pointer);
   }

◆ pos()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

constexpr index_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::pos ( ) const

inlinenoexcept

Position of the iterator in its view's iteration space and the view's offset in global index space.

Definition at line 620 of file GlobViewIter.h.

Referenced by dash::GlobViewIter< ElementT, PatternT, GlobMemT >::operator--().

   {
     return _idx + _view_idx_offset;
   }

◆ rpos()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

index_type dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::rpos ( ) const

inlinenoexcept

Position of the iterator in its view's iteration space, disregarding the view's offset in global index space.

Definition at line 629 of file GlobViewIter.h.

   {
     return _idx;
   }

◆ viewspec()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>

ViewSpecType dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >::viewspec ( ) const

inline

The view that specifies this iterator's index range.

Definition at line 719 of file GlobViewIter.h.

   {
     if (_viewspec != nullptr) {
       return *_viewspec;
     }
     return ViewSpecType(_pattern->extents());
   }

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

/tmp/tmporruphar/dash/include/dash/iterator/GlobViewIter.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>> class dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >

Constructor & Destructor Documentation

◆ GlobViewIter() [1/6]

◆ GlobViewIter() [2/6]

◆ GlobViewIter() [3/6]

◆ GlobViewIter() [4/6]

◆ GlobViewIter() [5/6]

◆ GlobViewIter() [6/6]

Member Function Documentation

◆ dart_gptr()

◆ global() [1/2]

◆ global() [2/2]

◆ globmem() [1/2]

◆ globmem() [2/2]

◆ gpos()

◆ is_local()

◆ is_relative()

◆ local()

◆ lpos()

◆ ndim()

◆ operator const_pointer()

◆ operator pointer()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ pos()

◆ rpos()

◆ viewspec()

template<typename ElementType, class PatternType, class GlobMemType, class PointerType = typename GlobMemType::void_pointer::template rebind<ElementType>, class ReferenceType = GlobRef<ElementType>>
class dash::GlobViewIter< ElementType, PatternType, GlobMemType, PointerType, ReferenceType >