Storage format for a JDS sparse matrix. More...

#include <JDSStorage.hpp>

Inheritance diagram for lama::JDSStorage< T >:

Public Types
typedef T	ValueType
	This is the type of the matrix values.
Public Member Functions
	JDSStorage (const IndexType numRows, const IndexType numColumns)
	Creates a sparse matrix with all values set to zero.
	JDSStorage (const IndexType numRows, const IndexType numColumns, const IndexType numValues, const IndexType numDiagonals, const LAMAArray< IndexType > &dlg, const LAMAArray< IndexType > &ilg, const LAMAArray< IndexType > &perm, const LAMAArray< IndexType > &ja, const LAMAArray< ValueType > &values)
	Constructor for JDS storage by corresponding arrays.
	JDSStorage ()
	Default constructor, same as JDSStorage(0, 0).
	JDSStorage (const JDSStorage< ValueType > &other)
	Default copy constructor is overridden.
	JDSStorage (const _MatrixStorage &other)
	Copy constructor that handles also type and format conversion.
	JDSStorage (const _MatrixStorage &other, const ContextPtr context)
	Copy constructor can take any matrix storage or context.
JDSStorage< ValueType > &	operator= (const JDSStorage< ValueType > &other)
	Default assignment operator is overridden.
JDSStorage< ValueType > &	operator= (const _MatrixStorage &other)
	Assignment operator with same semantic as assign.
virtual JDSStorage *	copy () const
	Implementation of MatrixStorage::copy for derived class.
virtual JDSStorage *	create () const
	Implementation of MatrixStorage::create for derived class.
virtual void	clear ()
	Implementation of pure method for _MatrixStorage.
virtual	~JDSStorage ()
	Destructor of JDS sparse matrix.
void	check (const char *msg) const
	Test the storage data for inconsistencies.
void	allocate (const IndexType numRows, const IndexType numColumns)
	Allocate arrays ilg and perm.
virtual MatrixStorageFormat	getFormat () const
	Getter routine for the enum value that stands for this format.
virtual void	purge ()
	Implementation of pure method of class MatrixStorage.
virtual void	setIdentity (const IndexType size)
	Implementation of pure method for JDS matrix.
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)
	Template version with given value type.
virtual void	matrixTimesVector (LAMAArrayView< ValueType > result, const ValueType alpha, const LAMAArrayConstView< ValueType > x, const ValueType beta, const LAMAArrayConstView< ValueType > y) const
	Implementation of MatrixStorage::matrixTimesVector for JDS.
virtual void	jacobiIterate (LAMAArrayView< ValueType > solution, const LAMAArrayConstView< ValueType > oldSolution, const LAMAArrayConstView< ValueType > rhs, const ValueType omega) const
	Implementation of MatrixStorage::jacobiIterate for JDS.
virtual void	jacobiIterateHalo (LAMAArrayView< ValueType > localSolution, const MatrixStorage< ValueType > &localStorage, const LAMAArrayConstView< ValueType > haloOldSolution, const ValueType omega) const
	Implementation of MatrixStorage::jacobiIterateHalo for JDS.
virtual void	writeAt (std::ostream &stream) const
	Print relevant information about matrix storage format.
const LAMAArray< IndexType > &	getJA () const
const LAMAArray< IndexType > &	getPerm () const
const LAMAArray< IndexType > &	getDlg () const
const LAMAArray< IndexType > &	getIlg () const
const LAMAArray< ValueType > &	getValues () const
IndexType	getNumDiagonals () const
virtual IndexType	getNumValues () const
	Override _MatrixStorage::getNumValues with a more efficient routine for JDS.
template<typename OtherType >
void	getRowImpl (LAMAArray< OtherType > &row, const IndexType i) const
	Template method for getting row.
template<typename OtherType >
void	getDiagonalImpl (LAMAArray< OtherType > &diagonal) const
	This method returns the diagonal.
template<typename OtherType >
void	setDiagonalImpl (const LAMAArray< OtherType > &diagonal)
	This method replaces the diagonal.
void	setDiagonalImpl (const Scalar)
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.
ValueType	getValue (IndexType i, IndexType j) const
	Get a value of the matrix.
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.
void	swap (JDSStorage< ValueType > &other)
	Swaps this with other.
virtual size_t	getMemoryUsageImpl () const
	Returns the number of bytes needed for the current matrix.
template<typename OtherValueType >
void	setDiagonalImpl (const LAMAArray< OtherValueType > &diagonal)
template<typename OtherValueType >
void	getRowImpl (LAMAArray< OtherValueType > &row, const IndexType i) const
template<typename OtherValueType >
void	getDiagonalImpl (LAMAArray< OtherValueType > &diagonal) const
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	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 std::auto_ptr< SyncToken >	jacobiIterateAsync (LAMAArrayView< ValueType > solution, const LAMAArrayConstView< ValueType > oldSolution, const LAMAArrayConstView< ValueType > rhs, const ValueType omega) const
	Asynchrounous version of jacobiIterate.
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
IndexType	mNumDiagonals
	number of jagged diagonals (equals length of the longest row)
IndexType	mNumValues
	number of non-zero values (+ optionally zeros in diagonal)
LAMAArray< IndexType >	mDlg
	number of values in each column, size is mNumDiagonals
LAMAArray< IndexType >	mIlg
	number of values in each row, size is mNumRows
LAMAArray< IndexType >	mPerm
	position of each row in original matrix, size is mNumRows
LAMAArray< IndexType >	mJa
	column indices, size is mNumValues
LAMAArray< ValueType >	mValues
	non-zero values (+ optionally zeros in diagonal), size is mNumValues
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	assignJDS (const JDSStorage< ValueType > &other)
	Assigment with same storage type.
virtual bool	checkDiagonalProperty () const
	Mandatory routine to check storage data for the diagonal property.
void	sortRows (ContextPtr loc)
	Help routine for stable sort of ilg and setting up perm correctly.
void	setupData (ContextPtr loc)
	Help routine that sets up mDlg and allocates mJa and mValues after mIlg defined.
void	print () const
	Copy JDS storage but remove all entries where column index is equal nIndex.
	LAMA_LOG_DECL_STATIC_LOGGER (logger)
	logger for this matrix format

Detailed Description

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

Storage format for a JDS sparse matrix.

The JDS format has the following data:

number of jagged diagonals (equal to the length of the longest row)
number of values in each column
number of values in each row
original positions of the permuted rows
values-array

Template Parameters:

T	is the value type for the matrix elements.

Note: default copy constructor and assignment operator can be used.

Member Typedef Documentation

template<typename T>

typedef T lama::JDSStorage< T >::ValueType

This is the type of the matrix values.

Reimplemented from lama::MatrixStorage< T >.

Constructor & Destructor Documentation

template<typename ValueType >

lama::JDSStorage< ValueType >::JDSStorage	(	const IndexType	numRows,
		const IndexType	numColumns
	)

Creates a sparse matrix with all values set to zero.

Parameters:

[in]	numRows	the number of rows of the matrix
[in]	numColumns	the number of columns of the matrix

References lama::WriteAccess< T >::get(), lama::_MatrixStorage::getContextPtr(), LAMA_INTERFACE_FN_T, lama::JDSStorage< T >::mIlg, lama::_MatrixStorage::mNumColumns, lama::_MatrixStorage::mNumRows, and lama::JDSStorage< T >::mPerm.

template<typename ValueType >

lama::JDSStorage< ValueType >::JDSStorage	(	const IndexType	numRows,
		const IndexType	numColumns,
		const IndexType	numValues,
		const IndexType	numDiagonals,
		const LAMAArray< IndexType > &	dlg,
		const LAMAArray< IndexType > &	ilg,
		const LAMAArray< IndexType > &	perm,
		const LAMAArray< IndexType > &	ja,
		const LAMAArray< ValueType > &	values
	)

Constructor for JDS storage by corresponding arrays.

References lama::JDSStorage< T >::check(), and lama::_MatrixStorage::resetDiagonalProperty().

template<typename ValueType >

lama::JDSStorage< ValueType >::JDSStorage ( )

Default constructor, same as JDSStorage(0, 0).

template<typename ValueType >

lama::JDSStorage< ValueType >::JDSStorage ( const JDSStorage< ValueType > & other )

Default copy constructor is overridden.

References lama::JDSStorage< T >::assignJDS().

template<typename ValueType >

lama::JDSStorage< ValueType >::JDSStorage ( const _MatrixStorage & other ) [explicit]

Copy constructor that handles also type and format conversion.

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

template<typename T>

lama::JDSStorage< T >::JDSStorage	(	const _MatrixStorage &	other,
		const ContextPtr	context
	)

Copy constructor can take any matrix storage or context.

template<typename ValueType >

lama::JDSStorage< ValueType >::~JDSStorage ( ) [virtual]

Destructor of JDS sparse matrix.

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::JDSStorage< ValueType >::allocate	(	const IndexType	numRows,
		const IndexType	numColumns
	)		`[virtual]`

Allocate arrays ilg and perm.

Implements lama::_MatrixStorage.

References lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_T.

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::JDSStorage< ValueType >::assignJDS ( const JDSStorage< ValueType > & other ) [private]

Assigment with same storage type.

References lama::_MatrixStorage::_assign(), lama::JDSStorage< T >::mDlg, lama::JDSStorage< T >::mIlg, lama::JDSStorage< T >::mJa, lama::JDSStorage< T >::mNumDiagonals, lama::JDSStorage< T >::mNumValues, lama::JDSStorage< T >::mPerm, and lama::JDSStorage< T >::mValues.

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

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::JDSStorage< ValueType >::buildCSR	(	LAMAArray< IndexType > &	ia,
		LAMAArray< IndexType > *	ja,
		LAMAArray< OtherValueType > *	values,
		const ContextPtr	loc
	)		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::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_DEBUG, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN, LAMA_INTERFACE_FN_TT, and lama::WriteAccess< T >::resize().

void lama::CRTPMatrixStorage< JDSStorage< 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< JDSStorage< 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::JDSStorage< ValueType >::check ( const char * msg ) const [virtual]

Test the storage data for inconsistencies.

Exception in case of any inconsistency.

Implements lama::_MatrixStorage.

References lama::ReadAccess< T >::get(), LAMA_ASSERT_EQUAL_ERROR, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN, and LAMA_THROWEXCEPTION.

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

template<typename ValueType >

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

Mandatory routine to check storage data for the diagonal property.

Implements lama::_MatrixStorage.

References lama::ReadAccess< T >::get(), LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN.

template<typename ValueType >

void lama::JDSStorage< 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 ValueType >

JDSStorage< ValueType > * lama::JDSStorage< ValueType >::copy ( ) const [virtual]

Implementation of MatrixStorage::copy for derived class.

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 ValueType >

JDSStorage< ValueType > * lama::JDSStorage< ValueType >::create ( ) const [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().

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< JDSStorage< 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 T>

template<typename OtherType >

void lama::JDSStorage< T >::getDiagonalImpl ( LAMAArray< OtherType > & diagonal ) const

This method returns the diagonal.

Parameters:

[in] diagonal is the destination array

Calculations are dependent to the diagonal property

template<typename T>

template<typename OtherValueType >

void lama::JDSStorage< T >::getDiagonalImpl ( LAMAArray< OtherValueType > & diagonal ) const

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_TT, and lama::min().

template<typename ValueType >

const LAMAArray< IndexType > & lama::JDSStorage< ValueType >::getDlg ( ) const

template<typename ValueType >

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

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

Implements lama::_MatrixStorage.

References lama::JDS.

template<typename ValueType >

const LAMAArray< IndexType > & lama::JDSStorage< ValueType >::getIlg ( ) const

template<typename ValueType >

const LAMAArray< IndexType > & lama::JDSStorage< ValueType >::getJA ( ) const

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::JDSStorage< ValueType >::getMemoryUsageImpl ( ) const [virtual]

Returns the number of bytes needed for the current matrix.

This pure function must be implemented by each derived class. Relevant for the number of bytes is the current size of the used (LAMA) arrays.

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.

Implements lama::_MatrixStorage.

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

References lama::_MatrixStorage::mNumColumns.

template<typename ValueType >

IndexType lama::JDSStorage< ValueType >::getNumDiagonals ( ) const

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::DIASparseMatrix< T >::swapLocalStorage(), lama::CSRSparseMatrix< T >::swapLocalStorage(), lama::ELLSparseMatrix< T >::swapLocalStorage(), lama::COOSparseMatrix< T >::swapLocalStorage(), and lama::JDSSparseMatrix< T >::swapLocalStorage().

template<typename ValueType >

IndexType lama::JDSStorage< ValueType >::getNumValues ( ) const [virtual]

Override _MatrixStorage::getNumValues with a more efficient routine for JDS.

Reimplemented from lama::_MatrixStorage.

template<typename ValueType >

const LAMAArray< IndexType > & lama::JDSStorage< ValueType >::getPerm ( ) const

void lama::CRTPMatrixStorage< JDSStorage< 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 T>

template<typename OtherType >

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

Template method for getting row.

template<typename T>

template<typename OtherValueType >

void lama::JDSStorage< T >::getRowImpl	(	LAMAArray< OtherValueType > &	row,
		const IndexType	i
	)		const

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_DEBUG, LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_TT.

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

References lama::_MatrixStorage::mRowIndexes.

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

Implementation of MatrixStorage::getTypeName for derived class.

Implements lama::_MatrixStorage.

template<typename ValueType >

ValueType lama::JDSStorage< ValueType >::getValue	(	IndexType	i,
		IndexType	j
	)		const `[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

Out-of-range check is enabled for DEBUG version.

Implements lama::MatrixStorage< T >.

References lama::ReadAccess< T >::get(), LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_TT.

template<typename ValueType >

const LAMAArray< ValueType > & lama::JDSStorage< ValueType >::getValues ( ) const

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::ELLStorage< T >::setCSRDataImpl(), lama::JDSStorage< 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::JDSStorage< ValueType >::jacobiIterate	(	LAMAArrayView< ValueType >	solution,
		const LAMAArrayConstView< ValueType >	oldSolution,
		const LAMAArrayConstView< ValueType >	rhs,
		const ValueType	omega
	)		const `[virtual]`

Implementation of MatrixStorage::jacobiIterate for JDS.

Reimplemented from lama::MatrixStorage< T >.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_DEBUG, LAMA_ASSERT_ERROR, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_T, LAMA_THROWEXCEPTION, lama::LAMAArrayView< T >::size(), and lama::LAMAArrayConstView< T >::size().

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::JDSStorage< ValueType >::jacobiIterateHalo	(	LAMAArrayView< ValueType >	localSolution,
		const MatrixStorage< ValueType > &	localStorage,
		const LAMAArrayConstView< ValueType >	haloOldSolution,
		const ValueType	omega
	)		const `[virtual]`

Implementation of MatrixStorage::jacobiIterateHalo for JDS.

Reimplemented from lama::MatrixStorage< T >.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), lama::_MatrixStorage::getDiagonal(), lama::_MatrixStorage::getNumColumns(), lama::_MatrixStorage::getNumRows(), lama::_MatrixStorage::hasDiagonalProperty(), LAMA_ASSERT_DEBUG, LAMA_ASSERT_EQUAL_DEBUG, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_T, lama::LAMAArrayView< T >::size(), and lama::LAMAArrayConstView< T >::size().

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::JDSStorage< 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::JDSStorage< ValueType >::matrixTimesVector	(	LAMAArrayView< ValueType >	result,
		const ValueType	alpha,
		const LAMAArrayConstView< ValueType >	x,
		const ValueType	beta,
		const LAMAArrayConstView< ValueType >	y
	)		const `[virtual]`

Implementation of MatrixStorage::matrixTimesVector for JDS.

Reimplemented from lama::MatrixStorage< T >.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_ERROR, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_T, and lama::LAMAArrayConstView< T >::size().

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 ValueType >

JDSStorage< ValueType > & lama::JDSStorage< ValueType >::operator= ( const JDSStorage< ValueType > & other )

Default assignment operator is overridden.

template<typename ValueType >

JDSStorage< ValueType > & lama::JDSStorage< ValueType >::operator= ( const _MatrixStorage & other )

Assignment operator with same semantic as assign.

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::JDSStorage< ValueType >::prefetch ( const ContextPtr location ) const [virtual]

Initiate an asynchronous data transfer to a specified location.

Implements lama::_MatrixStorage.

template<typename ValueType >

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

Copy JDS storage but remove all entries where column index is equal nIndex.

template<typename ValueType >

void lama::JDSStorage< 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< JDSStorage< 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< JDSStorage< 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::JDSStorage< T >::scaleImpl ( const LAMAArray< OtherType > & values )

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

template<typename ValueType >

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

Implementation of pure method.

References lama::WriteAccess< T >::get(), lama::Scalar::getValue(), LAMA_ASSERT_EQUAL_DEBUG, LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_TT.

template<typename T>

template<typename OtherValueType >

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

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_TT.

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< JDSStorage< 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::JDSStorage< 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
	)

Template version with given value type.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), lama::_MatrixStorage::init(), LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN, LAMA_INTERFACE_FN_T, and LAMA_INTERFACE_FN_TT.

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

Implements lama::_MatrixStorage.

void lama::CRTPMatrixStorage< JDSStorage< 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 T>

template<typename OtherValueType >

void lama::JDSStorage< T >::setDiagonalImpl ( const LAMAArray< OtherValueType > & diagonal )

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_TT, and lama::min().

template<typename T>

template<typename OtherType >

void lama::JDSStorage< T >::setDiagonalImpl ( const LAMAArray< OtherType > & diagonal )

This method replaces the diagonal.

Parameters:

[in] diagonal is the source array

Calculations are dependent to the diagonal property

template<typename ValueType >

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

References lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN_T, and lama::min().

template<typename ValueType >

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

Implementation of pure method for JDS matrix.

Implements lama::_MatrixStorage.

References lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, and LAMA_INTERFACE_FN_T.

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 ValueType >

void lama::JDSStorage< ValueType >::setupData ( ContextPtr loc ) [private]

Help routine that sets up mDlg and allocates mJa and mValues after mIlg defined.

References lama::ReadAccess< T >::get(), lama::WriteAccess< T >::get(), LAMA_ASSERT_EQUAL_ERROR, LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN, and LAMA_INTERFACE_FN_T.

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 ValueType >

void lama::JDSStorage< ValueType >::sortRows ( ContextPtr loc ) [private]

Help routine for stable sort of ilg and setting up perm correctly.

References lama::WriteAccess< T >::get(), LAMA_CONTEXT_ACCESS, LAMA_INTERFACE_FN, and LAMA_INTERFACE_FN_T.

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::JDSStorage< ValueType >::swap ( JDSStorage< ValueType > & other )

Swaps this with other.

Parameters:

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

References lama::JDSStorage< T >::mDlg, lama::JDSStorage< T >::mIlg, lama::JDSStorage< T >::mJa, lama::JDSStorage< T >::mNumDiagonals, lama::JDSStorage< T >::mNumValues, lama::JDSStorage< T >::mPerm, lama::JDSStorage< T >::mValues, and lama::MatrixStorage< T >::swap().

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::JDSStorage< T >::typeName ( ) [static]

get typename of the matrix storage format.

template<>

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

template<>

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

template<typename ValueType >

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

Will wait for all outstanding asynchronous data transfers.

Implements lama::_MatrixStorage.

template<typename ValueType >

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

Print relevant information about matrix storage format.

Reimplemented from lama::_MatrixStorage.

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]`