shm_span< T, ShmType > Class Template Reference

Base class for shared memory data structures that span a region. More...

#include <shm_span.h>

Inheritance diagram for shm_span< T, ShmType >:

Public Member Functions
	shm_span (ShmType &shm, size_t off, size_t count)
T *	data ()
const T *	data () const
size_t	size () const
T &	operator[] (size_t index)
const T &	operator[] (size_t index) const

Protected Attributes
ShmType &	shm
size_t	offset
size_t	num_elem

Detailed Description

template<typename T, typename ShmType>
class shm_span< T, ShmType >

Base class for shared memory data structures that span a region.

Template Parameters

T	Type of elements (must be trivially copyable)
ShmType	Type of shared memory manager

Definition at line 11 of file shm_span.h.

Constructor & Destructor Documentation

shm_span()

template<typename T , typename ShmType >

shm_span< T, ShmType >::shm_span ( ShmType &  shm, size_t  off, size_t  count  )

inline

Definition at line 18 of file shm_span.h.

Member Function Documentation

data() [1/2]

template<typename T , typename ShmType >

T * shm_span< T, ShmType >::data ( )

inline

Definition at line 21 of file shm_span.h.

References shm_span< T, ShmType >::offset, and shm_span< T, ShmType >::shm.

Referenced by shm_span< T, ShmType >::operator[](), and shm_span< T, ShmType >::operator[]().

data() [2/2]

template<typename T , typename ShmType >

const T * shm_span< T, ShmType >::data ( ) const

inline

Definition at line 27 of file shm_span.h.

References shm_span< T, ShmType >::offset, and shm_span< T, ShmType >::shm.

operator[]() [1/2]

template<typename T , typename ShmType >

T & shm_span< T, ShmType >::operator[] ( size_t  index )

inline

Definition at line 35 of file shm_span.h.

References shm_span< T, ShmType >::data().

operator[]() [2/2]

template<typename T , typename ShmType >

const T & shm_span< T, ShmType >::operator[] ( size_t  index ) const

inline

Definition at line 36 of file shm_span.h.

References shm_span< T, ShmType >::data().

size()

template<typename T , typename ShmType >

size_t shm_span< T, ShmType >::size ( ) const

inline

Definition at line 33 of file shm_span.h.

References shm_span< T, ShmType >::num_elem.

Member Data Documentation

num_elem

template<typename T , typename ShmType >

size_t shm_span< T, ShmType >::num_elem

protected

Definition at line 15 of file shm_span.h.

Referenced by shm_array< T, TableType >::as_span(), shm_array< T, TableType >::as_span(), shm_array< T, TableType >::at(), shm_array< T, TableType >::at(), shm_array< T, TableType >::back(), shm_array< T, TableType >::back(), shm_queue< T, TableType >::capacity(), shm_array< T, TableType >::empty(), shm_array< T, TableType >::end(), shm_array< T, TableType >::end(), shm_array< T, TableType >::fill(), shm_array< T, TableType >::initialize(), shm_array< T, TableType >::max_size(), shm_queue< T, TableType >::shm_queue(), shm_span< T, ShmType >::size(), and shm_array< T, TableType >::size().

offset

template<typename T , typename ShmType >

size_t shm_span< T, ShmType >::offset

protected

Definition at line 14 of file shm_span.h.

Referenced by shm_span< T, ShmType >::data(), shm_span< T, ShmType >::data(), shm_array< T, TableType >::initialize(), and shm_queue< T, TableType >::shm_queue().

shm

template<typename T , typename ShmType >

ShmType& shm_span< T, ShmType >::shm

protected

Definition at line 13 of file shm_span.h.

Referenced by calculate_kinetic_energy_simd(), shm_span< T, ShmType >::data(), shm_span< T, ShmType >::data(), shm_array< T, TableType >::initialize(), and shm_queue< T, TableType >::shm_queue().

---

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

• include/shm_span.h