dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType > 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 map_t::pointer	pointer
typedef map_t::const_pointer	const_pointer
typedef map_t::reference	reference
typedef map_t::const_reference	const_reference
typedef value_type *	raw_pointer
typedef const value_type *	const_raw_pointer
typedef std::conditional< std::is_const< value_type >::value, typename map_t::const_local_iterator, typename map_t::local_iterator >::type	local_pointer

Public Member Functions
	UnorderedMapGlobIter ()
	Default constructor. More...
	UnorderedMapGlobIter (map_t *map, index_type position)
	Constructor, creates iterator at specified global position. More...
	UnorderedMapGlobIter (map_t *map, team_unit_t unit, index_type local_index)
	Constructor, creates iterator at local position relative to the specified unit's local iteration space. More...
	UnorderedMapGlobIter (const self_t &other)=default
	Copy constructor. More...
self_t &	operator= (const self_t &other)=default
	Assignment operator. More...
	UnorderedMapGlobIter (std::nullptr_t)
	Null-pointer constructor. More...
self_t &	operator= (std::nullptr_t) noexcept
	Null-pointer assignment operator. More...
constexpr bool	operator== (std::nullptr_t) const noexcept
constexpr bool	operator!= (std::nullptr_t) const noexcept
reference	operator[] (index_type offset)
	Random access operator. More...
constexpr	operator pointer () const
	Type conversion operator to global pointer. More...
constexpr 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...
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_iterator	local ()
	Conversion to local bucket iterator. More...
const_local_iterator	local () const
	Conversion to local bucket iterator. More...
local_index	lpos () const noexcept
	Unit and local offset at the iterator's position. More...
constexpr self_t	global () const noexcept
	Map iterator to global index domain. More...
constexpr index_type	pos () const noexcept
	Position of the iterator in global index space. More...
constexpr index_type	gpos () const noexcept
	Position of the iterator in global index range. 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_ >
constexpr bool	operator== (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
constexpr bool	operator!= (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept
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
constexpr index_type	operator+ (const self_t &other) const noexcept
constexpr index_type	operator- (const self_t &other) const noexcept
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
constexpr bool	operator< (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
constexpr bool	operator<= (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
constexpr bool	operator> (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept
template<typename K_ , typename M_ , typename H_ , typename P_ , typename A_ >
constexpr bool	operator>= (const UnorderedMapGlobIter< K_, M_, H_, P_, A_ > &other) const noexcept

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

Detailed Description

template<typename Key, typename Mapped, typename Hash, typename Pred, typename GlobMemType>
class dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >

Definition at line 41 of file UnorderedMapGlobIter.h.

Constructor & Destructor Documentation

UnorderedMapGlobIter() [1/5]

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

dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::UnorderedMapGlobIter ( )

inline

Default constructor.

Definition at line 99 of file UnorderedMapGlobIter.h.

  : UnorderedMapGlobIter(nullptr)
  { }

UnorderedMapGlobIter() [2/5]

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

dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::UnorderedMapGlobIter ( map_t *  map, index_type  position  )

inline

Constructor, creates iterator at specified global position.

Definition at line 106 of file UnorderedMapGlobIter.h.

  : _map(map),
    _idx(0),
    _myid(map->team().myid()),
    _idx_unit_id(0),
    _idx_local_idx(0)
  {
    DASH_LOG_TRACE_VAR("UnorderedMapGlobIter(map,pos)", _idx);
    increment(position);
    DASH_LOG_TRACE("UnorderedMapGlobIter(map,pos) >");
  }

UnorderedMapGlobIter() [3/5]

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

dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::UnorderedMapGlobIter ( map_t *  map, team_unit_t  unit, index_type  local_index  )

inline

Constructor, creates iterator at local position relative to the specified unit's local iteration space.

Definition at line 124 of file UnorderedMapGlobIter.h.

  : _map(map),
    _idx(0),
    _myid(map->team().myid()),
    _idx_unit_id(unit),
    _idx_local_idx(local_index)
  {
    DASH_LOG_TRACE("UnorderedMapGlobIter(map,unit,lidx)()");
    DASH_LOG_TRACE_VAR("UnorderedMapGlobIter(map,unit,lidx)", unit);
    DASH_LOG_TRACE_VAR("UnorderedMapGlobIter(map,unit,lidx)", local_index);
    // Unit and local offset to global position:
    size_type unit_l_cumul_size_prev = 0;
    if (unit > 0) {
      unit_l_cumul_size_prev = _map->_local_cumul_sizes[unit-1];
    }
    _idx = unit_l_cumul_size_prev + _idx_local_idx;
    DASH_LOG_TRACE_VAR("UnorderedMapGlobIter(map,unit,lidx)", _idx);
    DASH_LOG_TRACE("UnorderedMapGlobIter(map,unit,lidx) >");
  }

UnorderedMapGlobIter() [4/5]

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

dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::UnorderedMapGlobIter ( const self_t &  other )

default

Copy constructor.

UnorderedMapGlobIter() [5/5]

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

dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::UnorderedMapGlobIter ( std::nullptr_t  )

inline

Null-pointer constructor.

Definition at line 162 of file UnorderedMapGlobIter.h.

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

Member Function Documentation

dart_gptr()

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

constexpr dart_gptr_t dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::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 216 of file UnorderedMapGlobIter.h.

Referenced by dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator pointer(), and dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator*().

  {
    return _map->globmem().at(
                            _idx_unit_id,
                            _idx_local_idx
                           ).dart_gptr();
  }

global()

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

constexpr self_t dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::global ( ) const

inlinenoexcept

Map iterator to global index domain.

Definition at line 321 of file UnorderedMapGlobIter.h.

  {
    return *this;
  }

gpos()

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

constexpr index_type dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::gpos ( ) const

inlinenoexcept

Position of the iterator in global index range.

Definition at line 337 of file UnorderedMapGlobIter.h.

  {
    return _idx;
  }

is_local()

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

constexpr bool dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::is_local ( ) const

inlinenoexcept

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

Definition at line 278 of file UnorderedMapGlobIter.h.

Referenced by dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator*().

  {
    return (_myid == _idx_unit_id);
  }

local() [1/2]

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

local_iterator dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::local ( )

inline

Conversion to local bucket iterator.

Definition at line 286 of file UnorderedMapGlobIter.h.

Referenced by dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator*().

  {
    if (_myid != _idx_unit_id) {
      // Iterator position does not point to local element
      return local_iterator(nullptr);
    }
    return (_map->lbegin() + _idx_local_idx);
  }

local() [2/2]

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

const_local_iterator dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::local ( ) const

inline

Conversion to local bucket iterator.

Definition at line 298 of file UnorderedMapGlobIter.h.

  {
    if (_myid != _idx_unit_id) {
      // Iterator position does not point to local element
      return local_iterator(nullptr);
    }
    return (_map->lbegin() + _idx_local_idx);
  }

lpos()

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

local_index dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::lpos ( ) const

inlinenoexcept

Unit and local offset at the iterator's position.

Definition at line 310 of file UnorderedMapGlobIter.h.

  {
    local_index local_pos;
    local_pos.unit  = _idx_unit_id;
    local_pos.index = _idx_local_idx;
    return local_pos;
  }

operator pointer()

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

constexpr dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator pointer ( ) const

inline

Type conversion operator to global pointer.

Returns

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

Definition at line 205 of file UnorderedMapGlobIter.h.

References dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::dart_gptr().

  {
    return pointer(dart_gptr());
  }

operator*() [1/2]

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

reference dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator* ( )

inline

Dereference operator.

Returns

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

Definition at line 229 of file UnorderedMapGlobIter.h.

References dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::dart_gptr(), dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::is_local(), and dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::local().

  {
    if (is_local()) {
      // To local map iterator:
      auto l_map_it = local();
      DASH_ASSERT_MSG(l_map_it != nullptr,
                      "Converting global iterator at local position to "
                      "local iterator failed");
      // To native pointer via conversion:
      return reference(static_cast<raw_pointer>(l_map_it));
    } else {
      return reference(dart_gptr());
    }
  }

operator*() [2/2]

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

const_reference dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator* ( ) const

inline

Dereference operator.

Returns

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

Definition at line 249 of file UnorderedMapGlobIter.h.

References dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::dart_gptr(), dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::is_local(), and dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::local().

  {
    if (is_local()) {
      // To local map iterator:
      auto l_map_it = local();
      DASH_ASSERT_MSG(l_map_it != nullptr,
                      "Converting global iterator at local position to "
                      "local iterator failed");
      // To native pointer via conversion:
      return reference(static_cast<raw_pointer>(l_map_it));
    } else {
      return reference(dart_gptr());
    }
  }

operator++() [1/2]

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

self_t& dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator++ ( )

inline

Prefix increment operator.

Definition at line 345 of file UnorderedMapGlobIter.h.

  {
    increment(1);
    return *this;
  }

operator++() [2/2]

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

self_t dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 363 of file UnorderedMapGlobIter.h.

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

operator--() [1/2]

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

self_t& dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 354 of file UnorderedMapGlobIter.h.

  {
    decrement(1);
    return *this;
  }

operator--() [2/2]

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

self_t dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::operator-- ( int  )

inline

Postfix decrement operator.

Definition at line 373 of file UnorderedMapGlobIter.h.

References dash::operator<(), dash::operator<=(), dash::operator>(), and dash::operator>=().

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

operator=() [1/2]

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

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

default

Assignment operator.

operator=() [2/2]

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

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

inlinenoexcept

Null-pointer assignment operator.

Definition at line 174 of file UnorderedMapGlobIter.h.

  {
    _is_nullptr = true;
    return *this;
  }

operator[]()

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

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

inline

Random access operator.

Definition at line 193 of file UnorderedMapGlobIter.h.

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

pos()

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

constexpr index_type dash::UnorderedMapGlobIter< Key, Mapped, Hash, Pred, GlobMemType >::pos ( ) const

inlinenoexcept

Position of the iterator in global index space.

Definition at line 329 of file UnorderedMapGlobIter.h.

  {
    return _idx;
  }

---

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

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