dash::LocalListRef< T, LMemSpace > Class Template Reference

Proxy type representing a local view on a referenced dash::List. More...

#include <LocalListRef.h>

Public Types
typedef dash::default_index_t	index_type
	Type definitions required for dash::List concept: More...
typedef T	value_type
	Type definitions required for std::list concept: More...
typedef std::make_unsigned< index_type >::type	size_type
typedef std::make_unsigned< index_type >::type	difference_type
typedef glob_mem_type::local_pointer	pointer
typedef glob_mem_type::const_local_pointer	const_pointer
typedef list_type::local_reference	reference
typedef list_type::const_local_reference	const_reference
typedef list_type::local_iterator	iterator
typedef list_type::const_local_iterator	const_iterator
typedef std::reverse_iterator< iterator >	reverse_iterator
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator

Public Member Functions
	LocalListRef (list_type *list)
	Constructor, creates a local access proxy for the given list. More...
	LocalListRef (list_type *list, const ViewSpec_t &viewspec)
iterator	begin () const noexcept
	Pointer to initial local element in the list. More...
iterator	end () const noexcept
	Pointer past final local element in the list. More...
iterator	insert (const_iterator position, const value_type &value)
void	push_back (const value_type &value)
	Inserts a new element at the end of the list, after its current last element. More...
void	pop_back ()
	Removes and destroys the last element in the list, reducing the container size by one. More...
reference	back ()
	Accesses the last element in the list. More...
void	push_front (const value_type &value)
	Inserts a new element at the beginning of the list, before its current first element. More...
void	pop_front ()
	Removes and destroys the first element in the list, reducing the container size by one. More...
reference	front ()
	Accesses the first element in the list. More...
size_type	size () const noexcept
	Number of list elements in local memory. More...
constexpr bool	is_local (index_type global_index) const
	Checks whether the given global index is local to the calling unit. More...

Detailed Description

template<typename T, class LMemSpace>
class dash::LocalListRef< T, LMemSpace >

Proxy type representing a local view on a referenced dash::List.

Implemented concept:

List Concept

Definition at line 33 of file ListRef.h.

Member Typedef Documentation

index_type

template<typename T, class LMemSpace>

typedef dash::default_index_t dash::LocalListRef< T, LMemSpace >::index_type

Type definitions required for dash::List concept:

Definition at line 58 of file LocalListRef.h.

value_type

template<typename T, class LMemSpace>

typedef T dash::LocalListRef< T, LMemSpace >::value_type

Type definitions required for std::list concept:

Definition at line 62 of file LocalListRef.h.

Constructor & Destructor Documentation

LocalListRef() [1/2]

template<typename T, class LMemSpace>

dash::LocalListRef< T, LMemSpace >::LocalListRef ( list_type *  list )

inline

Constructor, creates a local access proxy for the given list.

Definition at line 82 of file LocalListRef.h.

  : _list(list)
  { }

LocalListRef() [2/2]

template<typename T, class LMemSpace>

dash::LocalListRef< T, LMemSpace >::LocalListRef ( list_type *  list, const ViewSpec_t &  viewspec  )

inline

Parameters

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

Definition at line 87 of file LocalListRef.h.

  : _list(list),
    _viewspec(viewspec)
  { }

Member Function Documentation

back()

template<typename T, class LMemSpace>

reference dash::LocalListRef< T, LMemSpace >::back ( )

inline

Accesses the last element in the list.

Definition at line 211 of file LocalListRef.h.

  {
    DASH_THROW(dash::exception::NotImplemented,
               "dash::LocalListRef._back is not implemented");
  }

begin()

template<typename T, class LMemSpace>

iterator dash::LocalListRef< T, LMemSpace >::begin ( ) const

inlinenoexcept

Pointer to initial local element in the list.

Definition at line 99 of file LocalListRef.h.

  {
    return _list->_lbegin;
  }

end()

template<typename T, class LMemSpace>

iterator dash::LocalListRef< T, LMemSpace >::end ( ) const

inlinenoexcept

Pointer past final local element in the list.

Definition at line 107 of file LocalListRef.h.

  {
    return _list->_lend;
  }

front()

template<typename T, class LMemSpace>

reference dash::LocalListRef< T, LMemSpace >::front ( )

inline

Accesses the first element in the list.

Definition at line 242 of file LocalListRef.h.

  {
    DASH_THROW(dash::exception::NotImplemented,
               "dash::LocalListRef.front is not implemented");
  }

insert()

template<typename T, class LMemSpace>

iterator dash::LocalListRef< T, LMemSpace >::insert ( const_iterator  position, const value_type &  value  )

inline

Parameters

position	Position in the list where the new element is inserted.
value	Value to be copied in the inserted element.

Definition at line 112 of file LocalListRef.h.

  {
    DASH_LOG_TRACE("LocalListRef.insert()");
    // New element node:
    ListNode_t node;
    node.lprev = nullptr;
    node.lnext = nullptr;
    node.gprev = _gprev;
    node.gnext = _gnext;
    iterator it_insert_end = _list->_end;
    DASH_THROW(dash::exception::NotImplemented,
               "dash::LocalListRef.pop_back is not implemented");

    DASH_LOG_TRACE("LocalListRef.insert >");
    return it_insert_end;
  }

is_local()

template<typename T, class LMemSpace>

constexpr bool dash::LocalListRef< T, LMemSpace >::is_local ( index_type  global_index ) const

inline

Checks whether the given global index is local to the calling unit.

Returns

True

Parameters

global_index

A global list index

Definition at line 261 of file LocalListRef.h.

  {
    return true;
  }

pop_back()

template<typename T, class LMemSpace>

void dash::LocalListRef< T, LMemSpace >::pop_back ( )

inline

Removes and destroys the last element in the list, reducing the container size by one.

Definition at line 202 of file LocalListRef.h.

  {
    DASH_THROW(dash::exception::NotImplemented,
               "dash::LocalListRef.pop_back is not implemented");
  }

pop_front()

template<typename T, class LMemSpace>

void dash::LocalListRef< T, LMemSpace >::pop_front ( )

inline

Removes and destroys the first element in the list, reducing the container size by one.

Definition at line 233 of file LocalListRef.h.

  {
    DASH_THROW(dash::exception::NotImplemented,
               "dash::LocalListRef.pop_front is not implemented");
  }

push_back()

template<typename T, class LMemSpace>

void dash::LocalListRef< T, LMemSpace >::push_back ( const value_type &  value )

inline

Inserts a new element at the end of the list, after its current last element.

The content of value is copied or moved to the inserted element. Increases the container size by one.

Definition at line 139 of file LocalListRef.h.

  {
    DASH_LOG_TRACE("LocalListRef.push_back()");
    // Pointer to new node element:
    ListNode_t * node_lptr = nullptr;
    // New element node:
    ListNode_t   node;
    node.value = value;
    node.lprev = nullptr;
    node.lnext = nullptr;
    node.gprev = _gprev;
    node.gnext = _gnext;
    // Local capacity before operation:
    auto l_cap_old  = _list->_globmem->local_size();
    // Number of local elements before operation:
    auto l_size_old = _list->_local_sizes.local[0];
    // Update local size:
    _list->_local_sizes.local[0]++;
    // Number of local elements after operation:
    auto l_size_new = _list->_local_sizes.local[0];

    DASH_LOG_TRACE_VAR("LocalListRef.push_back", l_cap_old);
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", l_size_old);
    if (l_size_new > l_cap_old) {
      DASH_LOG_TRACE("LocalListRef.push_back",
                     "globmem.grow(", _list->_local_buffer_size, ")");
      // Acquire local memory for new node:
      node_lptr = static_cast<ListNode_t *>(
                    _list->_globmem->grow(_list->_local_buffer_size));
      DASH_ASSERT_GT(_list->_globmem->local_size(), l_cap_old,
                     "local capacity not increased after globmem.grow()");
    } else {
      // No allocation required (cast from LocalBucketIter<T> to T *):
      node_lptr = static_cast<ListNode_t *>(
                    _list->_globmem->lbegin() + l_size_old);
    }
    // Local capacity before operation:
    auto l_cap_new = _list->_globmem->local_size();
    DASH_LOG_TRACE("LocalListRef.push_back",
                   "node target address:", node_lptr);
    if (l_size_old > 0) {
      // Set node predecessor (cast from LocalBucketIter<T> to T *):
      node.lprev = static_cast<ListNode_t *>(
                     _list->_globmem->lbegin() + (l_size_old - 1));
      // Set successor of node predecessor to new node:
      DASH_ASSERT(node.lprev->lnext == nullptr);
      node.lprev->lnext = node_lptr;
      DASH_LOG_TRACE_VAR("LocalListRef.push_back", node.lprev->lnext);
    }
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", node.lprev);
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", node.value);
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", node.lnext);
    // Copy new node to target address:
    *node_lptr = node;
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", l_cap_new);
    DASH_LOG_TRACE_VAR("LocalListRef.push_back", l_size_new);
    DASH_LOG_TRACE("LocalListRef.push_back >");
  }

push_front()

template<typename T, class LMemSpace>

void dash::LocalListRef< T, LMemSpace >::push_front ( const value_type &  value )

inline

Inserts a new element at the beginning of the list, before its current first element.

The content of value is copied or moved to the inserted element. Increases the container size by one.

Definition at line 223 of file LocalListRef.h.

  {
    DASH_THROW(dash::exception::NotImplemented,
               "dash::ListLocalRef.push_front is not implemented");
  }

size()

template<typename T, class LMemSpace>

size_type dash::LocalListRef< T, LMemSpace >::size ( ) const

inlinenoexcept

Number of list elements in local memory.

Definition at line 251 of file LocalListRef.h.

  {
    return _list->lsize();
  }

---

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

• /tmp/tmporruphar/dash/include/dash/list/ListRef.h
• /tmp/tmporruphar/dash/include/dash/list/LocalListRef.h