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

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...
 
constElementgetEntry (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...
 
ElementrefEntry (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 >
VectorapplyTranspose (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 ( )
inline

Constructors.

Todo:
convert from other matrix.
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 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

Constructors.

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

Default converter.

Parameters
Sa sparse matrix in any storage.
~SparseMatrix ( )
inline

Constructors.

Todo:
convert from other matrix.

Member Function Documentation

void resize ( const size_t &  mm,
const size_t &  nn,
const size_t &  zz 
)
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 CSR format to HYB.

Parameters
SHYB matrix to be converted in HYB and optimsed
void optimise ( )
inline
Todo:
±1 !
void importe ( const SparseMatrix< _Field, SparseMatrixFormat::HYB > &  A)
inline

Import a matrix in CSR format to CSR.

Parameters
SCSR 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...

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 ?
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
iRow _colid of entry
jColumn _colid of entry
Returns
Reference to matrix entry
std::ostream& write ( std::ostream &  os,
Format  = SparseFileFormat::CSR() 
) 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 &  file,
Format  fmt = SparseFileFormat::CSR() 
)
inline

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

Parameters
fileInput stream from which to read the matrix
formatFormat of input matrix
Returns
ref to file.
Vector& applyTranspose ( Vector y,
const Vector x,
const Element a 
) const
inline
Bug:
if too big, create transpose.
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: