dash::GlobPtr< ElementType, GlobMemT > Class Template Reference

Pointer in global memory space with random access arithmetics. More...

#include <GlobPtr.h>

Public Types
typedef ElementType	value_type
typedef GlobPtr< const ElementType, GlobMemT >	const_type
typedef GlobMemT::index_type	index_type
typedef GlobMemT::size_type	size_type
typedef index_type	gptrdiff_t
typedef local_pointer_traits::template rebind< value_type >	local_type
typedef local_pointer_traits::template rebind< value_type const >	const_local_type
typedef GlobMemT	memory_type
template<typename T >
using	rebind = dash::GlobPtr< T, GlobMemT >
	Rebind to a different type of pointer. More...

Public Member Functions
constexpr	GlobPtr ()=default
	Default constructor, underlying global address is unspecified. More...
constexpr	GlobPtr (dart_gptr_t gptr) DASH_NOEXCEPT
	Constructor, specifies underlying global address. More...
constexpr	GlobPtr (std::nullptr_t) DASH_NOEXCEPT
	Constructor for conversion of std::nullptr_t. More...
constexpr	GlobPtr (const self_t &other)=default
	Copy constructor. More...
self_t &	operator= (const self_t &rhs)=default
	Assignment operator. More...
self_t &	operator= (std::nullptr_t)
	nullptr assignment operator. More...
template<typename From , typename = typename std::enable_if< dash::internal::is_pointer_assignable< typename dash::remove_atomic<From>::type, typename dash::remove_atomic<value_type>::type>::value> ::type>
constexpr	GlobPtr (const GlobPtr< From, GlobMemT > &other) DASH_NOEXCEPT
	Implicit Converting Constructor, only allowed if one of the following conditions is satisfied: More...
constexpr	GlobPtr (self_t &&other) DASH_NOEXCEPT=default
	Move constructor. More...
self_t &	operator= (self_t &&rhs) DASH_NOEXCEPT=default
	Move-assignment operator. More...
	operator value_type * () const DASH_NOEXCEPT
	Converts pointer to its referenced native pointer or nullptr if the GlobPtr does not point to a local address. More...
	operator value_type * ()
	Conversion operator to local pointer. More...
constexpr	operator dart_gptr_t () const DASH_NOEXCEPT
	Converts pointer to its underlying global address. More...
constexpr dart_gptr_t	dart_gptr () const DASH_NOEXCEPT
	The pointer's underlying global address. More...
constexpr index_type	operator- (const self_t &rhs) const DASH_NOEXCEPT
	Pointer offset difference operator. More...
self_t &	operator++ () DASH_NOEXCEPT
	Prefix increment operator. More...
self_t	operator++ (int) DASH_NOEXCEPT
	Postfix increment operator. More...
self_t	operator+ (index_type n) const DASH_NOEXCEPT
	Pointer increment operator. More...
self_t &	operator+= (index_type n) DASH_NOEXCEPT
	Pointer increment operator. More...
self_t &	operator-- () DASH_NOEXCEPT
	Prefix decrement operator. More...
self_t	operator-- (int) DASH_NOEXCEPT
	Postfix decrement operator. More...
self_t	operator- (index_type n) const DASH_NOEXCEPT
	Pointer decrement operator. More...
self_t &	operator-= (index_type n) DASH_NOEXCEPT
	Pointer decrement operator. More...
constexpr bool	operator== (const GlobPtr &other) const DASH_NOEXCEPT
	Equality comparison operator. More...
constexpr bool	operator== (std::nullptr_t) const DASH_NOEXCEPT
	Equality comparison operator. More...
template<class GlobPtrT >
constexpr bool	operator!= (const GlobPtrT &other) const DASH_NOEXCEPT
	Inequality comparison operator. More...
template<class GlobPtrT >
constexpr bool	operator< (const GlobPtrT &other) const DASH_NOEXCEPT
	Less comparison operator. More...
template<class GlobPtrT >
constexpr bool	operator<= (const GlobPtrT &other) const DASH_NOEXCEPT
	Less-equal comparison operator. More...
template<class GlobPtrT >
constexpr bool	operator> (const GlobPtrT &other) const DASH_NOEXCEPT
	Greater comparison operator. More...
template<class GlobPtrT >
constexpr bool	operator>= (const GlobPtrT &other) const DASH_NOEXCEPT
	Greater-equal comparison operator. More...
constexpr GlobRef< const value_type >	operator[] (gptrdiff_t n) const DASH_NOEXCEPT
	Subscript operator. More...
GlobRef< value_type >	operator[] (gptrdiff_t n) DASH_NOEXCEPT
	Subscript assignment operator. More...
GlobRef< value_type >	operator* () DASH_NOEXCEPT
	Dereference operator. More...
constexpr GlobRef< const value_type >	operator* () const DASH_NOEXCEPT
	Dereference operator. More...
value_type *	local ()
	Conversion to local pointer. More...
const value_type *	local () const
	Conversion to local const pointer. More...
void	set_unit (team_unit_t unit_id) DASH_NOEXCEPT
	Set the global pointer's associated unit. More...
constexpr auto	get_unit () const DASH_NOEXCEPT
bool	is_local () const
	Check whether the global pointer is in the local address space the pointer's associated unit. More...
constexpr	operator bool () const DASH_NOEXCEPT

Friends
template<typename T , class MemSpaceT >
std::ostream &	operator<< (std::ostream &os, const GlobPtr< T, MemSpaceT > &gptr)
template<class T , class MemSpaceT >
dash::gptrdiff_t	distance (GlobPtr< T, MemSpaceT > gbegin, GlobPtr< T, MemSpaceT > gend)
	Returns the number of hops from gbegin to gend. More...

Detailed Description

template<typename ElementType, class GlobMemT>
class dash::GlobPtr< ElementType, GlobMemT >

Pointer in global memory space with random access arithmetics.

Forward declarations.

See also

GlobIter

Implemented concept:

DashMemorySpaceConcept

Definition at line 33 of file GlobPtr.h.

Member Typedef Documentation

rebind

template<typename ElementType, class GlobMemT>

template<typename T >

using dash::GlobPtr< ElementType, GlobMemT >::rebind = dash::GlobPtr<T, GlobMemT>

Rebind to a different type of pointer.

Definition at line 75 of file GlobPtr.h.

Constructor & Destructor Documentation

GlobPtr() [1/6]

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( )

default

Default constructor, underlying global address is unspecified.

Referenced by dash::GlobPtr< event_ctr_t, globmem_t >::GlobPtr().

GlobPtr() [2/6]

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( dart_gptr_t  gptr )

inlineexplicit

Constructor, specifies underlying global address.

Definition at line 101 of file GlobPtr.h.

    : m_dart_pointer(gptr)
  {
  }

GlobPtr() [3/6]

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( std::nullptr_t  )

inlineexplicit

Constructor for conversion of std::nullptr_t.

Definition at line 109 of file GlobPtr.h.

    : m_dart_pointer(DART_GPTR_NULL)
  {
  }

GlobPtr() [4/6]

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( const self_t &  other )

default

Copy constructor.

GlobPtr() [5/6]

template<typename ElementType, class GlobMemT>

template<typename From , typename = typename std::enable_if< dash::internal::is_pointer_assignable< typename dash::remove_atomic<From>::type, typename dash::remove_atomic<value_type>::type>::value> ::type>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( const GlobPtr< From, GlobMemT > &  other )

inline

Implicit Converting Constructor, only allowed if one of the following conditions is satisfied:

• Either From or To (value_type) are void. Like in C we can convert any pointer type to a void pointer and back again.
• From::value_type& is assignable to value_type&.

NOTE: Const correctness is considered. We can assign a GlobPtr<const T> to a GlobPtr<T> but not the other way around

Definition at line 155 of file GlobPtr.h.

    : m_dart_pointer(other.m_dart_pointer)
  {
  }

GlobPtr() [6/6]

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::GlobPtr ( self_t &&  other )

default

Move constructor.

Member Function Documentation

dart_gptr()

template<typename ElementType, class GlobMemT>

constexpr dart_gptr_t dash::GlobPtr< ElementType, GlobMemT >::dart_gptr ( ) const

inline

The pointer's underlying global address.

Definition at line 203 of file GlobPtr.h.

Referenced by dash::GlobLocalMemoryPool< dash::HostSpace >::flush_local().

  {
    return m_dart_pointer;
  }

is_local()

template<typename ElementType, class GlobMemT>

bool dash::GlobPtr< ElementType, GlobMemT >::is_local ( ) const

inline

Check whether the global pointer is in the local address space the pointer's associated unit.

Definition at line 445 of file GlobPtr.h.

  {
    return dash::internal::is_local(m_dart_pointer);
  }

local() [1/2]

template<typename ElementType, class GlobMemT>

value_type* dash::GlobPtr< ElementType, GlobMemT >::local ( )

inline

Conversion to local pointer.

Returns

A native pointer to the local element referenced by this GlobPtr instance, or nullptr if the referenced element is not local to the calling unit.

Definition at line 405 of file GlobPtr.h.

Referenced by dash::GlobPtr< event_ctr_t, globmem_t >::operator value_type *().

  {
    void *addr = nullptr;
    if (dart_gptr_getaddr(m_dart_pointer, &addr) == DART_OK) {
      return static_cast<value_type *>(addr);
    }
    return nullptr;
  }

local() [2/2]

template<typename ElementType, class GlobMemT>

const value_type* dash::GlobPtr< ElementType, GlobMemT >::local ( ) const

inline

Conversion to local const pointer.

Returns

A native pointer to the local element referenced by this GlobPtr instance, or nullptr if the referenced element is not local to the calling unit.

Definition at line 421 of file GlobPtr.h.

                                   {
    void *addr = nullptr;
    if (dart_gptr_getaddr(m_dart_pointer, &addr) == DART_OK) {
      return static_cast<const value_type *>(addr);
    }
    return nullptr;
  }

operator dart_gptr_t()

template<typename ElementType, class GlobMemT>

constexpr dash::GlobPtr< ElementType, GlobMemT >::operator dart_gptr_t ( ) const

inlineexplicit

Converts pointer to its underlying global address.

Definition at line 195 of file GlobPtr.h.

  {
    return m_dart_pointer;
  }

operator value_type *() [1/2]

template<typename ElementType, class GlobMemT>

dash::GlobPtr< ElementType, GlobMemT >::operator value_type * ( ) const

inlineexplicit

Converts pointer to its referenced native pointer or nullptr if the GlobPtr does not point to a local address.

Definition at line 175 of file GlobPtr.h.

  {
    return local();
  }

operator value_type *() [2/2]

template<typename ElementType, class GlobMemT>

dash::GlobPtr< ElementType, GlobMemT >::operator value_type * ( )

inlineexplicit

Conversion operator to local pointer.

Returns

A native pointer to the local element referenced by this GlobPtr instance, or nullptr if the referenced element is not local to the calling unit.

Definition at line 187 of file GlobPtr.h.

  {
    return local();
  }

operator!=()

template<typename ElementType, class GlobMemT>

template<class GlobPtrT >

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator!= ( const GlobPtrT &  other ) const

inline

Inequality comparison operator.

Definition at line 325 of file GlobPtr.h.

  {
    return !(*this == other);
  }

operator*() [1/2]

template<typename ElementType, class GlobMemT>

GlobRef<value_type> dash::GlobPtr< ElementType, GlobMemT >::operator* ( )

inline

Dereference operator.

Definition at line 385 of file GlobPtr.h.

  {
    return GlobRef<value_type>(*this);
  }

operator*() [2/2]

template<typename ElementType, class GlobMemT>

constexpr GlobRef<const value_type> dash::GlobPtr< ElementType, GlobMemT >::operator* ( ) const

inline

Dereference operator.

Definition at line 393 of file GlobPtr.h.

  {
    return GlobRef<const value_type>(*this);
  }

operator+()

template<typename ElementType, class GlobMemT>

self_t dash::GlobPtr< ElementType, GlobMemT >::operator+ ( index_type  n ) const

inline

Pointer increment operator.

Definition at line 238 of file GlobPtr.h.

  {
    self_t res(*this);
    res += n;
    return res;
  }

operator++() [1/2]

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator++ ( )

inline

Prefix increment operator.

Definition at line 219 of file GlobPtr.h.

  {
    increment(1);
    return *this;
  }

operator++() [2/2]

template<typename ElementType, class GlobMemT>

self_t dash::GlobPtr< ElementType, GlobMemT >::operator++ ( int  )

inline

Postfix increment operator.

Definition at line 228 of file GlobPtr.h.

  {
    self_t res(*this);
    increment(1);
    return res;
  }

operator+=()

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator+= ( index_type  n )

inline

Pointer increment operator.

Definition at line 248 of file GlobPtr.h.

  {
    if (n >= 0) {
      increment(n);
    }
    else {
      decrement(-n);
    }
    return *this;
  }

operator-() [1/2]

template<typename ElementType, class GlobMemT>

constexpr index_type dash::GlobPtr< ElementType, GlobMemT >::operator- ( const self_t &  rhs ) const

inline

Pointer offset difference operator.

Definition at line 211 of file GlobPtr.h.

  {
    return dash::distance(rhs, *this);
  }

operator-() [2/2]

template<typename ElementType, class GlobMemT>

self_t dash::GlobPtr< ElementType, GlobMemT >::operator- ( index_type  n ) const

inline

Pointer decrement operator.

Definition at line 281 of file GlobPtr.h.

  {
    self_t res(*this);
    res -= n;
    return res;
  }

operator--() [1/2]

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator-- ( )

inline

Prefix decrement operator.

Definition at line 262 of file GlobPtr.h.

  {
    decrement(1);
    return *this;
  }

operator--() [2/2]

template<typename ElementType, class GlobMemT>

self_t dash::GlobPtr< ElementType, GlobMemT >::operator-- ( int  )

inline

Postfix decrement operator.

Definition at line 271 of file GlobPtr.h.

  {
    self_t res(*this);
    decrement(1);
    return res;
  }

operator-=()

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator-= ( index_type  n )

inline

Pointer decrement operator.

Definition at line 291 of file GlobPtr.h.

  {
    if (n >= 0) {
      decrement(n);
    }
    else {
      increment(-n);
    }
    return *this;
  }

operator<()

template<typename ElementType, class GlobMemT>

template<class GlobPtrT >

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator< ( const GlobPtrT &  other ) const

inline

Less comparison operator.

Definition at line 334 of file GlobPtr.h.

  {
    return (other - *this) > 0;
  }

operator<=()

template<typename ElementType, class GlobMemT>

template<class GlobPtrT >

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator<= ( const GlobPtrT &  other ) const

inline

Less-equal comparison operator.

Definition at line 343 of file GlobPtr.h.

  {
    return !(*this > other);
  }

operator=() [1/3]

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator= ( const self_t &  rhs )

default

Assignment operator.

Referenced by dash::GlobPtr< event_ctr_t, globmem_t >::GlobPtr().

operator=() [2/3]

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator= ( std::nullptr_t  )

inline

nullptr assignment operator.

Definition at line 127 of file GlobPtr.h.

                                  {
    m_dart_pointer = DART_GPTR_NULL;

    return *this;
  }

operator=() [3/3]

template<typename ElementType, class GlobMemT>

self_t& dash::GlobPtr< ElementType, GlobMemT >::operator= ( self_t &&  rhs )

default

Move-assignment operator.

operator==() [1/2]

template<typename ElementType, class GlobMemT>

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator== ( const GlobPtr< ElementType, GlobMemT > &  other ) const

inline

Equality comparison operator.

Definition at line 306 of file GlobPtr.h.

  {
    return DART_GPTR_EQUAL(
        static_cast<dart_gptr_t>(m_dart_pointer),
        static_cast<dart_gptr_t>(other.m_dart_pointer));
  }

operator==() [2/2]

template<typename ElementType, class GlobMemT>

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator== ( std::nullptr_t  ) const

inline

Equality comparison operator.

Definition at line 316 of file GlobPtr.h.

  {
    return DART_GPTR_ISNULL(static_cast<dart_gptr_t>(m_dart_pointer));
  }

operator>()

template<typename ElementType, class GlobMemT>

template<class GlobPtrT >

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator> ( const GlobPtrT &  other ) const

inline

Greater comparison operator.

Definition at line 352 of file GlobPtr.h.

  {
    return (*this - other) > 0;
  }

operator>=()

template<typename ElementType, class GlobMemT>

template<class GlobPtrT >

constexpr bool dash::GlobPtr< ElementType, GlobMemT >::operator>= ( const GlobPtrT &  other ) const

inline

Greater-equal comparison operator.

Definition at line 361 of file GlobPtr.h.

  {
    return (*this - other) >= 0;
  }

operator[]() [1/2]

template<typename ElementType, class GlobMemT>

constexpr GlobRef<const value_type> dash::GlobPtr< ElementType, GlobMemT >::operator[] ( gptrdiff_t  n ) const

inline

Subscript operator.

Definition at line 369 of file GlobPtr.h.

  {
    return GlobRef<const value_type>(self_t((*this) + n));
  }

operator[]() [2/2]

template<typename ElementType, class GlobMemT>

GlobRef<value_type> dash::GlobPtr< ElementType, GlobMemT >::operator[] ( gptrdiff_t  n )

inline

Subscript assignment operator.

Definition at line 377 of file GlobPtr.h.

  {
    return GlobRef<value_type>(self_t((*this) + n));
  }

set_unit()

template<typename ElementType, class GlobMemT>

void dash::GlobPtr< ElementType, GlobMemT >::set_unit ( team_unit_t  unit_id )

inline

Set the global pointer's associated unit.

Definition at line 432 of file GlobPtr.h.

  {
    m_dart_pointer.unitid = unit_id.id;
  }

Friends And Related Function Documentation

distance

template<typename ElementType, class GlobMemT>

template<class T , class MemSpaceT >

dash::gptrdiff_t distance ( GlobPtr< T, MemSpaceT >  gbegin, GlobPtr< T, MemSpaceT >  gend  )

friend

Returns the number of hops from gbegin to gend.

Equivalent to (gend - gbegin).

Note

The distance is calculate by considering the memory traits of the underlying global memory distances.

Returns

The number of increments to go from gbegin to gend

Implemented concept:

DashMemorySpaceConcept

Definition at line 547 of file GlobPtr.h.

{
  using memory_space_traits = dash::memory_space_traits<MemSpaceT>;

  auto const begin = static_cast<dart_gptr_t>(gbegin);
  auto const end = static_cast<dart_gptr_t>(gbegin);

  DASH_ASSERT_EQ(begin.teamid, end.teamid, "teamid must be equal");
  DASH_ASSERT_EQ(begin.segid, end.segid, "segid must be equal");

  auto &      reg = dash::internal::MemorySpaceRegistry::GetInstance();
  auto const *mem_space =
      static_cast<const MemSpaceT *>(reg.lookup(begin));

  return dash::internal::distance<T>(
      static_cast<dart_gptr_t>(gbegin),
      static_cast<dart_gptr_t>(gend),
      mem_space,
      typename memory_space_traits::memory_space_layout_tag{});
}

---

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

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