linbox
Public Types | Public Member Functions | Protected Attributes
SparseMatrix< _Field, SparseMatrixFormat::ELL > Class Template Reference

Sparse matrix, Coordinate storage. More...

#include <sparse-ell-matrix.h>

Public Types

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

Public Member Functions

void transposeIn ()
 In place transpose. More...
 
Self_ttranspose (Self_t &S) const
 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...
 
constElementgetEntry (const size_t &i, const size_t &j) const
 Get a read-only individual entry from the matrix. More...
 
void finalize ()
 make matrix ready to use after a sequence of setEntry calls.
 
void setEntry (const size_t &i, const size_t &j, const Element &e)
 Set an individual entry. More...
 
std::ostream & write (std::ostream &os, LINBOX_enum(Tag::FileFormat) format=Tag::FileFormat::MatrixMarket) const
 Write a matrix to the given output stream using field read/write. More...
 
std::istream & read (std::istream &is, LINBOX_enum(Tag::FileFormat) format=Tag::FileFormat::Detect)
 Read a matrix from the given input stream using field read/write. More...
 
bool consistent () const
 
 SparseMatrix (const _Field &F)
 Constructors. More...
 
 SparseMatrix (const _Field &F, size_t m, size_t n)
 Constructors. More...
 
 SparseMatrix (const _Field &F, size_t m, size_t n, size_t z)
 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)
 
 SparseMatrix (MatrixStream< Field > &ms)
 Constructors. More...
 
void resize (const size_t mm, const size_t nn, const size_t zz=0, const size_t ll=0)
 Constructors. More...
 
template<class _OtherStorage >
 SparseMatrix (const SparseMatrix< _Field, _OtherStorage > &S)
 Default converter. More...
 
void importe (const SparseMatrix< _Field, SparseMatrixFormat::CSR > &S)
 Conversions. More...
 
void importe (const SparseMatrix< _Field, SparseMatrixFormat::ELL > &S)
 Import a matrix in CSR format to CSR. More...
 
template<class _OtherStorage >
void importe (const SparseMatrix< _Field, _OtherStorage > &S)
 Conversions. More...
 
SparseMatrix< _Field,
SparseMatrixFormat::CSR > & 
exporte (SparseMatrix< _Field, SparseMatrixFormat::CSR > &S) const
 Export a matrix in CSR format from COO. More...
 

Protected Attributes

size_t _maxc
 longest row
 
std::vector< size_t > _colid
 _colid is _rownb x _maxc in RowMajor
 
std::vector< Element_data
 _data is _rownb x _maxc in RowMajor
 

Detailed Description

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

Sparse matrix, Coordinate storage.

Member Typedef Documentation

typedef Vector<Field>::SparseSeq Row
Warning
this is not the row type. Just used for streams.

Constructor & Destructor Documentation

SparseMatrix ( const _Field F)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const _Field F,
size_t  m,
size_t  n 
)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const _Field F,
size_t  m,
size_t  n,
size_t  z 
)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const SparseMatrix< _Field, SparseMatrixFormat::CSR > &  S)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const SparseMatrix< _Tp1, _Rw1 > &  S,
const Field F 
)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const _Field F,
VectStream &  stream 
)
inline
SparseMatrix ( MatrixStream< Field > &  ms)
inline

Constructors.

Todo:
convert from other matrix.
SparseMatrix ( const SparseMatrix< _Field, _OtherStorage > &  S)
inline

Default converter.

Parameters
Sa sparse matrix in any storage.

Member Function Documentation

void resize ( const size_t  mm,
const size_t  nn,
const size_t  zz = 0,
const size_t  ll = 0 
)
inline

Constructors.

Todo:
convert from other matrix.
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 COO format to CSR.

Parameters
SCOO matrix to be converted in CSR
void importe ( const SparseMatrix< _Field, SparseMatrixFormat::ELL > &  S)
inline

Import a matrix in CSR format to CSR.

Parameters
SCSR matrix to be converted in CSR
void importe ( const SparseMatrix< _Field, _OtherStorage > &  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 COO format to CSR.

Parameters
SCOO matrix to be converted in CSR

Export a matrix in CSR format from COO.

Parameters
SCSR matrix to be converted from COO
void transposeIn ( )
inline

In place transpose.

Not quite...

Self_t& transpose ( Self_t S) const
inline

Transpose the matrix.

Parameters
S[out] transpose of self.
Returns
a reference to S.
size_t rowdim ( void  ) const
inline

number of rows.

Returns
row dimension.
size_t coldim ( void  ) const
inline

number of columns.

Returns
column dimension
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.
constElement& getEntry ( const size_t &  i,
const size_t &  j 
) const
inline

Get a read-only individual entry from the matrix.

Parameters
iRow _colid
jColumn _colid
Returns
Const reference to matrix entry
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
iRow _colid of entry
jColumn _colid of entry
valueValue 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).
std::ostream& write ( std::ostream &  os,
LINBOX_enum(Tag::FileFormat)  format = Tag::FileFormat::MatrixMarket 
) const
inline

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

Parameters
osOutput stream to which to write the matrix
formatFormat with which to write
std::istream& read ( std::istream &  is,
LINBOX_enum(Tag::FileFormat)  format = Tag::FileFormat::Detect 
)
inline

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

Parameters
isInput stream from which to read the matrix
formatFormat of input matrix
Returns
ref to is.
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: