dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace > Class Template Reference

Classes
struct	local_index

Public Types
typedef map_t::value_type	value_type
typedef dash::default_index_t	index_type
typedef dash::default_size_t	size_type
typedef value_type *	pointer
typedef const value_type *	const_pointer
typedef value_type &	reference
typedef const value_type &	const_reference

Public Member Functions
	UnorderedMapLocalIter ()
	Default constructor. More...
	UnorderedMapLocalIter (map_t *map, index_type local_position)
	Constructor, creates iterator at specified global position. More...
	UnorderedMapLocalIter (const self_t &other)=default
	Copy constructor. More...
self_t &	operator= (const self_t &other)=default
	Assignment operator. More...
	UnorderedMapLocalIter (std::nullptr_t)
	Null-pointer constructor. More...
self_t &	operator= (std::nullptr_t) noexcept
	Null-pointer assignment operator. More...
bool	operator== (std::nullptr_t) const noexcept
bool	operator!= (std::nullptr_t) const noexcept
reference	operator[] (index_type offset)
	Random access operator. More...
	operator pointer () const
	Type conversion operator to native pointer. More...
reference	operator* () const
	Dereference operator. More...
dart_gptr_t	dart_gptr () const
	Explicit conversion to dart_gptr_t. More...
constexpr bool	is_local () const noexcept
	Checks whether the element referenced by this global iterator is in the calling unit's local memory. More...
local_index	lpos () const noexcept
	Unit and local offset at the iterator's position. More...
index_type	pos () const noexcept
	Position of the iterator in global index space. More...
self_t &	operator++ ()
	Prefix increment operator. More...
self_t &	operator-- ()
	Prefix decrement operator. More...
self_t	operator++ (int)
	Postfix increment operator. More...
self_t	operator-- (int)
	Postfix decrement operator. More...
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator== (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator!= (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const
self_t &	operator+= (index_type offset)
self_t &	operator-= (index_type offset)
self_t	operator+ (index_type offset) const
self_t	operator- (index_type offset) const
index_type	operator+ (const self_t &other) const
index_type	operator- (const self_t &other) const
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator< (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator<= (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator> (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
bool	operator>= (const UnorderedMapLocalIter< K_, M_, H_, P_, A_ > &other) const

Friends
template<typename K_ , typename M_ , typename H_ , typename P_ , typename LM_ >
std::ostream &	dash::operator<< (std::ostream &os, const dash::UnorderedMapLocalIter< K_, M_, H_, P_, LM_ > &it)

Detailed Description

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>
class dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >

Definition at line 40 of file UnorderedMapLocalIter.h.

Constructor & Destructor Documentation

UnorderedMapLocalIter() [1/4]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter ( )

inline

Default constructor.

Definition at line 84 of file UnorderedMapLocalIter.h.

Referenced by dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter().

  : UnorderedMapLocalIter(nullptr)
  { }

UnorderedMapLocalIter() [2/4]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter ( map_t *  map, index_type  local_position  )

inline

Constructor, creates iterator at specified global position.

Definition at line 91 of file UnorderedMapLocalIter.h.

References dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator=(), and dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter().

  : _map(map),
    _idx(local_position),
    _myid(dash::Team::GlobalUnitID())
  {
    DASH_LOG_TRACE("UnorderedMapLocalIter(map,lpos)()");
    DASH_LOG_TRACE_VAR("UnorderedMapLocalIter(map,lpos)", _idx);
    DASH_LOG_TRACE("UnorderedMapLocalIter(map,lpos) >");
  }

UnorderedMapLocalIter() [3/4]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter ( const self_t &  other )

default

Copy constructor.

UnorderedMapLocalIter() [4/4]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter ( std::nullptr_t  )

inline

Null-pointer constructor.

Definition at line 118 of file UnorderedMapLocalIter.h.

    : _map(nullptr)
    , _myid(DART_UNDEFINED_UNIT_ID)
    , _is_nullptr(true)
  {
    DASH_LOG_TRACE("UnorderedMapLocalIter(nullptr)");
  }

Member Function Documentation

dart_gptr()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dart_gptr_t dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::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 195 of file UnorderedMapLocalIter.h.

References dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::at(), dash::GlobHeapPtr< ElementType, MemSpaceT >::dart_gptr(), DART_GPTR_NULL, and dash::UnorderedMap< Key, Mapped, Hash, Pred, LocalMemType >::globmem().

  {
    DASH_LOG_TRACE_VAR("UnorderedMapLocalIter.dart_gptr()", _idx);
    dart_gptr_t dart_gptr = DART_GPTR_NULL;
    if (!_is_nullptr) {
      dart_gptr = _map->globmem().at(_myid, _idx).dart_gptr();
    }
    DASH_LOG_TRACE_VAR("UnorderedMapLocalIter.dart_gptr >", dart_gptr);
    return dart_gptr;
  }

is_local()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

constexpr bool dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::is_local ( ) const

inlinenoexcept

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

Definition at line 210 of file UnorderedMapLocalIter.h.

  {
    return true;
  }

lpos()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

local_index dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::lpos ( ) const

inlinenoexcept

Unit and local offset at the iterator's position.

Definition at line 218 of file UnorderedMapLocalIter.h.

  {
    local_index local_pos;
    local_pos.unit  = _myid;
    local_pos.index = _idx;
    return local_pos;
  }

operator pointer()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator pointer ( ) const

inlineexplicit

Type conversion operator to native pointer.

Returns

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

Definition at line 160 of file UnorderedMapLocalIter.h.

References dash::UnorderedMap< Key, Mapped, Hash, Pred, LocalMemType >::globmem(), and dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::lbegin().

  {
    typedef typename map_t::local_node_iterator local_iter_t;
    if (_is_nullptr) {
      return nullptr;
    }
    // TODO: Must be extended for correctness: _idx refers to local iteration
    //       space, not local memory space. Undefined behaviour if local
    //       memory space has gaps, e.g. after erasing elements.
    local_iter_t l_it = _map->globmem().lbegin();
    return pointer(l_it + static_cast<index_type>(_idx));
  }

operator*()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

reference dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator* ( ) const

inline

Dereference operator.

Returns

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

Definition at line 178 of file UnorderedMapLocalIter.h.

References dash::UnorderedMap< Key, Mapped, Hash, Pred, LocalMemType >::globmem(), and dash::GlobHeapMem< ElementType, LocalMemorySpace, AllocationPolicy, LocalAlloc >::lbegin().

  {
    typedef typename map_t::local_node_iterator local_iter_t;
    DASH_ASSERT(!_is_nullptr);
    // TODO: Must be extended for correctness: _idx refers to local iteration
    //       space, not local memory space. Undefined behaviour if local
    //       memory space has gaps, e.g. after erasing elements.
    local_iter_t l_it = _map->globmem().lbegin();
    return *pointer(l_it + static_cast<index_type>(_idx));
  }

operator++() [1/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t& dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator++ ( )

inline

Prefix increment operator.

Definition at line 237 of file UnorderedMapLocalIter.h.

  {
    increment(1);
    return *this;
  }

operator++() [2/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 255 of file UnorderedMapLocalIter.h.

  {
    auto result = *this;
    increment(1);
    return result;
  }

operator--() [1/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t& dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 246 of file UnorderedMapLocalIter.h.

  {
    decrement(1);
    return *this;
  }

operator--() [2/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator-- ( int  )

inline

Postfix decrement operator.

Definition at line 265 of file UnorderedMapLocalIter.h.

References DART_UNDEFINED_TEAM_UNIT_ID.

  {
    auto result = *this;
    decrement(1);
    return result;
  }

operator=() [1/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t& dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator= ( const self_t &  other )

default

Assignment operator.

Referenced by dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::UnorderedMapLocalIter().

operator=() [2/2]

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

self_t& dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator= ( std::nullptr_t  )

inlinenoexcept

Null-pointer assignment operator.

Definition at line 129 of file UnorderedMapLocalIter.h.

  {
    _is_nullptr = true;
    return *this;
  }

operator[]()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

reference dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::operator[] ( index_type  offset )

inline

Random access operator.

Definition at line 148 of file UnorderedMapLocalIter.h.

  {
    auto res = *this;
    res += offset;
    return *this;
  }

pos()

template<typename Key, typename Mapped, typename Hash, typename Pred, typename LMemSpace>

index_type dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::pos ( ) const

inlinenoexcept

Position of the iterator in global index space.

Definition at line 229 of file UnorderedMapLocalIter.h.

  {
    return _idx;
  }

---

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

• /tmp/tmporruphar/dash/include/dash/map/UnorderedMapLocalIter.h