dash::GlobSharedRef< T, GlobalPointerType > Class Template Reference

Classes
struct	rebind
	Convert GlobSharedRef<T, GlobalPointer<T>> to GlobSharedRef<U, GlobalPointer<U>>. More...

Public Types
typedef GlobalPointerType	global_pointer
typedef GlobalPointerType	const_global_pointer
typedef T *	local_pointer
typedef const T *	const_local_pointer

Public Member Functions
	GlobSharedRef ()
	Default constructor, creates an GlobSharedRef object referencing an element in global memory. More...
	GlobSharedRef (dart_gptr_t gptr, local_pointer lptr)
	Constructor, creates an GlobSharedRef object referencing an element in global memory. More...
template<class GlobalType >
	GlobSharedRef (GlobalType &gptr, local_pointer lptr=nullptr)
	Constructor, creates an GlobSharedRef object referencing an element in global memory. More...
	GlobSharedRef (local_pointer lptr)
	Constructor, creates an GlobSharedRef object referencing an element in global memory. More...
	GlobSharedRef (dart_gptr_t dart_gptr)
	Constructor, creates an GlobSharedRef object referencing an element in global memory. More...
	GlobSharedRef (const self_t &other)
	Copy constructor. More...
self_t &	operator= (const self_t &other)
	Assignment operator. More...
bool	operator== (const self_t &other) const noexcept
bool	operator!= (const self_t &other) const noexcept
	operator T () const
T	get () const
void	put (T &val) const
self_t &	operator= (const T val)
GlobSharedRef< T, GlobalPointerType > &	operator+= (const T &ref)
self_t &	operator-= (const T &ref)
self_t &	operator++ ()
self_t	operator++ (int)
self_t &	operator-- ()
self_t	operator-- (int)
self_t &	operator*= (const T &ref)
self_t &	operator/= (const T &ref)
self_t &	operator^= (const T &ref)
dart_gptr_t	dart_gptr () const
local_pointer	local () const
bool	is_local () const
	Checks whether the globally referenced element is in the calling unit's local memory. More...

Friends
template<typename U , typename P >
std::ostream &	operator<< (std::ostream &os, const GlobSharedRef< U, P > &gref)

Detailed Description

template<typename T, typename GlobalPointerType>
class dash::GlobSharedRef< T, GlobalPointerType >

Definition at line 18 of file GlobSharedRef.h.

Constructor & Destructor Documentation

GlobSharedRef() [1/6]

template<typename T, typename GlobalPointerType>

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( )

inline

Default constructor, creates an GlobSharedRef object referencing an element in global memory.

Definition at line 58 of file GlobSharedRef.h.

Referenced by dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef().

  : _gptr(DART_GPTR_NULL),
    _lptr(nullptr)
  { }

GlobSharedRef() [2/6]

template<typename T, typename GlobalPointerType>

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( dart_gptr_t  gptr, local_pointer  lptr  )

inlineexplicit

Constructor, creates an GlobSharedRef object referencing an element in global memory.

Parameters

gptr	Pointer to referenced object in global memory

Definition at line 67 of file GlobSharedRef.h.

  : _gptr(gptr),
    _lptr(lptr)
  {
    DASH_LOG_TRACE_VAR("GlobSharedRef(gptr,lptr)", gptr);
    DASH_LOG_TRACE_VAR("GlobSharedRef(gptr,lptr)", lptr);
  }

GlobSharedRef() [3/6]

template<typename T, typename GlobalPointerType>

template<class GlobalType >

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( GlobalType &  gptr, local_pointer  lptr = nullptr  )

inline

Constructor, creates an GlobSharedRef object referencing an element in global memory.

Parameters

gptr	Pointer to referenced object in global memory

Definition at line 83 of file GlobSharedRef.h.

  : _gptr(gptr.dart_gptr()),
    _lptr(lptr)
  {
    DASH_LOG_TRACE_VAR("GlobSharedRef(gptr,lptr)", gptr);
    DASH_LOG_TRACE_VAR("GlobSharedRef(gptr,lptr)", lptr);
  }

GlobSharedRef() [4/6]

template<typename T, typename GlobalPointerType>

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( local_pointer  lptr )

inline

Constructor, creates an GlobSharedRef object referencing an element in global memory.

Parameters

lptr	Pointer to referenced object in global memory

Definition at line 98 of file GlobSharedRef.h.

  : _gptr(DART_GPTR_NULL),
    _lptr(lptr)
  {
    DASH_LOG_TRACE_VAR("GlobSharedRef(lptr)", lptr);
  }

GlobSharedRef() [5/6]

template<typename T, typename GlobalPointerType>

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( dart_gptr_t  dart_gptr )

inlineexplicit

Constructor, creates an GlobSharedRef object referencing an element in global memory.

Definition at line 111 of file GlobSharedRef.h.

  : _gptr(dart_gptr),
    _lptr(nullptr)
  {
    DASH_LOG_TRACE_VAR("GlobSharedRef(dart_gptr_t)", dart_gptr);
  }

GlobSharedRef() [6/6]

template<typename T, typename GlobalPointerType>

dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef ( const self_t &  other )

inline

Copy constructor.

Parameters

other

GlobSharedRef instance to copy.

Definition at line 121 of file GlobSharedRef.h.

References dash::GlobSharedRef< T, GlobalPointerType >::GlobSharedRef().

  : _gptr(other._gptr),
    _lptr(other._lptr)
  { }

Member Function Documentation

is_local()

template<typename T, typename GlobalPointerType>

bool dash::GlobSharedRef< T, GlobalPointerType >::is_local ( ) const

inline

Checks whether the globally referenced element is in the calling unit's local memory.

Definition at line 327 of file GlobSharedRef.h.

References dart_gptr_t::addr_or_offs, dart_team_myid(), dart_gptr_t::flags, dart_gptr_t::segid, dart_gptr_t::teamid, and dart_gptr_t::unitid.

  {
    if (_lptr == nullptr) {
      return false;
    }
    dart_team_unit_t luid;
    dart_team_myid(_gptr.teamid, &luid);
    return _gptr.unitid == luid.id;
  }

operator=()

template<typename T, typename GlobalPointerType>

self_t& dash::GlobSharedRef< T, GlobalPointerType >::operator= ( const self_t &  other )

inline

Assignment operator.

Definition at line 141 of file GlobSharedRef.h.

References dash::Team::All(), dart_fetch_and_op(), dart_flush(), DART_GPTR_ISNULL, dash::local(), and dash::swap().

  {
    DASH_LOG_TRACE_VAR("GlobSharedRef.=()", other);
    // This results in a dart_put, required for STL algorithms like
    // std::copy to work on global ranges.
    // TODO: Not well-defined:
    //       This violates copy semantics:
    //         GlobSharedRef(const GlobSharedRef & other)
    //       copies the GlobSharedRef instance while
    //         GlobSharedRef=(const GlobSharedRef & other)
    //       puts the value.
    return *this = static_cast<T>(other);
//  _gptr = other._gptr;
//  return *this;
  }

---

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

• /tmp/tmporruphar/dash/include/dash/GlobSharedRef.h