SparseMatrix< _Field, SparseMatrixFormat::COO > Class Template Reference

Sparse matrix, Coordinate storage. More...

#include <sparse-coo-matrix.h>

Public Types
typedef _Field	Field
	Field.
typedef _Field::Element	Element
	Element.
typedef const Element	constElement
	const Element
typedef SparseMatrixFormat::COO	Storage
	Matrix Storage Format.
typedef SparseMatrix< _Field, Storage >	Self_t
	Self type.
typedef Vector< Field >::SparseSeq	Row

Public Member Functions
	SparseMatrix (const _Field &F)
	Constructors.
template<class VectStream >
	SparseMatrix (const _Field &F, VectStream &stream)
template<class _OtherStorage >
	SparseMatrix (const SparseMatrix< _Field, _OtherStorage > &S)
	Default converter.
void	importe (const SparseMatrix< _Field, SparseMatrixFormat::CSR > &S)
	Conversions.
SparseMatrix< _Field, SparseMatrixFormat::CSR > &	exporte (SparseMatrix< _Field, SparseMatrixFormat::CSR > &S)
	Export a matrix in CSR format from COO.
void	transposeIn ()
	In place transpose.
Self_t &	transpose (Self_t &S) const
	Transpose the matrix.
size_t	rowdim () const
	number of rows.
size_t	coldim () const
	number of columns.
size_t	size () const
	Number of non zero elements in the matrix.
constElement &	getEntry (const size_t &i, const size_t &j) const
	Get a read-only individual entry from the matrix.
void	finalize ()
	make matrix ready to use after a sequence of setEntry calls.
const Element &	setEntry (const size_t &i, const size_t &j, const Element &e)
	Set an individual entry.
std::ostream &	write (std::ostream &os, Tag::FileFormat format=Tag::FileFormat::MatrixMarket) const
	Write a matrix to the given output stream using field read/write.
std::istream &	read (std::istream &is, Tag::FileFormat format=Tag::FileFormat::Detect)
	Read a matrix from the given input stream using field read/write.
bool	consistent () const

Detailed Description

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

Sparse matrix, Coordinate storage.

Member Typedef Documentation

Row

template<class _Field >

typedef Vector<Field>::SparseSeq Row

Warning

this is not the row type. Just used for streams.

Constructor & Destructor Documentation

SparseMatrix() [1/3]

template<class _Field >

SparseMatrix ( const _Field &  F )

inline

Constructors.

Todo:

convert from other matrix.

SparseMatrix() [2/3]

template<class _Field >

template<class VectStream >

SparseMatrix ( const _Field &  F, VectStream &  stream  )

inline

Bug:

may be 0...

SparseMatrix() [3/3]

template<class _Field >

template<class _OtherStorage >

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

inline

Default converter.

Parameters

S	a sparse matrix in any storage.

Member Function Documentation

importe()

template<class _Field >

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 COO.

Parameters

S	CSR matrix to be converted in COO

exporte()

template<class _Field >

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

inline

Export a matrix in CSR format from COO.

Parameters

S	CSR matrix to be converted from COO

transposeIn()

template<class _Field >

void transposeIn ( )

inline

In place transpose.

Not quite...

transpose()

template<class _Field >

Self_t & transpose ( Self_t &  S ) const

inline

Transpose the matrix.

Parameters

S	[out] transpose of self.

Returns

a reference to S.

rowdim()

template<class _Field >

size_t rowdim ( ) const

inline

number of rows.

Returns

row dimension.

coldim()

template<class _Field >

size_t coldim ( ) const

inline

number of columns.

Returns

column dimension

size()

template<class _Field >

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()

template<class _Field >

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()

template<class _Field >

const Element & 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 ?

Warning

if this is used to build a matrix and this matrix is "well formed", it can be sped up (no checking that the entry already exists).

write()

template<class _Field >

std::ostream & write ( std::ostream &  os, Tag::FileFormat  format = Tag::FileFormat::MatrixMarket  ) 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()

template<class _Field >

std::istream & read ( std::istream &  is, Tag::FileFormat  format = Tag::FileFormat::Detect  )

inline

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

Parameters

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

Returns

ref to is.

consistent()

template<class _Field >

bool consistent ( ) const

inline

Todo:

---

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

• sparse-coo-matrix.h