dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType > Class Template Reference

Bi-directional global iterator on elements of a dash::List instance. More...

#include <GlobListIter.h>

Public Types
typedef ElementType	value_type
typedef ReferenceType	reference
typedef const ReferenceType	const_reference
typedef PointerType	pointer
typedef const PointerType	const_pointer
typedef GlobMemType::local_pointer	local_pointer
typedef internal::ListNode< value_type >	node_type
typedef std::integral_constant< bool, false >	has_view

Public Member Functions
	GlobListIter ()=default
	Default constructor. More...
	GlobListIter (GlobMemType *gmem, node_type &node)
	Constructor, creates a global iterator on a dash::List instance. More...
	GlobListIter (const self_t &other)=default
	Copy constructor. More...
self_t &	operator= (const self_t &other)=default
	Assignment operator. More...
	operator pointer () const
	Type conversion operator to pointer type. More...
reference	operator* ()
	Dereference operator. More...
const_reference	operator* () const
	Dereference operator. More...
self_t	global () const
	Map iterator to global index domain. More...
constexpr bool	is_relative () const noexcept
	Whether the iterator's position is relative to a view. More...
const GlobMemType &	globmem () const
	The instance of GlobStaticMem used by this iterator to resolve addresses in global memory. More...
GlobMemType &	globmem ()
	The instance of GlobStaticMem used by this iterator to resolve addresses in global memory. More...
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...
bool	operator== (const self_t &other) const
	Equality comparison operator. More...
bool	operator!= (const self_t &other) const
	Inequality comparison operator. More...

Detailed Description

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>
class dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >

Bi-directional global iterator on elements of a dash::List instance.

Implemented concept:

List Concept

Implemented concept:

Global Iterator Concept

Definition at line 25 of file GlobListIter.h.

Constructor & Destructor Documentation

GlobListIter() [1/3]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::GlobListIter ( )

default

Default constructor.

Referenced by dash::GlobListIter< value_type, glob_mem_type >::GlobListIter().

GlobListIter() [2/3]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::GlobListIter ( GlobMemType *  gmem, node_type &  node  )

inline

Constructor, creates a global iterator on a dash::List instance.

Definition at line 64 of file GlobListIter.h.

  : _globmem(gmem),
    _node(&node),
    _myid(dash::Team::GlobalUnitID())
  {
    DASH_LOG_TRACE("GlobListIter(gmem,node,pat)");
  }

GlobListIter() [3/3]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::GlobListIter ( const self_t &  other )

default

Copy constructor.

Member Function Documentation

global()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

self_t dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::global ( ) const

inline

Map iterator to global index domain.

Definition at line 121 of file GlobListIter.h.

  {
    return *this;
  }

globmem() [1/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

const GlobMemType& dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::globmem ( ) const

inline

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

Definition at line 142 of file GlobListIter.h.

  {
    return *_globmem;
  }

globmem() [2/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

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

Definition at line 151 of file GlobListIter.h.

  {
    return *_globmem;
  }

is_relative()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

constexpr bool dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::is_relative ( ) const

inlinenoexcept

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

TODO: should be iterator trait: dash::iterator_traits<GlobListIter<..>>::is_relative()::value

Definition at line 133 of file GlobListIter.h.

  {
    return false;
  }

operator pointer()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::operator pointer ( ) const

inline

Type conversion operator to pointer type.

Returns

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

Definition at line 91 of file GlobListIter.h.

  {
    pointer ptr;
    // TODO
    return ptr;
  }

operator!=()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

bool dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::operator!= ( const self_t &  other ) const

inline

Inequality comparison operator.

Definition at line 205 of file GlobListIter.h.

  {
    return _node != other._node;
  }

operator*() [1/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Dereference operator.

Returns

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

Definition at line 103 of file GlobListIter.h.

  {
    return reference(this);
  }

operator*() [2/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Dereference operator.

Returns

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

Definition at line 114 of file GlobListIter.h.

  {
  }

operator++() [1/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Prefix increment operator.

Definition at line 159 of file GlobListIter.h.

  {
    increment();
    return *this;
  }

operator++() [2/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Postfix increment operator.

Definition at line 168 of file GlobListIter.h.

  {
    self_t result = *this;
    increment();
    return result;
  }

operator--() [1/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Prefix decrement operator.

Definition at line 178 of file GlobListIter.h.

  {
    decrement();
    return *this;
  }

operator--() [2/2]

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

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

inline

Postfix decrement operator.

Definition at line 187 of file GlobListIter.h.

  {
    self_t result = *this;
    decrement();
    return result;
  }

operator=()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

self_t& dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::operator= ( const self_t &  other )

default

Assignment operator.

Referenced by dash::GlobListIter< value_type, glob_mem_type >::GlobListIter().

operator==()

template<typename ElementType, class GlobMemType, class PointerType = GlobPtr<ElementType, GlobMemType>, class ReferenceType = GlobRef<ElementType>>

bool dash::GlobListIter< ElementType, GlobMemType, PointerType, ReferenceType >::operator== ( const self_t &  other ) const

inline

Equality comparison operator.

Definition at line 197 of file GlobListIter.h.

  {
    return _node == other._node;
  }

---

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

• /tmp/tmporruphar/dash/include/dash/list/GlobListIter.h