dash::GlobHeapPtr< ElementType, MemSpaceT > Class Template Reference

Iterator on global buckets. More...

#include <GlobHeapPtr.h>

Classes
struct	local_index

Public Types
typedef GlobHeapMemType::index_type	index_type
typedef std::make_unsigned< index_type >::type	size_type
typedef ElementType	value_type
typedef GlobSharedRef< value_type, self_t >	reference
typedef GlobSharedRef< const value_type, self_t >	const_reference
typedef value_type *	raw_pointer
typedef GlobHeapMemType	globmem_type
typedef GlobHeapMemType::local_pointer	local_pointer
template<typename U >
using	rebind = GlobHeapPtr< U, MemSpaceT >

Public Member Functions
	GlobHeapPtr ()
	Default constructor. More...
	GlobHeapPtr (const MemSpaceT *gmem, index_type position=0)
	Constructor, creates a global pointer on global memory from global offset in logical storage order. More...
	GlobHeapPtr (const MemSpaceT *gmem, team_unit_t unit, index_type local_index)
	Constructor, creates a global pointer on global memory from unit and local offset in logical storage order. More...
template<typename E_ , typename M_ >
	GlobHeapPtr (const GlobHeapPtr< E_, M_ > &other)
	Copy constructor. More...
template<typename E_ , typename M_ >
self_t &	operator= (const GlobHeapPtr< E_, M_ > &other)
	Assignment operator. More...
dart_gptr_t	dart_gptr () const
	Explicit conversion to dart_gptr_t. More...
reference	operator* () const
	Dereference operator. More...
reference	operator[] (index_type g_index) const
	Subscript operator, returns global reference to element at given global index. More...
bool	is_local () const
	Checks whether the element referenced by this global pointer is in the calling unit's local memory. More...
local_pointer	local () const
	Conversion to local bucket pointer. More...
local_index	lpos () const
	Unit and local offset at the pointer's position. More...
self_t	global () const
	Map pointer to global index domain. More...
index_type	pos () const
	Position of the pointer in global index space. More...
index_type	gpos () const
	Position of the pointer in global index range. More...
const globmem_type &	globmem () const
	The instance of GlobStaticMem used by this pointer to resolve addresses in global memory. More...
globmem_type &	globmem ()
	The instance of GlobStaticMem used by this pointer to resolve addresses in global memory. 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...
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 E_ , typename M_ >
bool	operator< (const GlobHeapPtr< E_, M_ > &other) const
template<typename E_ , typename M_ >
bool	operator<= (const GlobHeapPtr< E_, M_ > &other) const
template<typename E_ , typename M_ >
bool	operator> (const GlobHeapPtr< E_, M_ > &other) const
template<typename E_ , typename M_ >
bool	operator>= (const GlobHeapPtr< E_, M_ > &other) const
template<typename E_ , typename M_ >
bool	operator== (const GlobHeapPtr< E_, M_ > &other) const
template<typename E_ , typename M_ >
bool	operator!= (const GlobHeapPtr< E_, M_ > &other) const

Friends
template<typename ElementType_ , class MemSpaceT_ >
std::ostream &	operator<< (std::ostream &os, const dash::GlobHeapPtr< ElementType_, MemSpaceT_ > &gptr)

Detailed Description

template<typename ElementType, class MemSpaceT>
class dash::GlobHeapPtr< ElementType, MemSpaceT >

Iterator on global buckets.

Represents global pointer type.

Definition at line 32 of file GlobHeapMem.h.

Constructor & Destructor Documentation

GlobHeapPtr() [1/4]

template<typename ElementType, class MemSpaceT>

dash::GlobHeapPtr< ElementType, MemSpaceT >::GlobHeapPtr ( )

inline

Default constructor.

Definition at line 90 of file GlobHeapPtr.h.

  : _globmem(nullptr),
    _bucket_cumul_sizes(nullptr),
    _idx(0),
    _max_idx(0),
    _myid(dash::Team::GlobalUnitID()),
    _idx_unit_id(DART_UNDEFINED_UNIT_ID),
    _idx_local_idx(-1),
    _idx_bucket_idx(-1),
    _idx_bucket_phase(-1)
  {
    DASH_LOG_TRACE_VAR("GlobHeapPtr()", _idx);
    DASH_LOG_TRACE_VAR("GlobHeapPtr()", _max_idx);
  }

GlobHeapPtr() [2/4]

template<typename ElementType, class MemSpaceT>

dash::GlobHeapPtr< ElementType, MemSpaceT >::GlobHeapPtr ( const MemSpaceT *  gmem, index_type  position = 0  )

inline

Constructor, creates a global pointer on global memory from global offset in logical storage order.

Definition at line 109 of file GlobHeapPtr.h.

  : _globmem(reinterpret_cast<const globmem_type *>(gmem)),
    _bucket_cumul_sizes(&_globmem->_bucket_cumul_sizes),
    _lbegin(_globmem->lbegin()),
    _idx(position),
    _max_idx(gmem->size() - 1),
    _myid(gmem->team().myid()),
    _idx_unit_id(0),
    _idx_local_idx(0),
    _idx_bucket_idx(0),
    _idx_bucket_phase(0)
  {
    DASH_LOG_TRACE("GlobHeapPtr(gmem,idx)", "gidx:", position);
    for (auto unit_bucket_cumul_sizes : *_bucket_cumul_sizes) {
      DASH_LOG_TRACE_VAR("GlobHeapPtr(gmem,idx)",
                         unit_bucket_cumul_sizes);
      size_type bucket_cumul_size_prev = 0;
      for (auto bucket_cumul_size : unit_bucket_cumul_sizes) {
        DASH_LOG_TRACE_VAR("GlobHeapPtr(gmem,idx)", bucket_cumul_size);
        if (position < bucket_cumul_size) {
          DASH_LOG_TRACE_VAR("GlobHeapPtr(gmem,idx)", position);
          _idx_bucket_phase -= bucket_cumul_size;
          position           = 0;
          _idx_local_idx     = position;
          _idx_bucket_phase  = position - bucket_cumul_size_prev;
          break;
        }
        bucket_cumul_size_prev = bucket_cumul_size;
        ++_idx_bucket_idx;
      }
      if (position == 0) {
        break;
      }
      // Advance to next unit, adjust position relative to next unit's
      // local index space:
      position -= unit_bucket_cumul_sizes.back();
      ++_idx_unit_id;
    }
    DASH_LOG_TRACE("GlobHeapPtr(gmem,idx)",
                   "gidx:",   _idx,
                   "unit:",   _idx_unit_id,
                   "lidx:",   _idx_local_idx,
                   "bucket:", _idx_bucket_idx,
                   "phase:",  _idx_bucket_phase);
  }

GlobHeapPtr() [3/4]

template<typename ElementType, class MemSpaceT>

dash::GlobHeapPtr< ElementType, MemSpaceT >::GlobHeapPtr ( const MemSpaceT *  gmem, team_unit_t  unit, index_type  local_index  )

inline

Constructor, creates a global pointer on global memory from unit and local offset in logical storage order.

Definition at line 161 of file GlobHeapPtr.h.

  : _globmem(reinterpret_cast<const globmem_type *>(gmem)),
    _bucket_cumul_sizes(&_globmem->_bucket_cumul_sizes),
    _lbegin(_globmem->lbegin()),
    _idx(0),
    _max_idx(gmem->size() - 1),
    _myid(gmem->team().myid()),
    _idx_unit_id(unit),
    _idx_local_idx(0),
    _idx_bucket_idx(0),
    _idx_bucket_phase(0)
  {
    DASH_LOG_TRACE("GlobHeapPtr(gmem,unit,lidx)",
                   "unit:", unit,
                   "lidx:", local_index);
    DASH_ASSERT_LT(unit, _bucket_cumul_sizes->size(), "invalid unit id");

    for (size_type unit = 0; unit < _idx_unit_id; ++unit) {
      auto prec_unit_local_size = (*_bucket_cumul_sizes)[unit].back();
      _idx += prec_unit_local_size;
    }
    increment(local_index);
    DASH_LOG_TRACE("GlobHeapPtr(gmem,unit,lidx) >",
                   "gidx:",   _idx,
                   "maxidx:", _max_idx,
                   "unit:",   _idx_unit_id,
                   "lidx:",   _idx_local_idx,
                   "bucket:", _idx_bucket_idx,
                   "phase:",  _idx_bucket_phase);
  }

GlobHeapPtr() [4/4]

template<typename ElementType, class MemSpaceT>

template<typename E_ , typename M_ >

dash::GlobHeapPtr< ElementType, MemSpaceT >::GlobHeapPtr ( const GlobHeapPtr< E_, M_ > &  other )

inline

Copy constructor.

Definition at line 199 of file GlobHeapPtr.h.

  : _globmem(other._globmem),
    _bucket_cumul_sizes(other._bucket_cumul_sizes),
    _lbegin(other._lbegin),
    _idx(other._idx),
    _max_idx(other._max_idx),
    _idx_unit_id(other._idx_unit_id),
    _idx_local_idx(other._idx_local_idx),
    _idx_bucket_idx(other._idx_bucket_idx),
    _idx_bucket_phase(other._idx_bucket_phase)
  { }

Member Function Documentation

dart_gptr()

template<typename ElementType, class MemSpaceT>

dart_gptr_t dash::GlobHeapPtr< ElementType, MemSpaceT >::dart_gptr ( ) const

inline

Explicit conversion to dart_gptr_t.

Returns

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

Definition at line 236 of file GlobHeapPtr.h.

Referenced by dash::UnorderedMapLocalIter< Key, Mapped, Hash, Pred, LMemSpace >::dart_gptr(), and dash::GlobHeapPtr< ElementType, MemSpaceT >::operator*().

  {
    DASH_LOG_TRACE_VAR("GlobHeapPtr.dart_gptr()", _idx);
    // Create global pointer from unit, bucket and phase:
    dart_gptr_t dart_gptr = _globmem->dart_gptr_at(
                              _idx_unit_id,
                              _idx_bucket_idx,
                              _idx_bucket_phase);
    DASH_LOG_TRACE_VAR("GlobHeapPtr.dart_gptr >", dart_gptr);
    return dart_gptr;
  }

global()

template<typename ElementType, class MemSpaceT>

self_t dash::GlobHeapPtr< ElementType, MemSpaceT >::global ( ) const

inline

Map pointer to global index domain.

Definition at line 319 of file GlobHeapPtr.h.

  {
    return *this;
  }

globmem() [1/2]

template<typename ElementType, class MemSpaceT>

const globmem_type& dash::GlobHeapPtr< ElementType, MemSpaceT >::globmem ( ) const

inline

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

Definition at line 344 of file GlobHeapPtr.h.

  {
    return *_globmem;
  }

globmem() [2/2]

template<typename ElementType, class MemSpaceT>

globmem_type& dash::GlobHeapPtr< ElementType, MemSpaceT >::globmem ( )

inline

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

Definition at line 353 of file GlobHeapPtr.h.

  {
    return *_globmem;
  }

gpos()

template<typename ElementType, class MemSpaceT>

index_type dash::GlobHeapPtr< ElementType, MemSpaceT >::gpos ( ) const

inline

Position of the pointer in global index range.

Definition at line 335 of file GlobHeapPtr.h.

  {
    return _idx;
  }

is_local()

template<typename ElementType, class MemSpaceT>

bool dash::GlobHeapPtr< ElementType, MemSpaceT >::is_local ( ) const

inline

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

Definition at line 288 of file GlobHeapPtr.h.

  {
    return (_myid == _idx_unit_id);
  }

local()

template<typename ElementType, class MemSpaceT>

local_pointer dash::GlobHeapPtr< ElementType, MemSpaceT >::local ( ) const

inline

Conversion to local bucket pointer.

Definition at line 296 of file GlobHeapPtr.h.

Referenced by dash::GlobHeapPtr< ElementType, MemSpaceT >::operator*().

  {
    if (_myid != _idx_unit_id) {
      // Iterator position does not point to local element
      return nullptr;
    }
    return (_lbegin + _idx_local_idx);
  }

lpos()

template<typename ElementType, class MemSpaceT>

local_index dash::GlobHeapPtr< ElementType, MemSpaceT >::lpos ( ) const

inline

Unit and local offset at the pointer's position.

Definition at line 308 of file GlobHeapPtr.h.

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

operator*()

template<typename ElementType, class MemSpaceT>

reference dash::GlobHeapPtr< ElementType, MemSpaceT >::operator* ( ) const

inline

Dereference operator.

Returns

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

Definition at line 253 of file GlobHeapPtr.h.

References dash::GlobHeapPtr< ElementType, MemSpaceT >::dart_gptr(), and dash::GlobHeapPtr< ElementType, MemSpaceT >::local().

  {
    auto lptr = local();
    if (lptr != nullptr) {
      return reference(static_cast<raw_pointer>(lptr));
    } else {
      return reference(dart_gptr());
    }
  }

operator++() [1/2]

template<typename ElementType, class MemSpaceT>

self_t& dash::GlobHeapPtr< ElementType, MemSpaceT >::operator++ ( )

inline

Prefix increment operator.

Definition at line 361 of file GlobHeapPtr.h.

  {
    increment(1);
    return *this;
  }

operator++() [2/2]

template<typename ElementType, class MemSpaceT>

self_t dash::GlobHeapPtr< ElementType, MemSpaceT >::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 379 of file GlobHeapPtr.h.

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

operator--() [1/2]

template<typename ElementType, class MemSpaceT>

self_t& dash::GlobHeapPtr< ElementType, MemSpaceT >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 370 of file GlobHeapPtr.h.

  {
    decrement(1);
    return *this;
  }

operator--() [2/2]

template<typename ElementType, class MemSpaceT>

self_t dash::GlobHeapPtr< ElementType, MemSpaceT >::operator-- ( int  )

inline

Postfix decrement operator.

Definition at line 389 of file GlobHeapPtr.h.

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

operator=()

template<typename ElementType, class MemSpaceT>

template<typename E_ , typename M_ >

self_t& dash::GlobHeapPtr< ElementType, MemSpaceT >::operator= ( const GlobHeapPtr< E_, M_ > &  other )

inline

Assignment operator.

Definition at line 216 of file GlobHeapPtr.h.

  {
    _globmem            = other._globmem;
    _bucket_cumul_sizes = other._bucket_cumul_sizes;
    _lbegin             = other._lbegin;
    _idx                = other._idx;
    _max_idx            = other._max_idx;
    _idx_unit_id        = other._idx_unit_id;
    _idx_local_idx      = other._idx_local_idx;
    _idx_bucket_idx     = other._idx_bucket_idx;
    _idx_bucket_phase   = other._idx_bucket_phase;
  }

operator[]()

template<typename ElementType, class MemSpaceT>

reference dash::GlobHeapPtr< ElementType, MemSpaceT >::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 267 of file GlobHeapPtr.h.

  {
    DASH_LOG_TRACE_VAR("GlobHeapPtr.[]()", g_index);
    auto git = *this;
    git  += g_index;
    auto lptr = git.local();
    if (lptr != nullptr) {
      return reference(lptr);
    } else {
      auto gref = *git;
      DASH_LOG_TRACE_VAR("GlobHeapPtr.[] >", gref);
      return gref;
    }
  }

pos()

template<typename ElementType, class MemSpaceT>

index_type dash::GlobHeapPtr< ElementType, MemSpaceT >::pos ( ) const

inline

Position of the pointer in global index space.

Definition at line 327 of file GlobHeapPtr.h.

  {
    return _idx;
  }

---

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

• /tmp/tmporruphar/dash/include/dash/memory/GlobHeapMem.h
• /tmp/tmporruphar/dash/include/dash/memory/GlobHeapPtr.h