TS< T > Class Template Reference

The triplet scheme; a storage scheme for sparse matrices using triplets. More...

#include <TS.hpp>

Inheritance diagram for TS< T >:

Collaboration diagram for TS< T >:

Public Member Functions
	TS ()
	Base constructor. More...
	TS (std::string file, T zero=0)
	Base constructor. More...
	TS (std::vector< Triplet< T > > &input, ULI m, ULI n, T zero=0)
	Base constructor. More...
virtual void	load (std::vector< Triplet< T > > &input, const ULI m, const ULI n, const T zero)
virtual void	getFirstIndexPair (ULI &row, ULI &col)
	Returns the first nonzero index, per reference. More...
virtual void	zxa (const T *x, T *z)
	In-place z=xA calculation algorithm. More...
virtual void	zax (const T *x, T *z)
	In-place z=Ax calculation algorithm. More...
template<size_t k>
void	ZaX (const T *__restrict__ const *__restrict__ const X, T *__restrict__ const *__restrict__ const Z)
template<size_t k>
void	ZXa (const T *__restrict__ const *__restrict__ const X, T *__restrict__ const *__restrict__ const Z)
virtual size_t	bytesUsed ()
	~TS ()
	Base destructor. More...
Public Member Functions inherited from SparseMatrix< T, ULI >
	SparseMatrix ()
	Base constructor. More...
	SparseMatrix (const ULInzs, const ULInr, const ULInc, const T zero)
	Base constructor. More...
virtual	~SparseMatrix ()
	Base deconstructor. More...
void	loadFromFile (const std::string file, const T zero=0)
	Function which loads a matrix from a matrix market file. More...
virtual unsigned long int	m ()
	Queries the number of rows this matrix contains. More...
virtual unsigned long int	n ()
	Queries the number of columns this matrix contains. More...
virtual unsigned long int	nzs ()
	Queries the number of nonzeroes stored in this matrix. More...
virtual T *	mv (const T *x)
	Calculates and returns z=Ax. More...
virtual void	zax (const T *__restrict__ x, T *__restrict__ z)=0
	In-place z=Ax function. More...
virtual void	zxa (const T *__restrict__ x, T *__restrict__ z)=0
	In-place z=xA function. More...
Public Member Functions inherited from Matrix< T >
	Matrix ()
	Base constructor. More...
virtual	~Matrix ()
	Base deconstructor. More...
virtual void	zax (const T *__restrict__ x, T *__restrict__ z, const size_t k, const clockid_t clock_id=0, double *elapsed_time=NULL)
	Wrapper function to call the zax kernel multiple times successively, while timing the duration of the operation. More...
template<size_t k>
void	ZaX (const T *__restrict__ const *__restrict__ const X, T *__restrict__ const *__restrict__ const Z)
	In-place Z=AX function, where A is m x n, Z = m x k, and X is n x k. More...
template<size_t k>
void	ZXa (const T *__restrict__ const *__restrict__ const X, T *__restrict__ const *__restrict__ const Z)
	In-place Z=XA function, where A is m x n, Z = k x n, and X is k x m. More...
virtual void	zxa (const T *__restrict__ x, T *__restrict__ z, const unsigned long int repeat, const clockid_t clock_id=0, double *elapsed_time=NULL)
	Wrapper function to call the zxa kernel multiple times successively, while timing the operation duration. More...

Protected Attributes
ULI *	i
	The row indices of the nonzeros. More...
ULI *	j
	The column indices of the nonzeros. More...
T *	ds
	The values of the nonzeros. More...
Protected Attributes inherited from SparseMatrix< T, ULI >
ULI	nor
	Number of rows. More...
ULI	noc
	Number of columns.
ULI	nnz
	Number of non-zeros. More...

Additional Inherited Members
Public Attributes inherited from SparseMatrix< T, ULI >
T	zero_element
	The element considered to be zero. More...

Detailed Description

template<typename T>
class TS< T >

The triplet scheme; a storage scheme for sparse matrices using triplets.

Constructor & Destructor Documentation

template<typename T>

TS< T >::TS ( )

inline

Base constructor.

template<typename T>

TS< T >::TS ( std::string  file, T  zero = 0  )

inline

Base constructor.

Will read in from Matrix Market file.

See also

SparseMatrix::SparseMatrix( file, zero )

References SparseMatrix< T, ULI >::loadFromFile().

template<typename T>

TS< T >::TS ( std::vector< Triplet< T > > &  input, ULI  m, ULI  n, T  zero = 0  )

inline

Base constructor.

Parameters

input	std::vector of triplets to be stored in this scheme.
m	total number of rows.
n	total number of columns.
zero	what is to be considered the zero element.

References TS< T >::load().

template<typename T>

TS< T >::~TS ( )

inline

Base destructor.

References TS< T >::ds, TS< T >::i, and TS< T >::j.

Member Function Documentation

template<typename T>

virtual size_t TS< T >::bytesUsed ( )

inlinevirtual

See also

Matrix::bytesUsed

Implements Matrix< T >.

References SparseMatrix< T, ULI >::nnz.

template<typename T>

virtual void TS< T >::getFirstIndexPair ( ULI &  row, ULI &  col  )

inlinevirtual

Returns the first nonzero index, per reference.

Implements SparseMatrix< T, ULI >.

References TS< T >::i, and TS< T >::j.

template<typename T>

virtual void TS< T >::load ( std::vector< Triplet< T > > &  input, const ULI  m, const ULI  n, const T  zero  )

inlinevirtual

See also

SparseMatrix::load

Implements SparseMatrix< T, ULI >.

References TS< T >::ds, TS< T >::i, TS< T >::j, SparseMatrix< T, ULI >::m(), SparseMatrix< T, ULI >::n(), SparseMatrix< T, ULI >::nnz, SparseMatrix< T, ULI >::noc, SparseMatrix< T, ULI >::nor, and SparseMatrix< T, ULI >::zero_element.

Referenced by TS< T >::TS().

template<typename T>

virtual void TS< T >::zax ( const T *  x, T *  z  )

inlinevirtual

In-place z=Ax calculation algorithm.

Parameters

x	The vector x supplied for calculation of Ax.
z	The result vector z. Should be pre-allocated with entries set to zero.

References TS< T >::ds, TS< T >::i, TS< T >::j, SparseMatrix< T, ULI >::nnz, SparseMatrix< T, ULI >::noc, and SparseMatrix< T, ULI >::nor.

template<typename T>

template<size_t k>

void TS< T >::ZaX ( const T *__restrict__ const *__restrict__ const  X, T *__restrict__ const *__restrict__ const  Z  )

inline

See also

Matrix::ZaX

References TS< T >::ds, TS< T >::i, TS< T >::j, SparseMatrix< T, ULI >::nnz, SparseMatrix< T, ULI >::noc, and SparseMatrix< T, ULI >::nor.

template<typename T>

virtual void TS< T >::zxa ( const T *  x, T *  z  )

inlinevirtual

In-place z=xA calculation algorithm.

Parameters

x	The vector x supplied for calculation of xA.
z	The result vector z. Should be pre-allocated with entries set to zero.

References TS< T >::ds, TS< T >::i, TS< T >::j, SparseMatrix< T, ULI >::nnz, SparseMatrix< T, ULI >::noc, and SparseMatrix< T, ULI >::nor.

template<typename T>

template<size_t k>

void TS< T >::ZXa ( const T *__restrict__ const *__restrict__ const  X, T *__restrict__ const *__restrict__ const  Z  )

inline

See also

Matrix::ZXa

References TS< T >::ds, TS< T >::i, TS< T >::j, SparseMatrix< T, ULI >::nnz, SparseMatrix< T, ULI >::noc, and SparseMatrix< T, ULI >::nor.

Member Data Documentation

template<typename T>

T* TS< T >::ds

protected

The values of the nonzeros.

Referenced by TS< T >::load(), TS< T >::zax(), TS< T >::ZaX(), TS< T >::zxa(), TS< T >::ZXa(), and TS< T >::~TS().

template<typename T>

ULI* TS< T >::i

protected

The row indices of the nonzeros.

Referenced by TS< T >::getFirstIndexPair(), TS< T >::load(), TS< T >::zax(), TS< T >::ZaX(), TS< T >::zxa(), TS< T >::ZXa(), and TS< T >::~TS().

template<typename T>

ULI* TS< T >::j

protected

The column indices of the nonzeros.

Referenced by TS< T >::getFirstIndexPair(), TS< T >::load(), TS< T >::zax(), TS< T >::ZaX(), TS< T >::zxa(), TS< T >::ZXa(), and TS< T >::~TS().

---

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

• TS.hpp