dash::GlobAsyncIter< ElementType, PatternType > Class Template Reference

Public Types
using	iterator_category = std::random_access_iterator_tag
	Iterator Traits. More...
using	value_type = ElementType
using	difference_type = typename PatternType::index_type
using	size_type = typename PatternType::size_type
using	pointer = GlobAsyncRef< ElementType >
using	reference = GlobRef< ElementType >
typedef GlobRef< ElementType > ::const_type	const_reference
typedef GlobAsyncRef< ElementType > ::const_type	const_pointer
typedef pointer::local_type	local_type
typedef pointer::const_local_type	const_local_type
typedef PatternType	pattern_type
typedef std::make_signed< typename PatternType::index_type >::type	index_type
typedef std::integral_constant< bool, false >	has_view

Public Member Functions
	GlobAsyncIter ()
	Default constructor. More...
	GlobAsyncIter (const self_t &other)=default
GlobAsyncIter< ElementType, PatternType > &	operator= (const self_t &other)=default
void	wait ()
	Wait for completion of non-blocking read- and write operations that have been executed on this global iterator since the last call of wait. More...
void	get ()
	Wait for local completion of non-blocking read operations that have been executed on this global iterator since the last call of wait. More...
void	push ()
	Block until all non-blocking write operations that have been executed on this global iterator since the last call of wait have been published. More...
DASH_CONSTEXPR	operator const_pointer () const noexcept
	<fuchsto> TODO: Conversion from iterator to pointer looks dubios More...
DASH_CONSTEXPR	operator pointer () DASH_NOEXCEPT
	<fuchsto> TODO: Conversion from iterator to pointer looks dubios More...
DASH_CONSTEXPR dart_gptr_t	dart_gptr () const DASH_NOEXCEPT
	Explicit conversion to dart_gptr_t. More...
DASH_CONSTEXPR reference	operator* () noexcept
	Dereference operator. More...
DASH_CONSTEXPR const_reference	operator* () const noexcept
	Dereference operator. More...
DASH_CONSTEXPR reference	operator[] (index_type g_index) noexcept
	Subscript operator, returns global reference to element at given global index. More...
DASH_CONSTEXPR const_reference	operator[] (index_type g_index) const noexcept
	Subscript operator, returns global reference to element at given global index. More...
DASH_CONSTEXPR bool	is_local () const noexcept
	Checks whether the element referenced by this global iterator is in the calling unit's local memory. More...
DASH_CONSTEXPR local_type	local () const
	Convert global iterator to native pointer. More...
DASH_CONSTEXPR auto	lpos () const
	Unit and local offset at the iterator's position. More...
DASH_CONSTEXPR const self_t &	global () const DASH_NOEXCEPT
	Map iterator to global index domain. More...
DASH_CONSTEXPR index_type	pos () const DASH_NOEXCEPT
	Position of the iterator in global index space. More...
DASH_CONSTEXPR index_type	gpos () const DASH_NOEXCEPT
	Position of the iterator in global index range. More...
DASH_CONSTEXPR const GlobAsyncPtr< ElementType, PatternType > &	globmem () const DASH_NOEXCEPT
	The instance of GlobStaticMem used by this iterator to resolve addresses in global memory. More...
GlobAsyncPtr< ElementType, PatternType > &	globmem ()
	The instance of GlobStaticMem used by this iterator to resolve addresses in global memory. More...
DASH_CONSTEXPR self_t &	operator++ () DASH_NOEXCEPT
	Prefix increment operator. More...
DASH_CONSTEXPR self_t	operator++ (int) DASH_NOEXCEPT
	Postfix increment operator. More...
DASH_CONSTEXPR self_t &	operator-- () DASH_NOEXCEPT
	Prefix decrement operator. More...
DASH_CONSTEXPR self_t	operator-- (int) DASH_NOEXCEPT
	Postfix decrement operator. More...
DASH_CONSTEXPR self_t &	operator+= (index_type n) DASH_NOEXCEPT
DASH_CONSTEXPR self_t &	operator-= (index_type n) DASH_NOEXCEPT
DASH_CONSTEXPR self_t	operator+ (index_type n) const DASH_NOEXCEPT
DASH_CONSTEXPR self_t	operator- (index_type n) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator< (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator<= (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator> (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator>= (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator== (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR bool	operator!= (const GlobIterT &other) const DASH_NOEXCEPT
DASH_CONSTEXPR const PatternType &	pattern () const DASH_NOEXCEPT
DASH_CONSTEXPR dash::Team &	team () const DASH_NOEXCEPT

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

Detailed Description

template<typename ElementType, class PatternType = Pattern<1>>
class dash::GlobAsyncIter< ElementType, PatternType >

Definition at line 19 of file GlobAsyncIter.h.

Member Typedef Documentation

iterator_category

using dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::iterator_category = std::random_access_iterator_tag

inherited

Iterator Traits.

Definition at line 48 of file GlobIter.h.

Constructor & Destructor Documentation

GlobAsyncIter()

template<typename ElementType , class PatternType = Pattern<1>>

dash::GlobAsyncIter< ElementType, PatternType >::GlobAsyncIter ( )

inline

Default constructor.

Definition at line 36 of file GlobAsyncIter.h.

  : GlobIter() {
    DASH_LOG_TRACE_VAR("GlobAsyncIter()", this->_idx);
  }

Member Function Documentation

dart_gptr()

DASH_CONSTEXPR dart_gptr_t dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::dart_gptr ( ) const

inlineinherited

Explicit conversion to dart_gptr_t.

Returns

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

Definition at line 193 of file GlobIter.h.

Referenced by dash::GlobAsyncIter< ElementType, PatternType >::get(), dash::GlobAsyncIter< ElementType, PatternType >::push(), and dash::GlobAsyncIter< ElementType, PatternType >::wait().

  {
    if (_globmem == nullptr) {
      return DART_GPTR_NULL;
    }
    else if (_idx > _max_idx) {
      // Global iterator pointing past the range indexed by the pattern
      // which is the case for .end() iterators.
      return static_cast<dart_gptr_t>(_globmem->end());
    }

    DASH_LOG_TRACE_VAR("GlobIter.dart_gptr()", _idx);
    typedef typename pattern_type::local_index_t local_pos_t;

    // Global index to local index and unit:
    local_pos_t local_pos = _pattern->local(_idx);
    DASH_LOG_TRACE(
        "GlobIter.dart_gptr",
        "unit:",
        local_pos.unit,
        "local index:",
        local_pos.index);
    auto const dart_pointer = _get_pointer_at(local_pos);
    DASH_ASSERT_MSG(
        !DART_GPTR_ISNULL(dart_pointer), "dart pointer must not be null");
    return dart_pointer;
  }

get()

template<typename ElementType , class PatternType = Pattern<1>>

void dash::GlobAsyncIter< ElementType, PatternType >::get ( )

inline

Wait for local completion of non-blocking read operations that have been executed on this global iterator since the last call of wait.

Definition at line 60 of file GlobAsyncIter.h.

References dart_flush_all(), and dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType >, GlobAsyncRef< ElementType > >::dart_gptr().

  {
    dart_flush_all(this->dart_gptr());
  }

global()

DASH_CONSTEXPR const self_t& dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::global ( ) const

inlineinherited

Map iterator to global index domain.

Definition at line 328 of file GlobIter.h.

  {
    return *this;
  }

globmem() [1/2]

DASH_CONSTEXPR const GlobAsyncPtr< ElementType, PatternType > & dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::globmem ( ) const

inlineinherited

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

Definition at line 353 of file GlobIter.h.

  {
    return *_globmem;
  }

globmem() [2/2]

GlobAsyncPtr< ElementType, PatternType > & dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::globmem ( )

inlineinherited

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

Definition at line 362 of file GlobIter.h.

  {
    return *_globmem;
  }

gpos()

DASH_CONSTEXPR index_type dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::gpos ( ) const

inlineinherited

Position of the iterator in global index range.

Definition at line 344 of file GlobIter.h.

  {
    return _idx;
  }

is_local()

DASH_CONSTEXPR bool dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::is_local ( ) const

inlinenoexceptinherited

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

Definition at line 271 of file GlobIter.h.

  {
    return (_globmem->team().myid() == lpos().unit);
  }

local()

DASH_CONSTEXPR local_type dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::local ( ) const

inlineinherited

Convert global iterator to native pointer.

Definition at line 279 of file GlobIter.h.

  {
    auto local_pos = lpos();

    if (local_pos.unit != _pattern->team().myid()) {
      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);
  }

lpos()

DASH_CONSTEXPR auto dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::lpos ( ) const

inlineinherited

Unit and local offset at the iterator's position.

Definition at line 297 of file GlobIter.h.

  {
    DASH_LOG_TRACE_VAR("GlobIter.lpos()", _idx);

    index_type idx    = _idx;
    index_type offset = 0;

    // Convert iterator position (_idx) to local index and unit.
    if (idx > _max_idx) {
      idx    = _max_idx;
      offset = _idx - _max_idx;
      DASH_ASSERT_EQ(offset, 1, "invalid index");
    }
    // Global index to local index and unit:
    auto local_pos = _pattern->local(idx);
    // Add the offset
    local_pos.index += offset;

    DASH_LOG_TRACE(
        "GlobIter.lpos >",
        "unit:",
        local_pos.unit,
        "local index:",
        local_pos.index);

    return local_pos;
  }

ndim()

static constexpr dim_t dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::ndim ( )

inlinestaticinherited

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

Definition at line 158 of file GlobIter.h.

  {
    return NumDimensions;
  }

operator const_pointer()

DASH_CONSTEXPR dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator const_pointer ( ) const

inlineexplicitnoexceptinherited

<fuchsto> TODO: Conversion from iterator to pointer looks dubios

Type conversion operator to GlobPtr.

Returns

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

Definition at line 170 of file GlobIter.h.

  {
    return const_pointer(this->dart_gptr());
  }

operator pointer()

DASH_CONSTEXPR dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator pointer ( )

inlineexplicitinherited

<fuchsto> TODO: Conversion from iterator to pointer looks dubios

Type conversion operator to GlobPtr.

Returns

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

Definition at line 182 of file GlobIter.h.

  {
    return pointer(this->dart_gptr());
  }

operator*() [1/2]

DASH_CONSTEXPR reference dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator* ( )

inlinenoexceptinherited

Dereference operator.

Returns

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

Definition at line 226 of file GlobIter.h.

  {
    return reference{this->dart_gptr()};
  }

operator*() [2/2]

DASH_CONSTEXPR const_reference dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator* ( ) const

inlinenoexceptinherited

Dereference operator.

Returns

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

Definition at line 236 of file GlobIter.h.

  {
    return const_reference{this->dart_gptr()};
  }

operator++() [1/2]

DASH_CONSTEXPR self_t& dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator++ ( )

inlineinherited

Prefix increment operator.

Definition at line 370 of file GlobIter.h.

  {
    ++_idx;
    return *this;
  }

operator++() [2/2]

DASH_CONSTEXPR self_t dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator++ ( int  )

inlineinherited

Postfix increment operator.

Definition at line 379 of file GlobIter.h.

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

operator--() [1/2]

DASH_CONSTEXPR self_t& dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator-- ( )

inlineinherited

Prefix decrement operator.

Definition at line 389 of file GlobIter.h.

  {
    --_idx;
    return *this;
  }

operator--() [2/2]

DASH_CONSTEXPR self_t dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator-- ( int  )

inlineinherited

Postfix decrement operator.

Definition at line 398 of file GlobIter.h.

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

operator[]() [1/2]

DASH_CONSTEXPR reference dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator[] ( index_type  g_index )

inlinenoexceptinherited

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

Parameters

g_index

The global position of the element

Definition at line 245 of file GlobIter.h.

  {
    auto p = *this;
    p += g_index;
    return reference(p.dart_gptr());
  }

operator[]() [2/2]

DASH_CONSTEXPR const_reference dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::operator[] ( index_type  g_index ) const

inlinenoexceptinherited

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

Parameters

g_index

The global position of the element

Definition at line 258 of file GlobIter.h.

  {
    auto p = *this;
    p += g_index;
    return const_reference(p.dart_gptr());
  }

pos()

DASH_CONSTEXPR index_type dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType > , GlobAsyncRef< ElementType > , GlobRef<ElementType> >::pos ( ) const

inlineinherited

Position of the iterator in global index space.

Definition at line 336 of file GlobIter.h.

  {
    return _idx;
  }

push()

template<typename ElementType , class PatternType = Pattern<1>>

void dash::GlobAsyncIter< ElementType, PatternType >::push ( )

inline

Block until all non-blocking write operations that have been executed on this global iterator since the last call of wait have been published.

Does not guarantee remote completion.

Definition at line 71 of file GlobAsyncIter.h.

References dart_flush_local_all(), and dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType >, GlobAsyncRef< ElementType > >::dart_gptr().

  {
    dart_flush_local_all(this->dart_gptr());
  }

wait()

template<typename ElementType , class PatternType = Pattern<1>>

void dash::GlobAsyncIter< ElementType, PatternType >::wait ( )

inline

Wait for completion of non-blocking read- and write operations that have been executed on this global iterator since the last call of wait.

Definition at line 51 of file GlobAsyncIter.h.

References dart_flush_all(), and dash::GlobIter< ElementType, PatternType, GlobAsyncPtr< ElementType, PatternType >, GlobAsyncRef< ElementType > >::dart_gptr().

  {
    dart_flush_all(this->dart_gptr());
  }

---

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

• /tmp/tmporruphar/dash/include/dash/iterator/GlobAsyncIter.h