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

---

Detailed Description

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

This template class extends the class "CMatrixTemplate" for storing "objects" at each matrix entry.

This class allows a very efficient representation of sparse matrixes where each cell is an arbitrary C++ class, but its use must carefully observe the following rules:

• The type in the template especialization MUST be a class with a proper default constructor.
• Initially all entries are set to NULL pointers.
• Pointers can be manually asigned, or automatically created through a call to "CMatrixTemplateObjects<T>::allocAllObjects"
• Independently of how pointers are asigned, memory will be free by destroying objects for each non-NULL entry in the matrix. In some special situations, the user can indicate not to free those objects by calling "CMatrixTemplateObjects<T>::setDestroyBehavior", then it is up to the user to free the memory. In all cases the default behavior is to free the memory.
• Asignament operator with matrixes will COPY THE POINTERS, thus a copy of objects is not performed.
• WARNING: Objects are not deleted while shrinking the matrix by calling "setSize", thus please call ""CMatrixTemplateObjects<T>::freeAllObjects" or manually delete objects before shrinking.

See also:

CMatrixTemplate

Definition at line 50 of file CMatrixTemplateObjects.h.

#include <mrpt/math/CMatrixTemplateObjects.h>

Inheritance diagram for mrpt::math::CMatrixTemplateObjects< T >:

List of all members.

Public Member Functions
	CMatrixTemplateObjects (const CMatrixTemplate< T > &m)
	Copy constructor.
	CMatrixTemplateObjects (size_t row=3, size_t col=3)
	Constructor.
virtual void	setSize (size_t row, size_t col)
	Changes the size of matrix.
virtual	~CMatrixTemplateObjects ()
	Destructor.
void	freeAllObjects ()
	Delete all the objects in the matrix and set all entries to NULL pointers.
CMatrixTemplateObjects &	operator= (const CMatrixTemplateObjects &m)
	Assignment operator.
void	setDestroyBehavior (bool freeObjects=true)
	Sets the behavior on matrix destroy.
void	allocAllObjects ()
	Alloc memory for all the non-NULL entries in the matrix.
Private Attributes
bool	m_freeObjects

---

Constructor & Destructor Documentation

template<class T>

mrpt::math::CMatrixTemplateObjects< T >::CMatrixTemplateObjects

(

const CMatrixTemplate< T > &

m )

[inline]

Copy constructor.

Definition at line 58 of file CMatrixTemplateObjects.h.

template<class T>

mrpt::math::CMatrixTemplateObjects< T >::CMatrixTemplateObjects	(	size_t	row = 3,
		size_t	col = 3
	)		[inline]

Constructor.

Definition at line 64 of file CMatrixTemplateObjects.h.

References getColCount(), and getRowCount().

template<class T>

virtual mrpt::math::CMatrixTemplateObjects< T >::~CMatrixTemplateObjects

(

)

[inline, virtual]

Destructor.

Definition at line 81 of file CMatrixTemplateObjects.h.

References mrpt::math::CMatrixTemplateObjects< T >::freeAllObjects(), and mrpt::math::CMatrixTemplateObjects< T >::m_freeObjects.

---

Member Function Documentation

template<class T>

void mrpt::math::CMatrixTemplateObjects< T >::allocAllObjects

(

)

[inline]

Alloc memory for all the non-NULL entries in the matrix.

See the general description of the class on the top.

Definition at line 123 of file CMatrixTemplateObjects.h.

References getColCount(), and getRowCount().

template<class T>

void mrpt::math::CMatrixTemplateObjects< T >::freeAllObjects

(

)

[inline]

Delete all the objects in the matrix and set all entries to NULL pointers.

Definition at line 89 of file CMatrixTemplateObjects.h.

References getColCount(), and getRowCount().

Referenced by mrpt::math::CMatrixTemplateObjects< T >::~CMatrixTemplateObjects().

template<class T>

CMatrixTemplateObjects& mrpt::math::CMatrixTemplateObjects< T >::operator=

(

const CMatrixTemplateObjects< T > &

m )

[inline]

Assignment operator.

Definition at line 102 of file CMatrixTemplateObjects.h.

References getColCount(), mrpt::math::CMatrixTemplate< T >::getColCount(), getRowCount(), mrpt::math::CMatrixTemplate< T >::getRowCount(), mrpt::math::CMatrixTemplate< T >::m_Val, and mrpt::math::CMatrixTemplate< T * >::realloc().

template<class T>

void mrpt::math::CMatrixTemplateObjects< T >::setDestroyBehavior

(

bool

freeObjects = true )

[inline]

Sets the behavior on matrix destroy.

See the general description of the class on the top.

Definition at line 115 of file CMatrixTemplateObjects.h.

References mrpt::math::CMatrixTemplateObjects< T >::m_freeObjects.

template<class T>

virtual void mrpt::math::CMatrixTemplateObjects< T >::setSize	(	size_t	row,
		size_t	col
	)		[inline, virtual]

Changes the size of matrix.

Definition at line 73 of file CMatrixTemplateObjects.h.

References mrpt::math::CMatrixTemplate< T * >::realloc().

---

Member Data Documentation

template<class T>

bool mrpt::math::CMatrixTemplateObjects< T >::m_freeObjects [private]

Definition at line 53 of file CMatrixTemplateObjects.h.

Referenced by mrpt::math::CMatrixTemplateObjects< T >::setDestroyBehavior(), and mrpt::math::CMatrixTemplateObjects< T >::~CMatrixTemplateObjects().