The template SparseAssemblyStorage is a convenient intermediate container to construct a sparse matrix which structure is not known a priori. More...

#include <SparseAssemblyStorage.hpp>

Inheritance diagram for lama::SparseAssemblyStorage< T >:

[legend]

Data Structures
struct	Row
Public Types
typedef T	ValueType
	The type of the values.
Public Member Functions
	SparseAssemblyStorage ()
	The default constructor creates an empty SparseAssemblyStorage.
	SparseAssemblyStorage (const SparseAssemblyStorage< ValueType > &other)
	The copy constructor creates a SparseAssemblyStorage which is a copy of the passed SparseAssemblyStorage.
	SparseAssemblyStorage (const _MatrixStorage &other)
	This constructor creates a SparseAssemblyStorage which is initialized with the values of the passed MatrixStorage.
	SparseAssemblyStorage (const IndexType numRows, const IndexType numColumns, const IndexType numValuesPerRow=10)
	This constructor creates a SparseAssemblyStorage with the given number of rows and columns.
virtual	~SparseAssemblyStorage ()
	The destructor releases the allocated memory.
virtual void	writeAt (std::ostream &stream) const
	Override _MatrixStorage::writeAt with more detailed routine.
virtual void	clear ()
	Implementation of pure method for _MatrixStorage.
virtual void	purge ()
	Implementation of pure method of class MatrixStorage.
void	swap (SparseAssemblyStorage< ValueType > &other)
	Swaps this storage with other storage of the same type.
void	allocate (const IndexType numRows, const IndexType numColumns)
	Implementation of pure method _MatrixStorage::allocate.
SparseAssemblyStorage< T > &	operator= (const SparseAssemblyStorage< T > &other)
	The assignment operator sets the values of this to the values of the passed SparseAssemblyStorage.
SparseAssemblyStorage< T > &	operator= (const _MatrixStorage &other)
	Assignment operator for arbitry storages.
ValueType	operator() (const IndexType i, const IndexType j) const
	the access operator returns a copy of the element at the queried position.
ValueType	getValue (const IndexType i, const IndexType j) const
	Get a value of the matrix.
virtual MatrixStorageFormat	getFormat () const
	Getter routine for the enum value that stands for this format.
virtual void	setIdentity (const IndexType size)
	Implementation of pure method.
void	set (const IndexType i, const IndexType j, const ValueType value)
	sets the element at the queried position.
const std::vector< IndexType > &	getJa (const IndexType i) const
	getJa returns a constant reference to the column index array of the given row.
std::vector< IndexType > &	getJa (const IndexType i)
const std::vector< ValueType > &	getValues (const IndexType i) const
	getValues returns a constant reference to the values array of the given row.
virtual void	prefetch (const ContextPtr location) const
	Initiate an asynchronous data transfer to a specified location.
void	wait () const
	Will wait for all outstanding asynchronous data transfers.
IndexType	getNumValues () const
	getNumValues returns the number values stored in this matrix.
virtual size_t	getMemoryUsageImpl () const
	Implementation for pure method is provided.
void	setRow (const IndexType i, const LAMAArrayConstView< IndexType > &ja, const LAMAArrayConstView< ValueType > &a)
	setRow sets the given row to the passed values.
void	fixDiagonalProperty (const IndexType i)
	fixDiagonalProperty fixes the diagonal property of row.
void	setNumColumns (const IndexType i)
	setNumColumns sets the number of columns.
template<typename OtherType >
void	getRowImpl (LAMAArray< OtherType > &row, const IndexType i) const
	Template method for getting row.
template<typename OtherValueType >
void	getDiagonalImpl (LAMAArray< OtherValueType > &diagonal) const
	Typed version of getDiagonal.
template<typename OtherValueType >
void	setDiagonalImpl (const LAMAArray< OtherValueType > &diagonal)
	Typed version of setDiagonal.
void	setDiagonalImpl (const Scalar scalar)
	Implementation of pure method.
template<typename OtherType >
void	scaleImpl (const LAMAArray< OtherType > &values)
	Template version used for virtual routine scale with known value type.
void	scaleImpl (const Scalar value)
	Implementation of pure method.
template<typename OtherValueType >
void	buildCSR (LAMAArray< IndexType > &ia, LAMAArray< IndexType > ja, LAMAArray< OtherValueType > values, const ContextPtr) const
	General routine to build any kind of CSR storage.
template<typename OtherValueType >
void	setCSRDataImpl (const IndexType numRows, const IndexType numColumns, const IndexType numValues, const LAMAArray< IndexType > &ia, const LAMAArray< IndexType > &ja, const LAMAArray< OtherValueType > &values, const ContextPtr loc)
	fills Assembly sparse matrix by csr sparse data.
void	check (const char *msg) const
	Test the storage data for inconsistencies.
virtual SparseAssemblyStorage *	copy () const
	Override _MatrixStorage::copy with routine that uses covariant return type.
virtual SparseAssemblyStorage *	create () const
	Implementation of MatrixStorage::create for derived class.
template<typename OtherValueType >
void	scaleImpl (const LAMAArray< OtherValueType > &diagonal)
template<>
const char *	typeName ()
template<>
const char *	typeName ()
void	setCSRData (const IndexType numRows, const IndexType numColumns, const IndexType numValues, const LAMAArray< IndexType > &ia, const LAMAArray< IndexType > &ja, const _LAMAArray &values)
	Implementation of _MatrixStorage::setCSRData for derived class.
void	buildCSRSizes (LAMAArray< IndexType > &ia) const
	Implementation for _MatrixStorage::buildCSRSizes.
void	buildCSRData (LAMAArray< IndexType > &ia, LAMAArray< IndexType > &ja, _LAMAArray &values) const
	Get the matrix data of the storage in CSR format.
void	getRow (_LAMAArray &row, const IndexType i) const
	Get the i-th row of a storage as LAMA array.
void	getDiagonal (_LAMAArray &diagonal) const
	This method returns the diagonal of the matrix.
void	setDiagonal (const Scalar value)
void	setDiagonal (const _LAMAArray &diagonal)
	This method sets the diagonal of a matrix storage.
void	scale (const Scalar value)
	This method scales all matrix values with a scalar.
void	scale (const _LAMAArray &diagonal)
	Polymorph implementation for MatrixStorage<T>::scale.
virtual const char *	getTypeName () const
	Implementation of MatrixStorage::getTypeName for derived class.
virtual Scalar::ScalarType	getValueType () const
	Implementation of pure method.
template<typename OtherValueType >
void	setRawDenseData (const IndexType numRows, const IndexType numColumns, const OtherValueType values[], const ValueType eps=0.0)
	Construct a matrix from a dense matrix in row-major order (C-style).
template<typename OtherValueType >
void	setRawCSRData (const IndexType numRows, const IndexType numColumns, const IndexType numValues, const IndexType const ia, const IndexType const ja, const OtherValueType *const values)
	fills matrix storage by csr sparse data.
virtual void	joinHalo (const _MatrixStorage &localData, const _MatrixStorage &haloData, const class Halo &halo, const class Distribution &colDist)
	Join local and halo storage back into one storage as needed for NoDistribution.
virtual void	splitHalo (MatrixStorage< ValueType > &localData, MatrixStorage< ValueType > &haloData, class Halo &halo, const class Distribution &colDist, const class Distribution *rowDist) const
	Splitting of matrix storage for halo.
virtual void	buildHalo (class Halo &halo, const class Distribution &colDist)
	Special version of splitHalo where this matrix contains no local data and where haloData is aliased to this matrix.
virtual void	localize (const _MatrixStorage &globalData, const class Distribution &rowDist)
	This method build for this matrix the local part of a global matrix.
virtual void	localize (const _MatrixStorage &global, const Distribution &rowDist)
	This operation localizes the matrix storage of a full matrix to the part that is owned by this processor.
virtual void	replicate (const _MatrixStorage &localData, const class Distribution &rowDist)
	This routine builds the full matrix storage for a distributed matrix.
virtual void	buildCSCData (LAMAArray< IndexType > &cscIA, LAMAArray< IndexType > &cscJA, LAMAArray< ValueType > &cscValues) const
	This method builds CSC sparse data (column sizes, row indexes and data values) for a matrix storage.
virtual void	assign (const _MatrixStorage &other)
	Format conversion of matrix storage.
virtual void	copyTo (_MatrixStorage &other) const
	The opposite routine to assign, for convenience as the other way around is sometimes more efficient.
virtual void	assignTranspose (const MatrixStorage< ValueType > &other)
	Transpose of matrix storage.
virtual void	redistribute (const _MatrixStorage &other, const class Redistributor &redistributor)
	This methods assigns a redistributed matrix.
virtual void	exchangeHalo (const class Halo &halo, const MatrixStorage< ValueType > &matrix, const class Communicator &comm)
	Build a halo matrix with all rows of required indexes.
virtual void	writeToFile (const std::string &fileName, const File::FileType fileType=File::BINARY, const File::DataType dataType=File::INTERNAL, const File::IndexDataType indexDataTypeIA=File::INT, const File::IndexDataType indexDataTypeJA=File::INT) const
	get the number of elements left/right of the diagonal for the given row
virtual void	writeToFile (const PartitionId size, const PartitionId rank, const std::string &fileName, const File::FileType fileType=File::BINARY, const File::DataType dataType=File::INTERNAL, const File::IndexDataType indexDataTypeIA=File::INT, const File::IndexDataType indexDataTypeJA=File::INT) const
virtual void	readFromFile (const std::string &fileName)
virtual void	invert (const MatrixStorage< ValueType > &other)
	assign this storage with the inverse of another matrix.
virtual void	matrixTimesVector (LAMAArrayView< ValueType > result, const ValueType alpha, const LAMAArrayConstView< ValueType > x, const ValueType beta, const LAMAArrayConstView< ValueType > y) const
	This method implements result = alpha * thisMatrix * x + beta * y.
virtual void	matrixTimesVectorN (LAMAArrayView< ValueType > result, const IndexType n, const ValueType alpha, const LAMAArrayConstView< ValueType > x, const ValueType beta, const LAMAArrayConstView< ValueType > y) const
virtual std::auto_ptr< SyncToken >	matrixTimesVectorAsync (LAMAArrayView< ValueType > result, const ValueType alpha, const LAMAArrayConstView< ValueType > x, const ValueType beta, const LAMAArrayConstView< ValueType > y) const
	This method implements result = alpha * thisMatrix * x + beta * y that is executed asynchronously.
virtual void	matrixTimesScalar (const ValueType alpha, const MatrixStorage< ValueType > &a)
	Assign this = alpha * a.
virtual void	matrixTimesMatrix (const ValueType alpha, const MatrixStorage< ValueType > &a, const MatrixStorage< ValueType > &b, const ValueType beta, const MatrixStorage< ValueType > &c)
	assign alpha * a * b + beta * c
virtual ValueType	maxDiffNorm (const MatrixStorage< ValueType > &other)
	Get the maximal absolue element-wise difference between two matrix storages.
virtual void	jacobiIterate (LAMAArrayView< ValueType > solution, const LAMAArrayConstView< ValueType > oldSolution, const LAMAArrayConstView< ValueType > rhs, const ValueType omega) const
	Jacobi iteration step on a local storage.
virtual std::auto_ptr< SyncToken >	jacobiIterateAsync (LAMAArrayView< ValueType > solution, const LAMAArrayConstView< ValueType > oldSolution, const LAMAArrayConstView< ValueType > rhs, const ValueType omega) const
	Asynchrounous version of jacobiIterate.
virtual void	jacobiIterateHalo (LAMAArrayView< ValueType > localSolution, const MatrixStorage< ValueType > &localStorage, const LAMAArrayConstView< ValueType > haloOldSolution, const ValueType omega) const
	Jacobi iteration step on a halo storage.
void	init (const IndexType numRows, const IndexType numColumns)
	Initialization of base class due to a resize.
void	setContext (ContextPtr context)
	Set the preferred context for the matrix storage.
ContextPtr	getContextPtr () const
	Getter for the preferred context of the storage data, returns pointer.
const Context &	getContext () const
	Getter for the preferred context of the storage data.
void	prefetch () const
	Method that prefetches storage data to its preferred location.
void	setCompressThreshold (float ratio)
	Allow for additional row compression.
IndexType	getNumRows () const
IndexType	getNumColumns () const
void	resetDiagonalProperty ()
bool	hasDiagonalProperty () const
const LAMAArray< IndexType > &	getRowIndexes () const
size_t	getMemoryUsage () const
	Returns the number of bytes needed for the current matrix.
Static Public Member Functions
static const char *	typeName ()
	get typename of the matrix storage format.
static void	convertCSR2CSC (LAMAArray< IndexType > &colIA, LAMAArray< IndexType > &colJA, LAMAArray< ValueType > &colValues, const IndexType numColumns, const LAMAArray< IndexType > &rowIA, const LAMAArray< IndexType > &rowJA, const LAMAArray< ValueType > &rowValues, const ContextPtr loc)
	Conversion routine of Compressed Sparse Row data to Compressed Sparse Column.
static void	joinRows (LAMAArray< IndexType > &outIA, LAMAArray< IndexType > &outJA, LAMAArray< ValueType > &outValues, const IndexType numRows, const LAMAArray< IndexType > &rowIndexes, const LAMAArray< IndexType > &inIA, const LAMAArray< IndexType > &inJA, const LAMAArray< ValueType > &inValues)
	Method that joins rows of another matrix storage.
static void	offsets2sizes (LAMAArray< IndexType > &offsets)
	Help routines to convert arrays with sizes to offsets and vice versa.
static void	offsets2sizes (LAMAArray< IndexType > &sizes, const LAMAArray< IndexType > &offsets)
static IndexType	sizes2offsets (LAMAArray< IndexType > &sizes)
	Utitily to compute the offset array from a sizes array.
Protected Member Functions
void	swap (MatrixStorage< ValueType > &other)
	Swap member variables of base class MatrixStorage<T>
void	swap (_MatrixStorage &other)
	Swaps this with other.
virtual void	_assignTranspose (const _MatrixStorage &other)
virtual void	_assign (const _MatrixStorage &other)
Protected Attributes
ValueType	mEpsilon
	The value mEpsilon is an individual value for each matrix storage that specifies a threshold when a matrix values can be considered as zero.
IndexType	mNumRows
IndexType	mNumColumns
LAMAArray< IndexType >	mRowIndexes
	used in case of sparse representation of ia
float	mCompressThreshold
	ratio at which compression is done, 0 for never, 1 for always
bool	mDiagonalProperty
	if true, diagonal elements are always stored at first position in each row
ContextPtr	mContext
	preferred context for the storage
Private Member Functions
void	print () const
virtual bool	checkDiagonalProperty () const
	checks if in each row the diagonal element is stored first.
	LAMA_LOG_DECL_STATIC_LOGGER (logger)
	logger for this matrix format
Private Attributes
std::vector< Row >	mRows
IndexType	mNumValues
	count number of all row elements

Detailed Description

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

The template SparseAssemblyStorage is a convenient intermediate container to construct a sparse matrix which structure is not known a priori.

The SparseAssemblyStorage should allow a convenient construction of a sparse matrix if the structure of this in not know prior to its construction. The complexity of inserting a new element is constant (amortized time, reallocation may happen).

Due to the use of std::vector, this storage will only reside on the host.

Member Typedef Documentation

template<typename T>

typedef T lama::SparseAssemblyStorage< T >::ValueType

The type of the values.

Reimplemented from lama::MatrixStorage< T >.

Constructor & Destructor Documentation

template<typename T >

lama::SparseAssemblyStorage< T >::SparseAssemblyStorage ( )

The default constructor creates an empty SparseAssemblyStorage.

template<typename T >

lama::SparseAssemblyStorage< T >::SparseAssemblyStorage ( const SparseAssemblyStorage< ValueType > & other )

The copy constructor creates a SparseAssemblyStorage which is a copy of the passed SparseAssemblyStorage.

Parameters:

[in] other the SparseAssemblyStorage to take a copy from.

template<typename T >

lama::SparseAssemblyStorage< T >::SparseAssemblyStorage ( const _MatrixStorage & other ) [explicit]

This constructor creates a SparseAssemblyStorage which is initialized with the values of the passed MatrixStorage.

Parameters:

[in] other the MatrixStorage to take the values for initialization.

References lama::MatrixStorage< T >::assign().

template<typename T >

lama::SparseAssemblyStorage< T >::SparseAssemblyStorage	(	const IndexType	numRows,
		const IndexType	numColumns,
		const IndexType	numValuesPerRow = `10`
	)

This constructor creates a SparseAssemblyStorage with the given number of rows and columns.

This constructor creates a SparseAssemblyStorage with the given number of rows and columns. As a performance optimization the user can specify the optional parameter numValuesPerRow, which determines the approximate number of none zeros per row needed.

Parameters:

[in]	numRows	the number of rows the matrix should have.
[in]	numColumns	the number of columns the matrix should have.
[in]	numValuesPerRow	the storage that should be reserver for each row. (Default: 10)

References lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::SparseAssemblyStorage< T >::mRows.

template<typename T >

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

The destructor releases the allocated memory.

Member Function Documentation

void lama::_MatrixStorage::_assign ( const _MatrixStorage & other ) [protected, virtual, inherited]

References lama::LAMAArray< T >::clear(), lama::_MatrixStorage::mCompressThreshold, lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::_MatrixStorage::mRowIndexes.

Referenced by lama::CSRStorage< T >::assign(), lama::DenseStorageView< T >::assignDenseStorageImpl(), and lama::JDSStorage< T >::assignJDS().

void lama::_MatrixStorage::_assignTranspose ( const _MatrixStorage & other ) [protected, virtual, inherited]

References lama::LAMAArray< T >::clear(), lama::_MatrixStorage::mCompressThreshold, lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::_MatrixStorage::mRowIndexes.

Referenced by lama::CSRStorage< T >::assignTranspose().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::allocate	(	const IndexType	numRows,
		const IndexType	numColumns
	)		`[virtual]`

Implementation of pure method _MatrixStorage::allocate.

Implements lama::_MatrixStorage.

References lama::_MatrixStorage::init().

Referenced by lama::SparseAssemblyStorage< T >::setIdentity().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::assign ( const _MatrixStorage< T > & other ) [virtual, inherited]

Format conversion of matrix storage.

A default implementation is provided using CSR data. Derived clauses might override this method with more efficient solutions.

Implements lama::_MatrixStorage.

Reimplemented in lama::CSRStorage< T >, and lama::DenseStorageView< T >.

References lama::_MatrixStorage::buildCSRData(), lama::_MatrixStorage::copyTo(), lama::CSR, lama::File::DOUBLE, lama::File::FLOAT, lama::_MatrixStorage::getFormat(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::_MatrixStorage::getValueType(), and lama::_LAMAArray::size().

Referenced by lama::DenseStorageView< T >::assign(), lama::SparseMatrix< T >::assign(), lama::COOStorage< T >::COOStorage(), lama::DIAStorage< T >::DIAStorage(), lama::ELLStorage< T >::ELLStorage(), lama::JDSStorage< T >::JDSStorage(), lama::SparseAssemblyStorage< T >::SparseAssemblyStorage(), and lama::MatrixStorage< T >::splitHalo().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::assignTranspose ( const MatrixStorage< ValueType > & other ) [virtual, inherited]

Transpose of matrix storage.

A default implementation is provided using CSR data. Derived clauses might override this method with more efficient solutions.

Note: type conversion is not supported here

Reimplemented in lama::CSRStorage< T >.

References lama::MatrixStorage< T >::buildCSCData(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), and lama::_LAMAArray::size().

template<typename T >

void lama::MatrixStorage< T >::buildCSCData	(	LAMAArray< IndexType > &	cscIA,
		LAMAArray< IndexType > &	cscJA,
		LAMAArray< ValueType > &	cscValues
	)		const `[virtual, inherited]`

This method builds CSC sparse data (column sizes, row indexes and data values) for a matrix storage.

For efficiency a derived class might override this method, e.g. for CSR storage.

Reimplemented in lama::CSRStorage< T >.

Referenced by lama::CSRStorage< T >::assignTranspose(), lama::MatrixStorage< T >::assignTranspose(), and lama::SparseMatrix< T >::assignTransposeImpl().

template<typename ValueType >

template<typename OtherValueType >

void lama::SparseAssemblyStorage< ValueType >::buildCSR	(	LAMAArray< IndexType > &	ia,
		LAMAArray< IndexType > *	ja,
		LAMAArray< OtherValueType > *	values,
		const ContextPtr
	)		const

General routine to build any kind of CSR storage.

Parameters:

[out]	ia	is the CSR offset array
[out]	ja	is the array with the column indexes (optional)
[out]	values	is the array with the non-zero matrix values (optional)
[in]	loc	is the Context where conversion should be done

References lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_DEBUG, lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, lama::WriteAccess< T >::resize(), lama::_LAMAArray::size(), and lama::_MatrixStorage::sizes2offsets().

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::buildCSRData	(	LAMAArray< IndexType > &	csrIA,
		LAMAArray< IndexType > &	csrJA,
		_LAMAArray &	csrValues
	)		const `[inline, virtual, inherited]`

Get the matrix data of the storage in CSR format.

Parameters:

[out]	csrIA	offset array for rows, csrIA.size() == numRows + 1
[out]	csrJA	column indexes, csrJA.size() == csrIA[ csrIA.size() ]
[out]	csrValues	are the non-zero matrix values, csrJA.size() == csrValues.size()

The csr data will have the diagonal property if this->hasDiagonalProperty() is true.

Note: This routine supports also type conversion between different value types.

     DenseStorage<double> dense( ... )
     LAMAArray<IndexType> ia, ja;
     LAMAArray<float> values;
     // get non-zero values of dense matrix as float values
     dense.buildCSRData( ia, ja, values );

This routine must be provided by each matrix storage format.

Implements lama::_MatrixStorage.

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::buildCSRSizes ( LAMAArray< IndexType > & ia ) const [inline, virtual, inherited]

Implementation for _MatrixStorage::buildCSRSizes.

Implements lama::_MatrixStorage.

template<typename T>

void lama::MatrixStorage< ValueType >::buildHalo	(	class Halo &	halo,
		const class Distribution &	colDist
	)		`[virtual, inherited]`

Special version of splitHalo where this matrix contains no local data and where haloData is aliased to this matrix.

This routine is used to translate the non-local column indexes (required values) to local halo indexes and to set up the exchange schedule.

References lama::Distribution::getGlobalSize(), LAMA_ASSERT_EQUAL, and lama::_LAMAArray::size().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::check ( const char * msg ) const [virtual]

Test the storage data for inconsistencies.

Parameters:

[in] msg is additional message string that should be used to identify calling routine

Exceptions:

Exception in case of any inconsistency.

Implements lama::_MatrixStorage.

References LAMA_THROWEXCEPTION.

template<typename ValueType >

bool lama::SparseAssemblyStorage< ValueType >::checkDiagonalProperty ( ) const [private, virtual]

checks if in each row the diagonal element is stored first.

Implements lama::_MatrixStorage.

References lama::SparseAssemblyStorage< T >::Row::ja, and lama::min().

Referenced by lama::SparseAssemblyStorage< T >::setCSRDataImpl().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::clear ( ) [virtual]

Implementation of pure method for _MatrixStorage.

Implements lama::_MatrixStorage.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::convertCSR2CSC	(	LAMAArray< IndexType > &	colIA,
		LAMAArray< IndexType > &	colJA,
		LAMAArray< ValueType > &	colValues,
		const IndexType	numColumns,
		const LAMAArray< IndexType > &	rowIA,
		const LAMAArray< IndexType > &	rowJA,
		const LAMAArray< ValueType > &	rowValues,
		const ContextPtr	loc
	)		`[static, inherited]`

Conversion routine of Compressed Sparse Row data to Compressed Sparse Column.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_DEBUG, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_T, LAMA_REGION, and lama::_LAMAArray::size().

template<typename T>

virtual SparseAssemblyStorage* lama::SparseAssemblyStorage< T >::copy ( ) const [inline, virtual]

Override _MatrixStorage::copy with routine that uses covariant return type.

Implements lama::MatrixStorage< T >.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::copyTo ( _MatrixStorage< T > & other ) const [virtual, inherited]

The opposite routine to assign, for convenience as the other way around is sometimes more efficient.

Implements lama::_MatrixStorage.

Reimplemented in lama::CSRStorage< T >.

References LAMA_ASSERT_EQUAL_DEBUG, lama::_MatrixStorage::setCSRData(), and lama::_LAMAArray::size().

template<typename T>

virtual SparseAssemblyStorage* lama::SparseAssemblyStorage< T >::create ( ) const [inline, virtual]

Implementation of MatrixStorage::create for derived class.

Implements lama::MatrixStorage< T >.

template<typename T>

void lama::MatrixStorage< ValueType >::exchangeHalo	(	const class Halo &	halo,
		const MatrixStorage< ValueType > &	matrix,
		const class Communicator &	comm
	)		`[virtual, inherited]`

Build a halo matrix with all rows of required indexes.

References lama::_MatrixStorage::buildCSRData(), lama::_MatrixStorage::getNumColumns(), and lama::_LAMAArray::size().

Referenced by lama::SparseMatrix< T >::matrixTimesMatrixImpl().

template<typename T >

void lama::SparseAssemblyStorage< T >::fixDiagonalProperty ( const IndexType i )

fixDiagonalProperty fixes the diagonal property of row.

fixDiagonalProperty fixes the diagonal property of row. If needed a zero entry is added.

Parameters:

[in] i the row to fix the diagonal property.

References lama::_MatrixStorage::mNumColumns, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, and lama::SparseAssemblyStorage< T >::swap().

const Context& lama::_MatrixStorage::getContext ( ) const [inline, inherited]

Getter for the preferred context of the storage data.

Referenced by lama::ELLStorage< T >::ELLStorage().

ContextPtr lama::_MatrixStorage::getContextPtr ( ) const [inline, inherited]

Getter for the preferred context of the storage data, returns pointer.

Referenced by lama::SpecializedJacobi::iterateTyped(), and lama::JDSStorage< T >::JDSStorage().

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::getDiagonal ( _LAMAArray & diagonal ) const [inline, virtual, inherited]

This method returns the diagonal of the matrix.

Parameters:

[out] diagonal is the destination array

The values will be stored in diagonal that can be of any type for which implicit conversion is available.

Implements lama::_MatrixStorage.

template<typename ValueType >

template<typename OtherValueType >

void lama::SparseAssemblyStorage< ValueType >::getDiagonalImpl ( LAMAArray< OtherValueType > & diagonal ) const

Typed version of getDiagonal.

Parameters:

[out] diagonal is the typed LAMA array for output

References lama::min(), lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::SparseAssemblyStorage< T >::operator()().

template<typename ValueType >

MatrixStorageFormat lama::SparseAssemblyStorage< ValueType >::getFormat ( ) const [virtual]

Getter routine for the enum value that stands for this format.

Implements lama::_MatrixStorage.

References lama::ASSEMBLY.

template<typename T >

const std::vector< IndexType > & lama::SparseAssemblyStorage< T >::getJa ( const IndexType i ) const

getJa returns a constant reference to the column index array of the given row.

Parameters:

[in] i the row to get the column index array for.

Returns:: a const reference to the column index array of row i.

References lama::SparseAssemblyStorage< T >::mRows.

template<typename T >

std::vector< IndexType > & lama::SparseAssemblyStorage< T >::getJa ( const IndexType i )

References lama::SparseAssemblyStorage< T >::mRows.

size_t lama::_MatrixStorage::getMemoryUsage ( ) const [inherited]

Returns the number of bytes needed for the current matrix.

Note: This routine does not tell how many memory is really allocated. Storage data might be allocated on more than one device. Furthermore, it is possible that arrays have more memory reserved than needed for its current size.

References lama::_MatrixStorage::getMemoryUsageImpl(), lama::_MatrixStorage::mRowIndexes, and lama::_LAMAArray::size().

template<typename ValueType >

size_t lama::SparseAssemblyStorage< ValueType >::getMemoryUsageImpl ( ) const [virtual]

Implementation for pure method is provided.

Implements lama::_MatrixStorage.

IndexType lama::_MatrixStorage::getNumColumns ( ) const [inline, inherited]

References lama::_MatrixStorage::mNumColumns.

IndexType lama::_MatrixStorage::getNumRows ( ) const [inline, inherited]

References lama::_MatrixStorage::mNumRows.

Referenced by lama::SparseMatrix< T >::assign(), lama::DenseMatrix< T >::assign(), lama::MatrixStorage< T >::assign(), lama::MatrixStorage< T >::assignTranspose(), lama::InverseSolver::decompose(), lama::InverseSolver::invert(), lama::DenseMatrix< T >::invertCyclic(), lama::SOR::iterateImpl(), lama::JDSStorage< T >::jacobiIterateHalo(), lama::ELLStorage< T >::jacobiIterateHalo(), lama::CSRStorage< T >::jacobiIterateHalo(), lama::DenseMatrix< T >::joinColumnData(), lama::MatrixStorage< T >::joinHalo(), lama::_MatrixStorage::localize(), lama::DenseMatrix< T >::localize(), lama::MatrixStorage< T >::localize(), lama::CSRStorage< T >::matrixAddMatrixCSR(), lama::ELLStorage< T >::matrixAddMatrixELL(), lama::CSRStorage< T >::matrixTimesMatrixCSR(), lama::DenseStorageView< T >::matrixTimesMatrixDense(), lama::ELLStorage< T >::matrixTimesMatrixELL(), lama::DenseStorageView< T >::maxDiffNorm(), lama::CSRStorage< T >::maxDiffNorm(), lama::MatrixStorage< T >::maxDiffNorm(), lama::MatrixStorage< T >::redistribute(), lama::MatrixStorage< T >::replicate(), lama::replicate(), lama::SparseMatrix< T >::set(), lama::DenseMatrix< T >::splitColumnData(), lama::JDSSparseMatrix< T >::swapLocalStorage(), lama::CSRSparseMatrix< T >::swapLocalStorage(), lama::COOSparseMatrix< T >::swapLocalStorage(), lama::DIASparseMatrix< T >::swapLocalStorage(), and lama::ELLSparseMatrix< T >::swapLocalStorage().

template<typename T >

IndexType lama::SparseAssemblyStorage< T >::getNumValues ( ) const [virtual]

getNumValues returns the number values stored in this matrix.

Returns:: the number of values stored in this matrix.

Reimplemented from lama::_MatrixStorage.

References lama::SparseAssemblyStorage< T >::mNumValues.

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::getRow	(	_LAMAArray &	row,
		const IndexType	i
	)		const `[inline, virtual, inherited]`

Get the i-th row of a storage as LAMA array.

Implements lama::_MatrixStorage.

template<typename ValueType >

template<typename OtherType >

void lama::SparseAssemblyStorage< ValueType >::getRowImpl	(	LAMAArray< OtherType > &	row,
		const IndexType	i
	)		const

Template method for getting row.

References LAMA_ASSERT_DEBUG, LAMA_ASSERT_EQUAL_DEBUG, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::SparseAssemblyStorage< T >::mRows.

const LAMAArray< IndexType > & lama::_MatrixStorage::getRowIndexes ( ) const [inline, inherited]

References lama::_MatrixStorage::mRowIndexes.

virtual const char* lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::getTypeName ( ) const [inline, virtual, inherited]

Implementation of MatrixStorage::getTypeName for derived class.

Implements lama::_MatrixStorage.

template<typename T>

ValueType lama::SparseAssemblyStorage< T >::getValue	(	const IndexType	i,
		const IndexType	j
	)		const `[inline, virtual]`

Get a value of the matrix.

Parameters:

[in]	i	is the row index, 0 <= i < mNumRows
[in]	j	is the colum index, 0 <= j < mNumRows

Exceptions:

Exception out-of-range is enabled for ASSERT_LEVEL=DEBUG.

Implements lama::MatrixStorage< T >.

template<typename T >

const std::vector< typename SparseAssemblyStorage< T >::ValueType > & lama::SparseAssemblyStorage< T >::getValues ( const IndexType i ) const

getValues returns a constant reference to the values array of the given row.

Parameters:

[in] i the row to get the value array for.

Returns:: a const reference to the value array of row i.

References lama::SparseAssemblyStorage< T >::mRows.

template<typename ValueType >

Scalar::ScalarType lama::MatrixStorage< ValueType >::getValueType ( ) const [virtual, inherited]

Implementation of pure method.

Implements lama::_MatrixStorage.

Reimplemented in lama::DenseStorageView< T >.

Referenced by lama::DenseStorageView< T >::maxDiffNorm(), and lama::CSRStorage< T >::maxDiffNorm().

bool lama::_MatrixStorage::hasDiagonalProperty ( ) const [inline, inherited]

References lama::_MatrixStorage::mDiagonalProperty.

Referenced by lama::SOR::iterateImpl(), lama::JDSStorage< T >::jacobiIterateHalo(), lama::ELLStorage< T >::jacobiIterateHalo(), lama::CSRStorage< T >::jacobiIterateHalo(), and lama::MatrixStorage< T >::joinHalo().

void lama::_MatrixStorage::init	(	const IndexType	numRows,
		const IndexType	numColumns
	)		`[inherited]`

Initialization of base class due to a resize.

References lama::_MatrixStorage::mCompressThreshold, lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, and lama::_MatrixStorage::mNumRows.

Referenced by lama::_MatrixStorage::_MatrixStorage(), lama::SparseAssemblyStorage< T >::allocate(), lama::CSRStorage< T >::allocate(), lama::JDSStorage< T >::setCSRDataImpl(), lama::ELLStorage< T >::setCSRDataImpl(), lama::DIAStorage< T >::setCSRDataImpl(), and lama::CSRStorage< T >::setIdentity().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::invert ( const MatrixStorage< ValueType > & other ) [virtual, inherited]

assign this storage with the inverse of another matrix.

Parameters:

[in] other is matrix to invert, must be square

Note: other matrix storage can be aliased with this storage.

Reimplemented in lama::DenseStorageView< T >.

References lama::DenseStorageView< T >::invert().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::jacobiIterate	(	LAMAArrayView< ValueType >	solution,
		const LAMAArrayConstView< ValueType >	oldSolution,
		const LAMAArrayConstView< ValueType >	rhs,
		const ValueType	omega
	)		const `[virtual, inherited]`

Jacobi iteration step on a local storage.

solution = omega * ( rhs + B * oldSolution) * dinv + ( 1 - omega ) * oldSolution

where B is this storage without diagonal, dinv the inverse diagonal

Parameters:

[out]	solution	is the solution vector to be computed
[in]	oldSolution	is the old solution vector
[in]	rhs	is the right hand side of equation system to solve
[in]	omega	is the scaling factor

Reimplemented in lama::CSRStorage< T >, lama::ELLStorage< T >, lama::COOStorage< T >, lama::DIAStorage< T >, and lama::JDSStorage< T >.

References lama::CSRStorage< T >::jacobiIterate(), and LAMA_UNSUPPORTED.

Referenced by lama::SpecializedJacobi::iterateTyped().

template<typename ValueType >

std::auto_ptr< SyncToken > lama::MatrixStorage< ValueType >::jacobiIterateAsync	(	LAMAArrayView< ValueType >	solution,
		const LAMAArrayConstView< ValueType >	oldSolution,
		const LAMAArrayConstView< ValueType >	rhs,
		const ValueType	omega
	)		const `[virtual, inherited]`

Asynchrounous version of jacobiIterate.

Referenced by lama::SpecializedJacobi::iterateTyped().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::jacobiIterateHalo	(	LAMAArrayView< ValueType >	localSolution,
		const MatrixStorage< ValueType > &	localStorage,
		const LAMAArrayConstView< ValueType >	haloOldSolution,
		const ValueType	omega
	)		const `[virtual, inherited]`

Jacobi iteration step on a halo storage.

solution -= omega * ( B(halo) * oldSolution) * dinv

Parameters:

[in,out]	localSolution	is the solution vector that is updated
[in]	localStorage	is needed to get the diagonal
[in]	haloOldSolution	is the old solution vector of halo part
[in]	omega	is the scaling factor.

While local storage must be square and have the diagonal property, this matrix storage does not have to be square.

Reimplemented in lama::CSRStorage< T >, lama::ELLStorage< T >, and lama::JDSStorage< T >.

References lama::CSRStorage< T >::jacobiIterateHalo(), and LAMA_UNSUPPORTED.

Referenced by lama::SpecializedJacobi::iterateTyped().

template<typename T>

void lama::MatrixStorage< ValueType >::joinHalo	(	const _MatrixStorage< T > &	localData,
		const _MatrixStorage< T > &	haloData,
		const class Halo &	halo,
		const class Distribution &	colDist
	)		`[virtual, inherited]`

Join local and halo storage back into one storage as needed for NoDistribution.

This matrix storage is used as output matrix.

Parameters:

[in]	localData	is matrix storage with local data
[in]	haloData	is the matrix storage with halo data
[in]	halo	is the communicaton halo, contains also mapping halo to global indexes
[in]	colDist	is the distribution that has be used for getting the local data

Attention: localData might be aliased with this matrix storage, while haloData must not

Derived classes might use a default implementation that is based on joining CSR data with corresponding conversions.

References lama::_MatrixStorage::buildCSRData(), lama::Distribution::getGlobalSize(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::Halo::getRequiredIndexes(), lama::_MatrixStorage::hasDiagonalProperty(), lama::Distribution::local2global(), lama::min(), and lama::_LAMAArray::size().

Referenced by lama::SparseMatrix< T >::writeToFile().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::joinRows	(	LAMAArray< IndexType > &	outIA,
		LAMAArray< IndexType > &	outJA,
		LAMAArray< ValueType > &	outValues,
		const IndexType	numRows,
		const LAMAArray< IndexType > &	rowIndexes,
		const LAMAArray< IndexType > &	inIA,
		const LAMAArray< IndexType > &	inJA,
		const LAMAArray< ValueType > &	inValues
	)		`[static, inherited]`

Method that joins rows of another matrix storage.

row(i) of out contains all elements of in(k) with rowIndexes[k] == i

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), lama::WriteAccess< T >::resize(), lama::ReadAccess< T >::size(), and lama::WriteAccess< T >::size().

template<typename T>

lama::SparseAssemblyStorage< T >::LAMA_LOG_DECL_STATIC_LOGGER ( logger ) [private]

logger for this matrix format

Reimplemented from lama::_MatrixStorage.

void lama::_MatrixStorage::localize	(	const _MatrixStorage &	global,
		const Distribution &	rowDist
	)		`[virtual, inherited]`

This operation localizes the matrix storage of a full matrix to the part that is owned by this processor.

This means that only the owned rows of the matrix will be kept.

Notes:

* routine can also be used if global is aliased with this matrix. * this routine is the same as an assign in case of a replicated distribution

References lama::Distribution::getGlobalSize(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), LAMA_ASSERT_EQUAL_ERROR, and LAMA_THROWEXCEPTION.

template<typename T>

void lama::MatrixStorage< ValueType >::localize	(	const _MatrixStorage< T > &	globalData,
		const class Distribution &	rowDist
	)		`[virtual, inherited]`

This method build for this matrix the local part of a global matrix.

The row distribution specifies which rows of the global matrix will be used for this storage locally.

Attention: globalMatrix might be aliased to this storage.

References lama::_MatrixStorage::buildCSRData(), lama::Distribution::getGlobalSize(), lama::Distribution::getLocalSize(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::Distribution::isReplicated(), LAMA_ASSERT_EQUAL_ERROR, and lama::_LAMAArray::size().

Referenced by lama::DenseMatrix< T >::assign(), and lama::MatrixStorage< T >::splitHalo().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::matrixTimesMatrix	(	const ValueType	alpha,
		const MatrixStorage< ValueType > &	a,
		const MatrixStorage< ValueType > &	b,
		const ValueType	beta,
		const MatrixStorage< ValueType > &	c
	)		`[virtual, inherited]`

assign alpha * a * b + beta * c

Reimplemented in lama::CSRStorage< T >, lama::ELLStorage< T >, and lama::DenseStorageView< T >.

References lama::CSRStorage< T >::check(), LAMA_UNSUPPORTED, and lama::CSRStorage< T >::matrixTimesMatrix().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::matrixTimesScalar	(	const ValueType	alpha,
		const MatrixStorage< ValueType > &	a
	)		`[virtual, inherited]`

Assign this = alpha * a.

The default implementation assigns the matrix a and scales it afterwards.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::matrixTimesVector	(	LAMAArrayView< ValueType >	result,
		const ValueType	alpha,
		const LAMAArrayConstView< ValueType >	x,
		const ValueType	beta,
		const LAMAArrayConstView< ValueType >	y
	)		const `[virtual, inherited]`

This method implements result = alpha * thisMatrix * x + beta * y.

Each matrix storage must provide this kind of matrix-vector multiplication. Default implementation throws exception for non-availability in derived class.

Reimplemented in lama::CSRStorage< T >, lama::ELLStorage< T >, lama::COOStorage< T >, lama::DenseStorageView< T >, lama::DIAStorage< T >, and lama::JDSStorage< T >.

References LAMA_UNSUPPORTED, and lama::CSRStorage< T >::matrixTimesVector().

template<typename ValueType >

std::auto_ptr< SyncToken > lama::MatrixStorage< ValueType >::matrixTimesVectorAsync	(	LAMAArrayView< ValueType >	result,
		const ValueType	alpha,
		const LAMAArrayConstView< ValueType >	x,
		const ValueType	beta,
		const LAMAArrayConstView< ValueType >	y
	)		const `[virtual, inherited]`

This method implements result = alpha * thisMatrix * x + beta * y that is executed asynchronously.

Each matrix storage should provide this kind of matrix-vector multiplication.

A default implementation is provided that does the operation synchronsly and returns a NoSyncToken.

Reimplemented in lama::CSRStorage< T >, and lama::ELLStorage< T >.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::matrixTimesVectorN	(	LAMAArrayView< ValueType >	result,
		const IndexType	n,
		const ValueType	alpha,
		const LAMAArrayConstView< ValueType >	x,
		const ValueType	beta,
		const LAMAArrayConstView< ValueType >	y
	)		const `[virtual, inherited]`

Reimplemented in lama::CSRStorage< T >.

References LAMA_UNSUPPORTED, and lama::CSRStorage< T >::matrixTimesVectorN().

template<typename ValueType >

ValueType lama::MatrixStorage< ValueType >::maxDiffNorm ( const MatrixStorage< ValueType > & other ) [virtual, inherited]

Get the maximal absolue element-wise difference between two matrix storages.

Reimplemented in lama::CSRStorage< T >, and lama::DenseStorageView< T >.

References lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), LAMA_ASSERT_EQUAL_ERROR, LAMA_UNSUPPORTED, and lama::DenseStorageView< T >::maxDiffNorm().

void lama::_MatrixStorage::offsets2sizes ( LAMAArray< IndexType > & offsets ) [static, inherited]

Help routines to convert arrays with sizes to offsets and vice versa.

References lama::WriteAccess< T >::resize(), and lama::_LAMAArray::size().

Referenced by lama::_MatrixStorage::offsets2sizes().

void lama::_MatrixStorage::offsets2sizes	(	LAMAArray< IndexType > &	sizes,
		const LAMAArray< IndexType > &	offsets
	)		`[static, inherited]`

References lama::WriteAccess< T >::clear(), lama::_MatrixStorage::offsets2sizes(), lama::WriteAccess< T >::resize(), and lama::_LAMAArray::size().

template<typename T >

SparseAssemblyStorage< T >::ValueType lama::SparseAssemblyStorage< T >::operator()	(	const IndexType	i,
		const IndexType	j
	)		const

the access operator returns a copy of the element at the queried position.

The access operator returns a copy of the element at the queried position. The runtime is linear with respect to the number of none zero values in the queried row, because the rows do not need to be sorted. A zero is returned if the there is no element at the queried position.

Parameters:

[in]	i	the row to get the value at.
[in]	j	the column to get the value at.

Returns:: a copy of the value at (i,j) or zero.

References LAMA_THROWEXCEPTION, lama::_MatrixStorage::mNumColumns, and lama::SparseAssemblyStorage< T >::mRows.

Referenced by lama::SparseAssemblyStorage< T >::getDiagonalImpl().

template<typename T>

SparseAssemblyStorage< T > & lama::SparseAssemblyStorage< T >::operator= ( const SparseAssemblyStorage< T > & other )

The assignment operator sets the values of this to the values of the passed SparseAssemblyStorage.

Parameters:

[in] other the SparseAssemblyStorage to take a copy from.

Returns:: a reference to this.

References lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mNumValues, and lama::SparseAssemblyStorage< T >::mRows.

template<typename T>

SparseAssemblyStorage< T > & lama::SparseAssemblyStorage< T >::operator= ( const _MatrixStorage & other )

Assignment operator for arbitry storages.

Reimplemented from lama::MatrixStorage< T >.

void lama::_MatrixStorage::prefetch ( ) const [inline, inherited]

Method that prefetches storage data to its preferred location.

References lama::_MatrixStorage::prefetch().

Referenced by lama::_MatrixStorage::prefetch().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::prefetch ( const ContextPtr location ) const [virtual]

Initiate an asynchronous data transfer to a specified location.

Implements lama::_MatrixStorage.

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::print ( ) const [private]

References lama::SparseAssemblyStorage< T >::Row::ja, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, and lama::SparseAssemblyStorage< T >::Row::values.

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::purge ( ) [virtual]

Implementation of pure method of class MatrixStorage.

Implements lama::_MatrixStorage.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::readFromFile ( const std::string & fileName ) [virtual, inherited]

References lama::_LAMAArray::size().

template<typename T>

void lama::MatrixStorage< ValueType >::redistribute	(	const _MatrixStorage< T > &	other,
		const class Redistributor &	redistributor
	)		`[virtual, inherited]`

This methods assigns a redistributed matrix.

Parameters:

[in]	other	is the local part of the matrix data to redistribute
[in]	redistributor	contains source distribution of other and target distribution of this

References lama::_MatrixStorage::buildCSRData(), lama::Distribution::getLocalSize(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::Redistributor::getSourceDistributionPtr(), lama::Redistributor::getTargetDistributionPtr(), lama::Distribution::isReplicated(), LAMA_ASSERT_EQUAL_ERROR, and lama::_LAMAArray::size().

template<typename T>

void lama::MatrixStorage< ValueType >::replicate	(	const _MatrixStorage< T > &	localData,
		const class Distribution &	rowDist
	)		`[virtual, inherited]`

This routine builds the full matrix storage for a distributed matrix.

This routine is exactly the inverse routine to the localize routine. After this operation this matrix storage will contain on each processor the global matrix data.

References lama::Distribution::getGlobalSize(), lama::Distribution::getLocalSize(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::Distribution::isReplicated(), LAMA_ASSERT_EQUAL_ERROR, and lama::_LAMAArray::size().

void lama::_MatrixStorage::resetDiagonalProperty ( ) [inherited]

References lama::_MatrixStorage::checkDiagonalProperty(), and lama::_MatrixStorage::mDiagonalProperty.

Referenced by lama::COOStorage< T >::COOStorage(), lama::ELLStorage< T >::ELLStorage(), and lama::JDSStorage< T >::JDSStorage().

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::scale ( const Scalar value ) [inline, virtual, inherited]

This method scales all matrix values with a scalar.

Parameters:

[in] value is the source value

Implements lama::_MatrixStorage.

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::scale ( const _LAMAArray & diagonal ) [inline, virtual, inherited]

Polymorph implementation for MatrixStorage<T>::scale.

Implements lama::_MatrixStorage.

template<typename T>

template<typename OtherType >

void lama::SparseAssemblyStorage< T >::scaleImpl ( const LAMAArray< OtherType > & values )

Template version used for virtual routine scale with known value type.

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::scaleImpl ( const Scalar value )

Implementation of pure method.

References lama::Scalar::getValue(), lama::_MatrixStorage::mNumRows, and lama::SparseAssemblyStorage< T >::mRows.

template<typename T>

template<typename OtherValueType >

void lama::SparseAssemblyStorage< T >::scaleImpl ( const LAMAArray< OtherValueType > & diagonal )

References lama::min(), lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mRows, and lama::_LAMAArray::size().

template<typename T >

void lama::SparseAssemblyStorage< T >::set	(	const IndexType	i,
		const IndexType	j,
		const ValueType	value
	)

sets the element at the queried position.

sets the element at the queried position. The runtime is linear with respect to the number of none zero values in the queried row, because the rows do not need to be sorted. Although inserting an element at the end has amortized constant complexity a reallocation may be needed if there is not enough free storage is available in the queried row.

Parameters:

[in]	i	the row to get the value at.
[in]	j	the column to get the value at.
[in]	value	the value of the at (i,j)

References LAMA_THROWEXCEPTION, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, and lama::SparseAssemblyStorage< T >::swap().

void lama::_MatrixStorage::setCompressThreshold ( float ratio ) [inherited]

Allow for additional row compression.

References LAMA_THROWEXCEPTION, and lama::_MatrixStorage::mCompressThreshold.

Referenced by lama::MatrixStorage< T >::splitHalo().

void lama::_MatrixStorage::setContext ( ContextPtr context ) [inherited]

Set the preferred context for the matrix storage.

Parameters:

[in] context specifies where the storage should be allocated and where operations should be done

References lama::_MatrixStorage::mContext.

Referenced by lama::CSRStorage< T >::CSRStorage(), lama::DenseStorage< T >::DenseStorage(), and lama::ELLStorage< T >::ELLStorage().

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::setCSRData	(	const IndexType	numRows,
		const IndexType	numColumns,
		const IndexType	numValues,
		const LAMAArray< IndexType > &	ia,
		const LAMAArray< IndexType > &	ja,
		const _LAMAArray &	values
	)		`[inline, virtual, inherited]`

Implementation of _MatrixStorage::setCSRData for derived class.

This routine requires that the derived class provides a corresponding routine setCSRDataImpl that can deal with a typed version of values.

Implements lama::_MatrixStorage.

template<typename ValueType >

template<typename OtherValueType >

void lama::SparseAssemblyStorage< ValueType >::setCSRDataImpl	(	const IndexType	numRows,
		const IndexType	numColumns,
		const IndexType	numValues,
		const LAMAArray< IndexType > &	ia,
		const LAMAArray< IndexType > &	ja,
		const LAMAArray< OtherValueType > &	values,
		const ContextPtr	loc
	)

fills Assembly sparse matrix by csr sparse data.

Parameters:

[in]	numRows	number of rows
[in]	numColumns	number of columns
[in]	numValues	the number of stored elements in the matrix
[in]	ia	row pointer of the input csr sparse matrix
[in]	ja	column indexes of the input csr sparse matrix
[in]	values	the data values of the input csr sparse matrix
[in]	loc	is the context where filling takes place

References lama::SparseAssemblyStorage< T >::checkDiagonalProperty(), lama::ReadAccess< T >::get(), lama::SparseAssemblyStorage< T >::Row::ja, LAMA_ASSERT_EQUAL_ERROR, LAMA_THROWEXCEPTION, lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, lama::OpenMPUtils::validIndexes(), lama::OpenMPCSRUtils::validOffsets(), and lama::SparseAssemblyStorage< T >::Row::values.

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::setDiagonal ( const Scalar value ) [inline, virtual, inherited]

Implements lama::_MatrixStorage.

void lama::CRTPMatrixStorage< SparseAssemblyStorage< T > , T >::setDiagonal ( const _LAMAArray & diagonal ) [inline, virtual, inherited]

This method sets the diagonal of a matrix storage.

Implementation of this routine must be provided by all derived classes.

Implements lama::_MatrixStorage.

template<typename ValueType >

template<typename OtherValueType >

void lama::SparseAssemblyStorage< ValueType >::setDiagonalImpl ( const LAMAArray< OtherValueType > & diagonal )

Typed version of setDiagonal.

Parameters:

[in] diagonal is the typed LAMA array for input

References lama::_LAMAArray::size().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::setDiagonalImpl ( const Scalar scalar )

Implementation of pure method.

References lama::Scalar::getValue(), lama::min(), lama::_MatrixStorage::mNumColumns, and lama::_MatrixStorage::mNumRows.

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::setIdentity ( const IndexType size ) [virtual]

Implementation of pure method.

Implements lama::_MatrixStorage.

References lama::SparseAssemblyStorage< T >::allocate(), and lama::_MatrixStorage::mNumRows.

template<typename T >

void lama::SparseAssemblyStorage< T >::setNumColumns ( const IndexType i )

setNumColumns sets the number of columns.

setNumColumns sets the number of columns. This should be done only during the assembly of a matrix, not after diagonal properties have been fixed!

Parameters:

[in] i the number of columns.

References lama::_MatrixStorage::mNumColumns.

template<typename ValueType >

template<typename OtherValueType >

void lama::MatrixStorage< ValueType >::setRawCSRData	(	const IndexType	numRows,
		const IndexType	numColumns,
		const IndexType	numValues,
		const IndexType *const	ia,
		const IndexType *const	ja,
		const OtherValueType *const	values
	)		`[inherited]`

fills matrix storage by csr sparse data.

Parameters:

[in]	numRows	number of rows
[in]	numColumns	number of columns
[in]	numValues	the number of stored elements in the matrix
[in]	ia	row pointer of the input csr sparse matrix
[in]	ja	column indexes of the input csr sparse matrix
[in]	values	the data values of the input csr sparse matrix

Referenced by lama::MatrixCreator< T >::fillRandom().

template<typename ValueType >

template<typename OtherValueType >

template LAMA_DLL_IMPORTEXPORT void lama::MatrixStorage< T >::setRawDenseData	(	const IndexType	numRows,
		const IndexType	numColumns,
		const OtherValueType	values[],
		const ValueType	eps = `0.0`
	)		`[inherited]`

Construct a matrix from a dense matrix in row-major order (C-style).

Values of the matrix will be considered as zero if their absolute value is smaller than eps.

Parameters:

[in]	numRows	number of rows
[in]	numColumns	number of columns
[in]	values	the dense matrix values in row-major order (C-style)
[in]	eps	threshold value for non-zero elements

Sparse matrix formats will have the diagonal property if numRows == numColums

References LAMA_ASSERT_ERROR, and lama::_LAMAArray::size().

template<typename T >

void lama::SparseAssemblyStorage< T >::setRow	(	const IndexType	i,
		const LAMAArrayConstView< IndexType > &	ja,
		const LAMAArrayConstView< ValueType > &	a
	)

setRow sets the given row to the passed values.

setRow sets the given row to the passed values. The values are copied into a possibly reallocated internal row.

Parameters:

[in]	i	the row to set.
[in]	ja	the column vector of row i.
[in]	a	the values of row i.
[in]	n	the number of values in row i.

References LAMA_ASSERT_EQUAL_ERROR, lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, and lama::LAMAArrayConstView< T >::size().

IndexType lama::_MatrixStorage::sizes2offsets ( LAMAArray< IndexType > & sizes ) [static, inherited]

Utitily to compute the offset array from a sizes array.

References lama::WriteAccess< T >::resize(), and lama::_LAMAArray::size().

Referenced by lama::SparseAssemblyStorage< T >::buildCSR().

template<typename T>

void lama::MatrixStorage< ValueType >::splitHalo	(	MatrixStorage< ValueType > &	localData,
		MatrixStorage< ValueType > &	haloData,
		class Halo &	halo,
		const class Distribution &	colDist,
		const class Distribution *	rowDist
	)		const `[virtual, inherited]`

Splitting of matrix storage for halo.

Parameters:

[out]	localData	will contain all columns owned by this processor
[out]	haloData	will contain all columns not owned by this processor
[out]	halo	will be the exchange schedule
[in]	colDist	specifies the distribution of the columns
[in]	rowDist	optional, localizes the rows before splitting

References lama::_MatrixStorage::allocate(), lama::MatrixStorage< T >::assign(), lama::_MatrixStorage::check(), lama::Distribution::getGlobalSize(), lama::Distribution::getLocalSize(), lama::Distribution::isReplicated(), LAMA_ASSERT_EQUAL, LAMA_ASSERT_EQUAL_DEBUG, lama::MatrixStorage< T >::localize(), lama::_MatrixStorage::setCompressThreshold(), lama::_MatrixStorage::setCSRData(), and lama::_LAMAArray::size().

Referenced by lama::SparseMatrix< T >::set().

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::swap ( SparseAssemblyStorage< ValueType > & other )

Swaps this storage with other storage of the same type.

Parameters:

[in,out] other is the storage to be swapped with this one

References lama::SparseAssemblyStorage< T >::mNumValues, lama::SparseAssemblyStorage< T >::mRows, and lama::MatrixStorage< T >::swap().

Referenced by lama::SparseAssemblyStorage< T >::fixDiagonalProperty(), and lama::SparseAssemblyStorage< T >::set().

void lama::_MatrixStorage::swap ( _MatrixStorage & other ) [protected, inherited]

Swaps this with other.

swap is protected to avoid accidently wrong swaps of base classes which do not implement their own swap.

Parameters:

[in,out] other the _MatrixStorage to swap this with

References lama::_MatrixStorage::mCompressThreshold, lama::_MatrixStorage::mContext, lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, lama::_MatrixStorage::mRowIndexes, and lama::LAMAArray< T >::swap().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::swap ( MatrixStorage< ValueType > & other ) [protected, inherited]

Swap member variables of base class MatrixStorage<T>

Parameters:

[in,out] other the MatrixStorage to swap this with

swap is protected to avoid accidently wrong swaps of derived classes which do not implement their own swap or where storages of different format or types are involved.

 CSRStorage<float> csr;
 CSRStorage<double> csr1;
 ELLStorage<float> ell;
 csr.swap( ell ); // NOT ALLOWED, different format
 csr.swap( csr1 ); // NOT ALLOWED, different type

References lama::MatrixStorage< T >::mEpsilon.

Referenced by lama::SparseAssemblyStorage< T >::swap(), lama::DenseStorageView< T >::swap(), lama::JDSStorage< T >::swap(), lama::COOStorage< T >::swap(), lama::DIAStorage< T >::swap(), lama::CSRStorage< T >::swap(), and lama::ELLStorage< T >::swap().

template<typename T>

static const char* lama::SparseAssemblyStorage< T >::typeName ( ) [static]

get typename of the matrix storage format.

template<>

const char * lama::SparseAssemblyStorage< float >::typeName ( )

template<>

const char * lama::SparseAssemblyStorage< double >::typeName ( )

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::wait ( ) const [virtual]

Will wait for all outstanding asynchronous data transfers.

Implements lama::_MatrixStorage.

template<typename ValueType >

void lama::SparseAssemblyStorage< ValueType >::writeAt ( std::ostream & stream ) const [virtual]

Override _MatrixStorage::writeAt with more detailed routine.

Reimplemented from lama::_MatrixStorage.

References lama::_MatrixStorage::mDiagonalProperty, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::SparseAssemblyStorage< T >::mNumValues.

template<typename ValueType >

void lama::MatrixStorage< ValueType >::writeToFile	(	const std::string &	fileName,
		const File::FileType	fileType = `File::BINARY`,
		const File::DataType	dataType = `File::INTERNAL`,
		const File::IndexDataType	indexDataTypeIA = `File::INT`,
		const File::IndexDataType	indexDataTypeJA = `File::INT`
	)		const `[virtual, inherited]`

get the number of elements left/right of the diagonal for the given row

Parameters:

[in]	row	global Index of row
[out]	left	maximal distance of non-zero element to diagonal from the left
[out]	right	maximal distance of non-zero element to diagonal from the right

Referenced by lama::SparseMatrix< T >::writeToFile().

template<typename ValueType >

void lama::MatrixStorage< ValueType >::writeToFile	(	const PartitionId	size,
		const PartitionId	rank,
		const std::string &	fileName,
		const File::FileType	fileType = `File::BINARY`,
		const File::DataType	dataType = `File::INTERNAL`,
		const File::IndexDataType	indexDataTypeIA = `File::INT`,
		const File::IndexDataType	indexDataTypeJA = `File::INT`
	)		const `[virtual, inherited]`