Main MRPT website > C++ reference
MRPT logo

mrpt::math::CSparseMatrixTemplate< T > Class Template Reference

A sparse matrix container (with cells of any type), with iterators. More...

#include <mrpt/math/CSparseMatrixTemplate.h>

Inheritance diagram for mrpt::math::CSparseMatrixTemplate< T >:
Inheritance graph
[legend]
Collaboration diagram for mrpt::math::CSparseMatrixTemplate< T >:
Collaboration graph
[legend]

List of all members.

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

Detailed Description

template<class T>
class mrpt::math::CSparseMatrixTemplate< T >

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;".

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.

See also:
CSparseSymmetricalMatrix
Note:
Methods marked as "Doesn't check bounds" mean that if an access to an element out of the matrix size is tried, an empty element will be assumed, but this will not raise any invalid memory access.

Definition at line 48 of file CSparseMatrixTemplate.h.

Member Typedef Documentation

template<class T>
typedef SparseMatrixMap::const_iterator mrpt::math::CSparseMatrixTemplate< T >::const_iterator

Const iterator to move through the matrix.

See also:
CSparseMatrixTemplate::const_reverse_iterator

Definition at line 59 of file CSparseMatrixTemplate.h.

template<class T>
typedef SparseMatrixMap::const_reverse_iterator mrpt::math::CSparseMatrixTemplate< T >::const_reverse_iterator

Const reverse iterator to move through the matrix.

See also:
CSparseMatrixTemplate::const_iterator

Definition at line 64 of file CSparseMatrixTemplate.h.

template<class T>
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 54 of file CSparseMatrixTemplate.h.

Constructor & Destructor Documentation

template<class T>
mrpt::math::CSparseMatrixTemplate< T >::CSparseMatrixTemplate (  )  [inline]

Basic constructor with no data.

Size is set to (0,0).

Definition at line 78 of file CSparseMatrixTemplate.h.

template<class T>
mrpt::math::CSparseMatrixTemplate< T >::CSparseMatrixTemplate ( size_t  nR,
size_t  nC 
) [inline]

Constructor with default size.

Definition at line 82 of file CSparseMatrixTemplate.h.

Member Function Documentation

template<class T>
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.

See also:
end,rbegin,rend

Definition at line 181 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::operator()(), and mrpt::math::CSparseMatrixTemplate< T >::purge().

template<class T>
void mrpt::math::CSparseMatrixTemplate< T >::clear (  )  [inline]

Completely removes all elements, although maintaining the matrix's size.

Definition at line 316 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::intersect().

template<class T>
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.

See also:
begin,rbegin,rend

Definition at line 188 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::CSparseSymmetricalMatrix< T >::operator()(), mrpt::math::CSparseMatrixTemplate< T >::operator()(), and mrpt::math::CSparseMatrixTemplate< T >::purge().

template<class T>
bool mrpt::math::CSparseMatrixTemplate< T >::exists ( size_t  r,
size_t  c 
) const [inline]

Element access operator.

Checks bounds.

Definition at line 94 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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 276 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
void mrpt::math::CSparseMatrixTemplate< T >::getColumn ( size_t  nCol,
std::vector< T > &  vec 
) const [inline]

Extracts a full column from the matrix.

See also:
getColumnCount,getRow,setColumn
Exceptions:
std::logic_error on out of range.

Definition at line 153 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::getColumnCount (  )  const [inline]

Returns the amount of columns in this matrix.

See also:
getRowCount

Definition at line 121 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns.

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::getNonNullElements (  )  const [inline]

Gets the amount of non-null elements inside the matrix.

See also:
getNullElements,isNull,isNotNull

Definition at line 286 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::getNullElements(), and mrpt::math::intersect().

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::getNullElements (  )  const [inline]

Gets the amount of null elements inside the matrix.

See also:
getNonNullElements,isNull,isNotNull

Definition at line 293 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::getNonNullElements(), mrpt::math::CSparseMatrixTemplate< T >::mColumns, and mrpt::math::CSparseMatrixTemplate< T >::mRows.

template<class T>
void mrpt::math::CSparseMatrixTemplate< T >::getRow ( size_t  nRow,
std::vector< T > &  vec 
) const [inline]

Extracts a full row from the matrix.

See also:
getRowCount,getColumn,setRow
Exceptions:
std::logic_error on out of range.

Definition at line 129 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::getRowCount (  )  const [inline]

Returns the amount of rows in this matrix.

See also:
getColumnCount,getRow

Definition at line 114 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mRows.

template<class T>
void mrpt::math::CSparseMatrixTemplate< T >::insert ( size_t  row,
size_t  column,
const T &  obj 
) [inline]

Inserts an element into the matrix.

See also:
operator()(size_t,size_t)

Definition at line 173 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::operator()().

template<class T>
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.

See also:
getNonNullElements,getNullElements,isNull

Definition at line 309 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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.

See also:
getNonNullElements,getNullElements,isNotNull
Exceptions:
std::logic_error on out of range

Definition at line 301 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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.

See also:
operator()(size_t,size_t)
Exceptions:
std::logic_error on invalid bounds.

Definition at line 261 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::begin(), mrpt::math::CSparseMatrixTemplate< T >::end(), mrpt::math::CSparseMatrixTemplate< T >::mColumns, and mrpt::math::CSparseMatrixTemplate< T >::mRows.

template<class T>
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 104 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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 86 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::insert().

template<class T>
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 322 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::begin(), mrpt::math::CSparseMatrixTemplate< T >::end(), and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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.

See also:
begin,end,rend

Definition at line 195 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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.

See also:
begin,end,rbegin

Definition at line 202 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
void mrpt::math::CSparseMatrixTemplate< T >::resize ( size_t  nRows,
size_t  nCols 
) [inline]

Changes the size of the matrix.

Definition at line 244 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

Referenced by mrpt::math::intersect().

template<class T>
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).

See also:
getColumn
Exceptions:
std::logic_error on out of range or wrong sized vector.

Definition at line 228 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

template<class T>
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).

See also:
getRow
Exceptions:
std::logic_error on out of range or wrong sized vector.

Definition at line 210 of file CSparseMatrixTemplate.h.

References mrpt::math::CSparseMatrixTemplate< T >::mColumns, mrpt::math::CSparseMatrixTemplate< T >::mRows, and mrpt::math::CSparseMatrixTemplate< T >::objectList.

Member Data Documentation

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::mColumns [protected]

Definition at line 69 of file CSparseMatrixTemplate.h.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::exists(), mrpt::math::CSparseMatrixTemplate< T >::getColumn(), mrpt::math::CSparseMatrixTemplate< T >::getColumnCount(), mrpt::math::CSparseMatrixTemplate< T >::getNullElements(), mrpt::math::CSparseMatrixTemplate< T >::getRow(), mrpt::math::CSparseMatrixTemplate< T >::isNotNull(), mrpt::math::CSparseMatrixTemplate< T >::isNull(), mrpt::math::CSparseMatrixTemplate< T >::operator()(), mrpt::math::CSparseMatrixTemplate< T >::resize(), mrpt::math::CSparseMatrixTemplate< T >::setColumn(), and mrpt::math::CSparseMatrixTemplate< T >::setRow().

template<class T>
size_t mrpt::math::CSparseMatrixTemplate< T >::mRows [protected]

Size of the matrix.

Definition at line 69 of file CSparseMatrixTemplate.h.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::exists(), mrpt::math::CSparseMatrixTemplate< T >::getColumn(), mrpt::math::CSparseMatrixTemplate< T >::getNullElements(), mrpt::math::CSparseMatrixTemplate< T >::getRow(), mrpt::math::CSparseMatrixTemplate< T >::getRowCount(), mrpt::math::CSparseMatrixTemplate< T >::isNotNull(), mrpt::math::CSparseMatrixTemplate< T >::isNull(), mrpt::math::CSparseMatrixTemplate< T >::operator()(), mrpt::math::CSparseMatrixTemplate< T >::resize(), mrpt::math::CSparseMatrixTemplate< T >::setColumn(), and mrpt::math::CSparseMatrixTemplate< T >::setRow().

template<class T>
SparseMatrixMap mrpt::math::CSparseMatrixTemplate< T >::objectList [protected]

Actual matrix.

Definition at line 73 of file CSparseMatrixTemplate.h.

Referenced by mrpt::math::CSparseMatrixTemplate< T >::begin(), mrpt::math::CSparseMatrixTemplate< T >::clear(), mrpt::math::CSparseMatrixTemplate< T >::end(), mrpt::math::CSparseMatrixTemplate< T >::exists(), mrpt::math::CSparseMatrixTemplate< T >::getAsVector(), mrpt::math::CSparseMatrixTemplate< T >::getColumn(), mrpt::math::CSparseMatrixTemplate< T >::getNonNullElements(), mrpt::math::CSparseMatrixTemplate< T >::getRow(), mrpt::math::CSparseMatrixTemplate< T >::isNotNull(), mrpt::math::CSparseMatrixTemplate< T >::isNull(), mrpt::math::CSparseMatrixTemplate< T >::operator()(), mrpt::math::CSparseMatrixTemplate< T >::purge(), mrpt::math::CSparseMatrixTemplate< T >::rbegin(), mrpt::math::CSparseMatrixTemplate< T >::rend(), mrpt::math::CSparseMatrixTemplate< T >::resize(), mrpt::math::CSparseMatrixTemplate< T >::setColumn(), and mrpt::math::CSparseMatrixTemplate< T >::setRow().

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Page generated by Doxygen 1.6.1 for MRPT 0.9.0 SVN: at Mon Jun 7 06:47:58 UTC 2010