HostWriteOnlyAccess is a write access where no existing values of the array are needed (keepFlag = false). More...

#include <HostWriteAccess.hpp>

Inheritance diagram for lama::HostWriteOnlyAccess< T >:

Public Types
typedef T	ValueType
	ValueType is the type stored in the wrapped container.
Public Member Functions
	HostWriteOnlyAccess (LAMAArray< ValueType > &array)
	Create a write access with keep flag = false.
	HostWriteOnlyAccess (LAMAArray< ValueType > &array, const IndexType size)
	Create a write access with keep flag = false and do also a resize.
	~HostWriteOnlyAccess ()
ValueType &	operator[] (const IndexType i)
	access to the element i of the wrapped LAMAArray
	operator ValueType * ()
	conversion to a ValueType pointer (shortcut for get() )
void	push_back (const ValueType val)
	appends val to the end of the wrapped LAMAArray.
ValueType *	get ()
	returns a pointer to the data of the wrapped LAMAArray
void	clear ()
	Set the size of the LAMAArray to 0.
void	resize (const IndexType newSize)
	resizes the wrapped LAMAArray
void	reserve (const IndexType capacity)
	reserve storage for wth wrapped LAMAArray at the associated location
IndexType	capacity () const
	query the capacity of the array on the reserved context
virtual void	release ()
	Releases the WriteAccess on the associated LAMAArray.
virtual void	writeAt (std::ostream &stream) const
	Writes some Information about this to the passed stream.
IndexType	size () const
	Returns the size of the wrapped LAMAArray.
Protected Member Functions
	LAMA_LOG_DECL_STATIC_LOGGER (logger)
Protected Attributes
ValueType *	mData
LAMAArrayView< ValueType > *	mArrayView
size_t	mIndex

Detailed Description

template<typename T>
class lama::HostWriteOnlyAccess< T >

HostWriteOnlyAccess is a write access where no existing values of the array are needed (keepFlag = false).

This derived class has been added for more convenience as it avoids the use of the keepFlag param.

A HostWriteOnlyAccess should be used whenever possible. It avoids any memory transfer of no more needed values between devices and in case of a reallocation it avoids copying of old values.

Member Typedef Documentation

template<typename T>

typedef T lama::HostWriteOnlyAccess< T >::ValueType

ValueType is the type stored in the wrapped container.

Reimplemented from lama::HostWriteAccess< T >.

Constructor & Destructor Documentation

template<typename T>

lama::HostWriteOnlyAccess< T >::HostWriteOnlyAccess ( LAMAArray< ValueType > & array ) [inline]

Create a write access with keep flag = false.

template<typename T>

lama::HostWriteOnlyAccess< T >::HostWriteOnlyAccess	(	LAMAArray< ValueType > &	array,
		const IndexType	size
	)		`[inline]`

Create a write access with keep flag = false and do also a resize.

template<typename T>

lama::HostWriteOnlyAccess< T >::~HostWriteOnlyAccess ( ) [inline]

Member Function Documentation

template<typename T >

IndexType lama::WriteAccess< T >::capacity ( ) const [inherited]

query the capacity of the array on the reserved context

References LAMA_ASSERT_ERROR.

Referenced by lama::Communicator::shift().

template<typename T >

void lama::WriteAccess< T >::clear ( ) [inherited]

Set the size of the LAMAArray to 0.

This operation only sets the size but does not free any reserved memory.

This operation should always be called when an array is completely rewritten. to avoid that data will be transfered from other locations or copying of old values during the resize.

   LAMAArray& arr = ...
   arr.clear();
   HostWriteAccess writeArr( arr );
   writeArr.resize( 100 );
   for ( int i = 0; i < 100; i++)
   {
       writeArr[i] = 0.0;
   }

References LAMA_ASSERT_ERROR.

Referenced by lama::Communicator::exchangeByPlan(), and lama::_MatrixStorage::offsets2sizes().

template<typename T >

T * lama::WriteAccess< T >::get ( ) [inherited]

returns a pointer to the data of the wrapped LAMAArray