dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT > Class Template Reference

Proxy type representing an access modifier on elements in a dash::Array. More...

#include <Array.h>

Public Types
typedef ElementType	value_type
	Public types as required by iterator concept. More...
typedef IndexType	index_type
typedef std::make_unsigned< IndexType >::type	size_type
typedef std::make_unsigned< IndexType >::type	difference_type
typedef GlobIter< value_type, PatternType, typename Array_t::memory_type >	iterator
typedef GlobIter< const value_type, PatternType, typename Array_t::memory_type >	const_iterator
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
typedef GlobRef< value_type >	reference
typedef GlobRef< const value_type >	const_reference
typedef iterator	pointer
typedef const_iterator	const_pointer
typedef PatternType	pattern_type
	Public types as required by dash container concept. More...
typedef self_t	view_type
typedef LocalArrayRef< value_type, IndexType, PatternType, LocalMemSpaceT >	local_type
typedef AsyncArrayRef< value_type, IndexType, PatternType, LocalMemSpaceT >	async_type
typedef std::integral_constant< dim_t, 1 >	rank

Public Member Functions
	ArrayRef (const Array_t *array, const ViewSpec_t &viewspec)
constexpr Team &	team () const
constexpr size_type	size () const noexcept
constexpr size_type	local_size () const noexcept
constexpr size_type	local_capacity () const noexcept
constexpr size_type	extent (dim_t dim) const noexcept
constexpr Extents_t	extents () const noexcept
constexpr bool	empty () const noexcept
void	barrier () const
constexpr const_pointer	data () const noexcept
iterator	begin () noexcept
constexpr const_iterator	begin () const noexcept
iterator	end () noexcept
constexpr const_iterator	end () const noexcept
local_type	sub_local () noexcept
	View representing elements in the active unit's local memory. More...
constexpr ElementType *	lbegin () const noexcept
	Pointer to first element in local range. More...
constexpr ElementType *	lend () const noexcept
	Pointer past final element in local range. More...
reference	operator[] (size_type global_index)
constexpr const_reference	operator[] (size_type global_index) const
reference	at (size_type global_pos)
const_reference	at (size_type global_pos) const
constexpr const PatternType &	pattern () const
	The pattern used to distribute array elements to units. More...

Static Public Member Functions
static constexpr dim_t	ndim ()

Detailed Description

template<typename ElementType, typename IndexType, class PatternType, typename LocalMemSpaceT>
class dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >

Proxy type representing an access modifier on elements in a dash::Array.

Implemented concept:

Array Concept

Definition at line 447 of file Array.h.

Member Typedef Documentation

pattern_type

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

typedef PatternType dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::pattern_type

Public types as required by dash container concept.

The type of the pattern used to distribute array elements to units

Definition at line 490 of file Array.h.

value_type

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

typedef ElementType dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::value_type

Public types as required by iterator concept.

Definition at line 463 of file Array.h.

Constructor & Destructor Documentation

ArrayRef()

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::ArrayRef ( const Array_t *  array, const ViewSpec_t &  viewspec  )

inline

Parameters

array	Pointer to array instance referenced by this view.
viewspec	The view's offset and extent within the referenced array.

Definition at line 507 of file Array.h.

References dash::barrier(), dash::LocalArrayRef< T, IndexType, PatternType, LocalMemSpaceT >::begin(), dash::LocalArrayRef< T, IndexType, PatternType, LocalMemSpaceT >::end(), dash::extent(), and dash::LocalArrayRef< T, IndexType, PatternType, LocalMemSpaceT >::size().

  : _arr(array),
    _viewspec(viewspec),
    _begin(array->begin() + _viewspec.offsets()[0]),
    _end(array->begin()   + _viewspec.offsets()[0] + _viewspec.extents()[0]),
    _size(_viewspec.size())
  { }

Member Function Documentation

at() [1/2]

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

reference dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::at ( size_type  global_pos )

inline

Parameters

global_pos

The position of the element to return

Definition at line 580 of file Array.h.

References dash::LocalArrayRef< T, IndexType, PatternType, LocalMemSpaceT >::size().

  {
    if (global_pos >= size()) {
      DASH_THROW(
          dash::exception::OutOfRange,
          "Position " << global_pos
          << " is out of range " << size()
          << " in ArrayRef.at()" );
    }
    return _arr->_begin[global_pos];
  }

at() [2/2]

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

const_reference dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::at ( size_type  global_pos ) const

inline

Parameters

global_pos

The position of the element to return

Definition at line 594 of file Array.h.

References dash::LocalArrayRef< T, IndexType, PatternType, LocalMemSpaceT >::size().

  {
    if (global_pos >= size()) {
      DASH_THROW(
          dash::exception::OutOfRange,
          "Position " << global_pos
          << " is out of range " << size()
          << " in ArrayRef.at()" );
    }
    return _arr->_begin[global_pos];
  }

lbegin()

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

constexpr ElementType* dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::lbegin ( ) const

noexcept

Pointer to first element in local range.

lend()

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

constexpr ElementType* dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::lend ( ) const

noexcept

Pointer past final element in local range.

operator[]() [1/2]

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

reference dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::operator[] ( size_type  global_index )

inline

Parameters

global_index

The position of the element to return

Definition at line 565 of file Array.h.

  {
    DASH_LOG_TRACE("ArrayRef.[]=", global_index);
    return _arr->_begin[global_index];
  }

operator[]() [2/2]

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

constexpr const_reference dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::operator[] ( size_type  global_index ) const

inline

Parameters

global_index

The position of the element to return

Definition at line 573 of file Array.h.

  {
    return _arr->_begin[global_index];
  }

pattern()

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

constexpr const PatternType& dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::pattern ( ) const

inline

The pattern used to distribute array elements to units.

Definition at line 611 of file Array.h.

                                                {
    return _arr->pattern();
  }

sub_local()

template<typename ElementType , typename IndexType , class PatternType , typename LocalMemSpaceT >

local_type dash::ArrayRef< ElementType, IndexType, PatternType, LocalMemSpaceT >::sub_local ( )

inlinenoexcept

View representing elements in the active unit's local memory.

---

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

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