HostWriteAccess is a specialization of WriteAccess for the Host Location with an extended interface. More...

#include <HostWriteAccess.hpp>

Inheritance diagram for lama::HostWriteAccess< T >:

Public Types
typedef T	ValueType
	ValueType is the type stored in the wrapped container.
Public Member Functions
	HostWriteAccess (LAMAArray< ValueType > &array)
	acquire a WriteAccess to the passed LAMAArray for the Host location
	HostWriteAccess (LAMAArray< ValueType > &array, const IndexType size, const bool keep)
	HostWriteAccess (LAMAArrayView< ValueType > &view, const bool keep=true)
virtual	~HostWriteAccess ()
	Releases the WriteAccess on the associated LAMAArray.
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::HostWriteAccess< T >

HostWriteAccess is a specialization of WriteAccess for the Host Location with an extended interface.

Member Typedef Documentation

template<typename T>

typedef T lama::HostWriteAccess< T >::ValueType

ValueType is the type stored in the wrapped container.

Reimplemented from lama::WriteAccess< T >.

Reimplemented in lama::HostWriteOnlyAccess< T >.

Constructor & Destructor Documentation

template<typename T >

lama::HostWriteAccess< T >::HostWriteAccess ( LAMAArray< ValueType > & array )

acquire a WriteAccess to the passed LAMAArray for the Host location

Parameters:

[in]	array	the LAMAArray to acquire a WriteAccess for
[in]	keep	if the contents of the LAMAArray should be kept or not (default: true)

Exceptions:

Exception if the WriteAccess can not be acquired, e.g. because another WriteAccess exists.

See also:: WriteAccess for more details

template<typename T >

lama::HostWriteAccess< T >::HostWriteAccess	(	LAMAArray< ValueType > &	array,
		const IndexType	size,
		const bool	keep
	)

template<typename T >

lama::HostWriteAccess< T >::HostWriteAccess	(	LAMAArrayView< ValueType > &	view,
		const bool	keep = `true`
	)

template<typename T >

lama::HostWriteAccess< T >::~HostWriteAccess ( ) [virtual]

Releases the WriteAccess on the associated LAMAArray.

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