Defines operations common to all matrices, which are implemented in this library. More...

#include <Matrix.hpp>

Inheritance diagram for Matrix< T >:

Public Member Functions
	Matrix ()
	Base constructor. More...

virtual	~Matrix ()
	Base deconstructor. More...

virtual unsigned long int	m ()=0

virtual unsigned long int	n ()=0

virtual unsigned long int	nzs ()

virtual T *	mv (const T *x)=0
	Calculates z=Ax (where A is this matrix). More...

virtual void	zax (const T __restrict__ x, T __restrict__ z)=0
	In-place z=Ax function. 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...

virtual void	zxa (const T __restrict__ x, T __restrict__ z)=0
	In-place z=xA function. 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...

virtual size_t	bytesUsed ()=0
	Function to query the amount of storage required by this sparse matrix. More...

Detailed Description

template<typename T>
class Matrix< T >

Defines operations common to all matrices, which are implemented in this library.

Constructor & Destructor Documentation

template<typename T>

Matrix< T >::Matrix ( )

inline

Base constructor.

template<typename T>

virtual Matrix< T >::~Matrix ( )

inlinevirtual

Base deconstructor.

Member Function Documentation

template<typename T>

virtual size_t Matrix< T >::bytesUsed ( )

pure virtual

Function to query the amount of storage required by this sparse matrix.

Returns: The size of the sparse matrix in bytes.

Implemented in vecBICRS< T, block_length_row, block_length_column, _i_value >, BetaHilbert< T >, RDBHilbert< T, MatrixType >, CBICRS< _t_value, _master_i_value, _master_j_value, _i_value, _j_value >, FBICRS< _t_value, _i_value, _sub_ds, logBeta >, RDScheme< T, DS >, BlockHilbert< T >, ICRS< T, _i_value >, HBICRS< _t_value >, HBICRS< T >, ZZ_ICRS< T >, BICRS< _t_value, _i_value >, CRS< T >, McCRS< T >, SVM< T >, DD_MATRIX< T, number_of_diagonals, diagonal_offsets >, ZZ_CRS< T, _i_value >, HTS< T >, CompressedHilbert< T >, TS< T >, Hilbert< T >, CuHyb, and CCSWrapper< T, SparseMatrixType, IND >.

template<typename T>

virtual unsigned long int Matrix< T >::m ( )

pure virtual

Returns: The number of rows.

Implemented in CCSWrapper< T, SparseMatrixType, IND >, SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, and SparseMatrix< double, size_t >.

Referenced by Matrix< _t_value >::nzs().

template<typename T>

virtual T* Matrix< T >::mv ( const T * x )

pure virtual

Calculates z=Ax (where A is this matrix).

Parameters

x	The input vector.

Returns: The output vector z.

See also: Matrix::zax.

Implemented in BetaHilbert< T >, RDBHilbert< T, MatrixType >, RDScheme< T, DS >, RDCSB< T >, McCRS< T >, MKLCRS< T >, SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, SparseMatrix< double, size_t >, and CCSWrapper< T, SparseMatrixType, IND >.

template<typename T>

virtual unsigned long int Matrix< T >::n ( )

pure virtual

Returns: The number of columns.

Implemented in SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, SparseMatrix< double, size_t >, and CCSWrapper< T, SparseMatrixType, IND >.

Referenced by Matrix< _t_value >::nzs().

template<typename T>

virtual unsigned long int Matrix< T >::nzs ( )

inlinevirtual

Returns: The number of nonzeros.

Reimplemented in SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, SparseMatrix< double, size_t >, and CCSWrapper< T, SparseMatrixType, IND >.

template<typename T>

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

pure virtual

In-place z=Ax function.

Parameters

x	The x vector to multiply current matrix with.
z	The result vector. Must be pre-allocated and its elements should be initialised to zero.

Implemented in vecBICRS< T, block_length_row, block_length_column, _i_value >, FBICRS< _t_value, _i_value, _sub_ds, logBeta >, CBICRS< _t_value, _master_i_value, _master_j_value, _i_value, _j_value >, HBICRS< _t_value >, HBICRS< T >, ICRS< T, _i_value >, ZZ_ICRS< T >, McCRS< T >, BICRS< _t_value, _i_value >, SVM< T >, CRS< T >, MKLCRS< T >, SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, SparseMatrix< double, size_t >, CCSWrapper< T, SparseMatrixType, IND >, and CuHyb.

Referenced by Matrix< _t_value >::zax(), and Matrix< _t_value >::ZaX().

template<typename T>

virtual void Matrix< T >::zax	(	const T *__restrict__	x,
		T *__restrict__	z,
		const size_t	k,
		const clockid_t	clock_id = `0`,
		double *	elapsed_time = `NULL`
	)

inlinevirtual

Wrapper function to call the zax kernel multiple times successively, while timing the duration of the operation.

Essentially computes z=A^k. The timing functionalities are optional.

Parameters

x	The input vector.
z	The output vector.
k	How many times to repeat the z=Ax operation.
clock_id	The POSIX realtime clock ID (optional).
elapsed_time	To which double the time taken should be added (optional; set to NULL to disable timing).

See also: Matrix::zax

template<typename T>

template<size_t k>

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

inline

In-place Z=AX function, where A is m x n, Z = m x k, and X is n x k.

The default implementation is to perform k successive z=Ax operations. Efficient schemes should override this default implementation to achieve higher performance.

Template Parameters

k	How many linear maps to compute. This is a template parameter so that the compiler can optimise better.

Parameters

X	The k input vectors of length n each.
Z	The k output vectors of length m each; each is assumed to be pre-initialised.

See also: Matrix::zax

template<typename T>

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

pure virtual

In-place z=xA function.

Parameters

x	The input vector to left-multiply to the current matrix.
z	The output vector. Must be pre-allocated and initialised to zero for correct results.

Implemented in vecBICRS< T, block_length_row, block_length_column, _i_value >, CBICRS< _t_value, _master_i_value, _master_j_value, _i_value, _j_value >, FBICRS< _t_value, _i_value, _sub_ds, logBeta >, ICRS< T, _i_value >, HBICRS< _t_value >, HBICRS< T >, McCRS< T >, ZZ_ICRS< T >, SVM< T >, CRS< T >, BICRS< _t_value, _i_value >, MKLCRS< T >, SparseMatrix< T, IND >, SparseMatrix< _t_value, ULI >, SparseMatrix< _t_value, LI >, SparseMatrix< _t_value, _i_value >, SparseMatrix< T, LI >, SparseMatrix< T, unsigned long int >, SparseMatrix< T, ULI >, SparseMatrix< double, size_t >, CCSWrapper< T, SparseMatrixType, IND >, and CuHyb.

Referenced by Matrix< _t_value >::ZXa(), and Matrix< _t_value >::zxa().

template<typename T>

template<size_t k>

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

inline

In-place Z=XA function, where A is m x n, Z = k x n, and X is k x m.

Transposed variant of Matrix::ZaX, analogue to Matrix::zxa being the transposed operation of Matrix::zax.

Template Parameters

k	How many linear maps to compute. This is a template parameter so that the compiler can optimise better.

Parameters

X	The k input vectors of length m each.
Z	The k output vectors of length n each.

See also: Matrix::ZaX; Matrix::zxa

template<typename T>

virtual void Matrix< T >::zxa	(	const T *__restrict__	x,
		T *__restrict__	z,
		const unsigned long int	repeat,
		const clockid_t	clock_id = `0`,
		double *	elapsed_time = `NULL`
	)

inlinevirtual

Wrapper function to call the zxa kernel multiple times successively, while timing the operation duration.

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

Matrix.hpp

Public Member Functions

Detailed Description

template<typename T> class Matrix< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class Matrix< T >