A sparse matrix container (with cells of any type), with iterators.
This class stores only those elements created by assigning them a value, for example: "M(2,3)=8;".
This class doesn't implement math operations since it's a generic sparse container, but it can be used to initialize the contents of a CSparse library-based matrix of type mrpt::math::CSparseMatrix.
Note that reading non-existing cell elements will return the default value (0 for numbers) and that cell will remain non-created in the matrix.
There is an additional method "exists(i,j)" to check whether a given element exists in the matrix.
Definition at line 52 of file CSparseMatrixTemplate.h.
#include <mrpt/math/CSparseMatrixTemplate.h>
Public Types | |
typedef std::map< std::pair < size_t, size_t >, T > | SparseMatrixMap |
Internal map type, used to store the actual matrix. | |
typedef SparseMatrixMap::const_iterator | const_iterator |
Const iterator to move through the matrix. | |
typedef SparseMatrixMap::const_reverse_iterator | const_reverse_iterator |
Const reverse iterator to move through the matrix. | |
Public Member Functions | |
CSparseMatrixTemplate () | |
Basic constructor with no data. | |
CSparseMatrixTemplate (size_t nR, size_t nC) | |
Constructor with default size. | |
T | operator() (size_t r, size_t c) const |
Element access operator. | |
bool | exists (size_t r, size_t c) const |
Element access operator. | |
T & | operator() (size_t r, size_t c) |
Reference access operator. | |
size_t | getRowCount () const |
Returns the amount of rows in this matrix. | |
size_t | getColCount () const |
Returns the amount of columns in this matrix. | |
void | getRow (size_t nRow, std::vector< T > &vec) const |
Extracts a full row from the matrix. | |
void | getColumn (size_t nCol, std::vector< T > &vec) const |
Extracts a full column from the matrix. | |
void | insert (size_t row, size_t column, const T &obj) |
Inserts an element into the matrix. | |
template<class MATRIX_LIKE > | |
void | insertMatrix (size_t row, size_t column, const MATRIX_LIKE &mat) |
Inserts submatrix at a given location. | |
const_iterator | begin () const |
Returns an iterator which points to the starting point of the matrix. | |
const_iterator | end () const |
Returns an iterator which points to the end of the matrix. | |
const_reverse_iterator | rbegin () const |
Returns an iterator which points to the end of the matrix, and can be used to move backwards. | |
const_reverse_iterator | rend () const |
Returns an iterator which points to the starting point of the matrix, although it's the upper limit of the matrix since it's a reverse iterator. | |
void | setRow (size_t nRow, const std::vector< T > &vec, const T &nullObject=T()) |
Inserts a full row into the matrix. | |
void | setColumn (size_t nCol, const std::vector< T > &vec, const T &nullObject=T()) |
Inserts a full column into the matrix. | |
void | resize (size_t nRows, size_t nCols) |
Changes the size of the matrix. | |
CSparseMatrixTemplate< T > | operator() (size_t firstRow, size_t lastRow, size_t firstColumn, size_t lastColumn) const |
Extracts a submatrix form the matrix. | |
void | getAsVector (std::vector< T > &vec) const |
Gets a vector containing all the elements of the matrix, ignoring their position. | |
size_t | getNonNullElements () const |
Gets the amount of non-null elements inside the matrix. | |
bool | empty () const |
Are there no elements set to !=0 ? | |
size_t | getNullElements () const |
Gets the amount of null elements inside the matrix. | |
bool | isNull (size_t nRow, size_t nCol) const |
Checks whether an element of the matrix is the default object. | |
bool | isNotNull (size_t nRow, size_t nCol) const |
Checks whether an element of the matrix is not the default object. | |
void | clear () |
Completely removes all elements, although maintaining the matrix's size. | |
void | purge (T nullObject=T()) |
Checks each non-null elements against the basic objects, erasing unnecesary references to it. | |
Protected Attributes | |
size_t | mRows |
Size of the matrix. | |
size_t | mColumns |
SparseMatrixMap | objectList |
Actual matrix. |
typedef SparseMatrixMap::const_iterator mrpt::math::CSparseMatrixTemplate< T >::const_iterator |
Const iterator to move through the matrix.
Definition at line 63 of file CSparseMatrixTemplate.h.
typedef SparseMatrixMap::const_reverse_iterator mrpt::math::CSparseMatrixTemplate< T >::const_reverse_iterator |
Const reverse iterator to move through the matrix.
Definition at line 68 of file CSparseMatrixTemplate.h.
typedef std::map<std::pair<size_t,size_t>,T> mrpt::math::CSparseMatrixTemplate< T >::SparseMatrixMap |
Internal map type, used to store the actual matrix.
Definition at line 58 of file CSparseMatrixTemplate.h.
mrpt::math::CSparseMatrixTemplate< T >::CSparseMatrixTemplate | ( | ) | [inline] |
Basic constructor with no data.
Size is set to (0,0).
Definition at line 82 of file CSparseMatrixTemplate.h.
mrpt::math::CSparseMatrixTemplate< T >::CSparseMatrixTemplate | ( | size_t | nR, |
size_t | nC | ||
) | [inline] |
Constructor with default size.
Definition at line 86 of file CSparseMatrixTemplate.h.
const_iterator mrpt::math::CSparseMatrixTemplate< T >::begin | ( | ) | const [inline] |
Returns an iterator which points to the starting point of the matrix.
It's a const_iterator, so that the usar isn't able to modify the matrix content into an invalid state.
Definition at line 195 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::CSparseMatrix::CSparseMatrix().
void mrpt::math::CSparseMatrixTemplate< T >::clear | ( | ) | [inline] |
Completely removes all elements, although maintaining the matrix's size.
Definition at line 335 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::intersect().
bool mrpt::math::CSparseMatrixTemplate< T >::empty | ( | ) | const [inline] |
Are there no elements set to !=0 ?
Definition at line 306 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::CSparseMatrix::CSparseMatrix().
const_iterator mrpt::math::CSparseMatrixTemplate< T >::end | ( | ) | const [inline] |
Returns an iterator which points to the end of the matrix.
It's a const_iterator, so that the usar isn't able to modify the matrix content into an invalid state.
Definition at line 202 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::CSparseMatrix::CSparseMatrix().
bool mrpt::math::CSparseMatrixTemplate< T >::exists | ( | size_t | r, |
size_t | c | ||
) | const [inline] |
void mrpt::math::CSparseMatrixTemplate< T >::getAsVector | ( | std::vector< T > & | vec | ) | const [inline] |
Gets a vector containing all the elements of the matrix, ignoring their position.
Definition at line 290 of file CSparseMatrixTemplate.h.
size_t mrpt::math::CSparseMatrixTemplate< T >::getColCount | ( | ) | const [inline] |
Returns the amount of columns in this matrix.
Definition at line 125 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::CSparseMatrix::CSparseMatrix().
void mrpt::math::CSparseMatrixTemplate< T >::getColumn | ( | size_t | nCol, |
std::vector< T > & | vec | ||
) | const [inline] |
Extracts a full column from the matrix.
std::logic_error | on out of range. |
Definition at line 157 of file CSparseMatrixTemplate.h.
size_t mrpt::math::CSparseMatrixTemplate< T >::getNonNullElements | ( | ) | const [inline] |
Gets the amount of non-null elements inside the matrix.
Definition at line 300 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::intersect().
size_t mrpt::math::CSparseMatrixTemplate< T >::getNullElements | ( | ) | const [inline] |
Gets the amount of null elements inside the matrix.
Definition at line 312 of file CSparseMatrixTemplate.h.
void mrpt::math::CSparseMatrixTemplate< T >::getRow | ( | size_t | nRow, |
std::vector< T > & | vec | ||
) | const [inline] |
Extracts a full row from the matrix.
std::logic_error | on out of range. |
Definition at line 133 of file CSparseMatrixTemplate.h.
size_t mrpt::math::CSparseMatrixTemplate< T >::getRowCount | ( | ) | const [inline] |
Returns the amount of rows in this matrix.
Definition at line 118 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::CSparseMatrix::CSparseMatrix().
void mrpt::math::CSparseMatrixTemplate< T >::insert | ( | size_t | row, |
size_t | column, | ||
const T & | obj | ||
) | [inline] |
Inserts an element into the matrix.
Definition at line 177 of file CSparseMatrixTemplate.h.
void mrpt::math::CSparseMatrixTemplate< T >::insertMatrix | ( | size_t | row, |
size_t | column, | ||
const MATRIX_LIKE & | mat | ||
) | [inline] |
Inserts submatrix at a given location.
Definition at line 183 of file CSparseMatrixTemplate.h.
bool mrpt::math::CSparseMatrixTemplate< T >::isNotNull | ( | size_t | nRow, |
size_t | nCol | ||
) | const [inline] |
Checks whether an element of the matrix is not the default object.
Definition at line 328 of file CSparseMatrixTemplate.h.
bool mrpt::math::CSparseMatrixTemplate< T >::isNull | ( | size_t | nRow, |
size_t | nCol | ||
) | const [inline] |
Checks whether an element of the matrix is the default object.
std::logic_error | on out of range |
Definition at line 320 of file CSparseMatrixTemplate.h.
T mrpt::math::CSparseMatrixTemplate< T >::operator() | ( | size_t | r, |
size_t | c | ||
) | const [inline] |
Element access operator.
Doesn't check bounds.
Reimplemented in mrpt::math::CSparseSymmetricalMatrix< T >.
Definition at line 90 of file CSparseMatrixTemplate.h.
CSparseMatrixTemplate<T> mrpt::math::CSparseMatrixTemplate< T >::operator() | ( | size_t | firstRow, |
size_t | lastRow, | ||
size_t | firstColumn, | ||
size_t | lastColumn | ||
) | const [inline] |
Extracts a submatrix form the matrix.
std::logic_error | on invalid bounds. |
Definition at line 275 of file CSparseMatrixTemplate.h.
T& mrpt::math::CSparseMatrixTemplate< T >::operator() | ( | size_t | r, |
size_t | c | ||
) | [inline] |
Reference access operator.
Checks for bounds.
Reimplemented in mrpt::math::CSparseSymmetricalMatrix< T >.
Definition at line 108 of file CSparseMatrixTemplate.h.
void mrpt::math::CSparseMatrixTemplate< T >::purge | ( | T | nullObject = T() | ) | [inline] |
Checks each non-null elements against the basic objects, erasing unnecesary references to it.
Definition at line 341 of file CSparseMatrixTemplate.h.
const_reverse_iterator mrpt::math::CSparseMatrixTemplate< T >::rbegin | ( | ) | const [inline] |
Returns an iterator which points to the end of the matrix, and can be used to move backwards.
It's a const_reverse_iterator, so that the usar isn't able to modify the matrix content into an invalid state.
Definition at line 209 of file CSparseMatrixTemplate.h.
const_reverse_iterator mrpt::math::CSparseMatrixTemplate< T >::rend | ( | ) | const [inline] |
Returns an iterator which points to the starting point of the matrix, although it's the upper limit of the matrix since it's a reverse iterator.
Also, it's a const_reverse_iterator, so that the usar isn't able to modify the matrix content into an invalid state.
Definition at line 216 of file CSparseMatrixTemplate.h.
void mrpt::math::CSparseMatrixTemplate< T >::resize | ( | size_t | nRows, |
size_t | nCols | ||
) | [inline] |
Changes the size of the matrix.
Definition at line 258 of file CSparseMatrixTemplate.h.
Referenced by mrpt::math::intersect().
void mrpt::math::CSparseMatrixTemplate< T >::setColumn | ( | size_t | nCol, |
const std::vector< T > & | vec, | ||
const T & | nullObject = T() |
||
) | [inline] |
Inserts a full column into the matrix.
The third argument is used to specify a null object (which won't be inserted, since the matrix is sparse).
std::logic_error | on out of range or wrong sized vector. |
Definition at line 242 of file CSparseMatrixTemplate.h.
void mrpt::math::CSparseMatrixTemplate< T >::setRow | ( | size_t | nRow, |
const std::vector< T > & | vec, | ||
const T & | nullObject = T() |
||
) | [inline] |
Inserts a full row into the matrix.
The third argument is used to specify a null object (which won't be inserted, since the matrix is sparse).
std::logic_error | on out of range or wrong sized vector. |
Definition at line 224 of file CSparseMatrixTemplate.h.
size_t mrpt::math::CSparseMatrixTemplate< T >::mColumns [protected] |
Definition at line 73 of file CSparseMatrixTemplate.h.
size_t mrpt::math::CSparseMatrixTemplate< T >::mRows [protected] |
Size of the matrix.
Definition at line 73 of file CSparseMatrixTemplate.h.
SparseMatrixMap mrpt::math::CSparseMatrixTemplate< T >::objectList [protected] |
Actual matrix.
Definition at line 77 of file CSparseMatrixTemplate.h.
Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:16:28 UTC 2011 |