Sparse matrix, Coordinate storage. More...

#include <sparse-hyb-matrix.h>

Public Types
typedef _Field	Field
	Field.

typedef _Field::Element	Element
	Element.

typedef const Element	constElement
	const Element

typedef SparseMatrixFormat::HYB	Storage
	Matrix Storage Format.

typedef SparseMatrix< _Field, Storage >	Self_t
	Self type.

Public Member Functions
void	transposeIn ()
	In place transpose. More...

SparseMatrix< _Field, SparseMatrixFormat::HYB > &	transpose (SparseMatrix< _Field, SparseMatrixFormat::HYB > &S)
	Transpose the matrix. More...

size_t	rowdim () const
	number of rows. More...

size_t	coldim () const
	number of columns. More...

size_t	size () const
	Number of non zero elements in the matrix. More...

constElement &	getEntry (const size_t &i, const size_t &j) const
	Get a read-only individual entry from the matrix. More...

void	setEntry (const size_t &i, const size_t &j, const Element &e)
	Set an individual entry. More...

Element &	refEntry (const size_t &i, const size_t &j)
	Get a writeable reference to an entry in the matrix. More...

template<class Format >
std::ostream &	write (std::ostream &os, Format=SparseFileFormat::CSR()) const
	Write a matrix to the given output stream using field read/write. More...

template<class Format >
std::istream &	read (std::istream &file, Format fmt=SparseFileFormat::CSR())
	Read a matrix from the given input stream using field read/write. More...

template<class Vector >
Vector &	applyTranspose (Vector &y, const Vector &x, const Element &a) const

bool	consistent () const


	SparseMatrix ()
	Constructors. More...

	SparseMatrix (const _Field &F)
	Constructors. More...

	SparseMatrix (const _Field &F, size_t m, size_t n)
	Constructors. More...

	SparseMatrix (const SparseMatrix< _Field, SparseMatrixFormat::CSR > &S)
	Constructors. More...

template<typename _Tp1 , typename _Rw1 >
	SparseMatrix (const SparseMatrix< _Tp1, _Rw1 > &S, const Field &F)
	Constructors. More...

template<class VectStream >
	SparseMatrix (const _Field &F, VectStream &stream)
	Constructors. More...

void	resize (const size_t &mm, const size_t &nn, const size_t &zz)
	Constructors. More...

template<class _OtherStorage >
	SparseMatrix (const SparseMatrix< _Field, _OtherStorage > &S)
	Default converter. More...

	~SparseMatrix ()
	Constructors. More...


void	importe (const SparseMatrix< _Field, SparseMatrixFormat::CSR > &S)
	Conversions. More...

void	optimise ()

void	importe (const SparseMatrix< _Field, SparseMatrixFormat::HYB > &A)
	Import a matrix in CSR format to CSR. More...

SparseMatrix< _Field, SparseMatrixFormat::HYB > &	exporte (SparseMatrix< _Field, SparseMatrixFormat::HYB > &S) const
	Export a matrix in CSR format from COO. More...

Detailed Description

template<class _Field>
class LinBox::SparseMatrix< _Field, SparseMatrixFormat::HYB >

Sparse matrix, Coordinate storage.

Constructor & Destructor Documentation

§ SparseMatrix() [1/7]

SparseMatrix ( )

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [2/7]

SparseMatrix ( const _Field & F )

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [3/7]

SparseMatrix	(	const _Field &	F,
		size_t	m,
		size_t	n
	)

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [4/7]

SparseMatrix ( const SparseMatrix< _Field, SparseMatrixFormat::CSR > & S )

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [5/7]

SparseMatrix	(	const SparseMatrix< _Tp1, _Rw1 > &	S,
		const Field &	F
	)

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [6/7]

SparseMatrix	(	const _Field &	F,
		VectStream &	stream
	)

inline

Constructors.

Todo:: convert from other matrix.

§ SparseMatrix() [7/7]

SparseMatrix ( const SparseMatrix< _Field, _OtherStorage > & S )

inline

Default converter.

Parameters

S	a sparse matrix in any storage.

§ ~SparseMatrix()

~SparseMatrix ( )

inline

Constructors.

Todo:: convert from other matrix.

Member Function Documentation

§ resize()

void resize	(	const size_t &	mm,
		const size_t &	nn,
		const size_t &	zz
	)

inline

Constructors.

Todo:: convert from other matrix.

§ importe() [1/2]

void importe ( const SparseMatrix< _Field, SparseMatrixFormat::CSR > & S )

inline

Conversions.

Any sparse matrix has a converter to/from CSR. A specialisation can skip the temporary CSR matrix created.

Import a matrix in CSR format to HYB.

Parameters

S	HYB matrix to be converted in HYB and optimsed

§ optimise()

void optimise ( )

inline

Todo:: ±1 !

§ importe() [2/2]

void importe ( const SparseMatrix< _Field, SparseMatrixFormat::HYB > & A )

inline

Import a matrix in CSR format to CSR.

Parameters

S	CSR matrix to be converted in CSR

§ exporte()

SparseMatrix<_Field,SparseMatrixFormat::HYB >& exporte ( SparseMatrix< _Field, SparseMatrixFormat::HYB > & S ) const

inline

Export a matrix in CSR format from COO.

Parameters

S	CSR matrix to be converted from COO

§ transposeIn()

void transposeIn ( )

inline

In place transpose.

Not quite...

§ transpose()

SparseMatrix<_Field,SparseMatrixFormat::HYB>& transpose ( SparseMatrix< _Field, SparseMatrixFormat::HYB > & S )

inline

Transpose the matrix.

Parameters

S	[out] transpose of self.

Returns: a reference to S.

§ rowdim()

size_t rowdim ( ) const

inline

number of rows.

Returns: row dimension.

§ coldim()

size_t coldim ( ) const

inline

number of columns.

Returns: column dimension

§ size()

size_t size ( ) const

inline

Number of non zero elements in the matrix.

or at least the size of the _data if

Returns: size of the _data.

§ getEntry()

constElement& getEntry	(	const size_t &	i,
		const size_t &	j
	)		const

inline

Get a read-only individual entry from the matrix.

Parameters

i	Row _colid
j	Column _colid

Returns: Const reference to matrix entry

§ setEntry()

void setEntry	(	const size_t &	i,
		const size_t &	j,
		const Element &	e
	)

inline

Set an individual entry.

Setting the entry to 0 will not remove it from the matrix

Parameters

i	Row _colid of entry
j	Column _colid of entry
value	Value of the new entry

Todo:: make it faster if i is 0 or m-1 ?

§ refEntry()

Element& refEntry	(	const size_t &	i,
		const size_t &	j
	)

inline

Get a writeable reference to an entry in the matrix.

If there is no entry at the position (i, j), then a new entry with a value of zero is inserted and a reference to it is returned.

Parameters

i	Row _colid of entry
j	Column _colid of entry

Returns: Reference to matrix entry

§ write()

std::ostream& write	(	std::ostream &	os,
		Format	= `SparseFileFormat::CSR()`
	)		const

inline

Write a matrix to the given output stream using field read/write.

Parameters

os	Output stream to which to write the matrix
format	Format with which to write

§ read()

std::istream& read	(	std::istream &	file,
		Format	fmt = `SparseFileFormat::CSR()`
	)

inline

Read a matrix from the given input stream using field read/write.

Parameters

file	Input stream from which to read the matrix
format	Format of input matrix

Returns: ref to file.

§ applyTranspose()

Vector& applyTranspose	(	Vector &	y,
		const Vector &	x,
		const Element &	a
	)		const

inline

Bug:: if too big, create transpose.

§ consistent()

bool consistent ( ) const

inline

Todo:: Non element marker.

We could end up a line with a marker. A field F would contain an element that does not belong to it. eg a nan for a Givaro::Modular<double>. It could act as a marker.

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

sparse-hyb-matrix.h

Public Types

Public Member Functions

Detailed Description

template<class _Field> class LinBox::SparseMatrix< _Field, SparseMatrixFormat::HYB >

Constructor & Destructor Documentation

§ SparseMatrix() [1/7]

§ SparseMatrix() [2/7]

§ SparseMatrix() [3/7]

§ SparseMatrix() [4/7]

§ SparseMatrix() [5/7]

§ SparseMatrix() [6/7]

§ SparseMatrix() [7/7]

§ ~SparseMatrix()

Member Function Documentation

§ resize()

§ importe() [1/2]

§ optimise()

§ importe() [2/2]

§ exporte()

§ transposeIn()

§ transpose()

§ rowdim()

§ coldim()

§ size()

§ getEntry()

§ setEntry()

§ refEntry()

§ write()

§ read()

§ applyTranspose()

§ consistent()

template<class _Field>
class LinBox::SparseMatrix< _Field, SparseMatrixFormat::HYB >