Detailed Description

This class is a "CSerializable" wrapper for "CMatrixFloat".

Note: For a complete introduction to Matrices and vectors in MRPT, see: http://www.mrpt.org/Matrices_vectors_arrays_and_Linear_Algebra_MRPT_and_Eigen_classes

Definition at line 50 of file CMatrix.h.

#include <mrpt/math/CMatrix.h>

Inheritance diagram for mrpt::math::CMatrix:

Public Types
typedef CMatrixPtr	SmartPtr

typedef Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic, Eigen::AutoAlign\|Eigen::RowMajor >	Base

typedef CMatrixTemplateNumeric< T >	mrpt_autotype

Public Member Functions
virtual BASE_IMPEXP const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime.

virtual BASE_IMPEXP mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.

	CMatrix ()
	Constructor.

	CMatrix (size_t row, size_t col)
	Constructor.

	CMatrix (const CMatrixFloat &m)
	Copy constructor.

	CMatrix (const CMatrixTemplateNumeric< double > &m)
	Copy constructor.

	CMatrix (const TPose2D &p)
	Constructor from a TPose2D, which generates a 3x1 matrix $[x y \phi]^T$ .

	CMatrix (const TPose3D &p)
	Constructor from a mrpt::poses::CPose6D, which generates a 6x1 matrix .

	CMatrix (const TPoint2D &p)
	Constructor from a TPoint2D, which generates a 2x1 matrix .

	CMatrix (const TPoint3D &p)
	Constructor from a TPoint3D, which generates a 3x1 matrix .

template<class OTHERMAT >
CMatrix &	operator= (const OTHERMAT &m)
	Assignment operator for float matrixes.

template<typename OtherDerived >
CMatrix &	operator= (const Eigen::MatrixBase< OtherDerived > &other)

template<typename OtherDerived >
	CMatrix (const Eigen::MatrixBase< OtherDerived > &other)

mrpt::utils::CObjectPtr	duplicateGetSmartPtr () const
	Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

CObject *	clone () const
	Cloning interface for smart pointers.

Static Public Member Functions
static BASE_IMPEXP mrpt::utils::CObject *	CreateObject ()

static BASE_IMPEXP CMatrixPtr	Create ()

Static Public Attributes
static BASE_IMPEXP mrpt::utils::TRuntimeClassId	classCMatrix

static BASE_IMPEXP const mrpt::utils::TRuntimeClassId *	classinfo

static const mrpt::utils::TRuntimeClassId	classCObject

RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
BASE_IMPEXP void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream.

BASE_IMPEXP void	readFromStream (mrpt::utils::CStream &in, int version)
	Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Static Protected Member Functions
static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()

Static Protected Attributes
static mrpt::utils::CLASSINIT	_init_CMatrix

Member Typedef Documentation

template<class T>

typedef Eigen::Matrix<T,Eigen::Dynamic,Eigen::Dynamic,Eigen::AutoAlign|Eigen::RowMajor> mrpt::math::CMatrixTemplateNumeric< T >::Base

inherited

Definition at line 73 of file CMatrixTemplateNumeric.h.

template<class T>

typedef CMatrixTemplateNumeric<T> mrpt::math::CMatrixTemplateNumeric< T >::mrpt_autotype

inherited

Definition at line 74 of file CMatrixTemplateNumeric.h.

typedef CMatrixPtr mrpt::math::CMatrix::SmartPtr

A typedef for the associated smart pointer

Definition at line 60 of file CMatrix.h.

Constructor & Destructor Documentation

mrpt::math::CMatrix::CMatrix ( )

inline

Constructor.

Definition at line 76 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix	(	size_t	row,
		size_t	col
	)

inline

Constructor.

Definition at line 80 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const CMatrixFloat & m )

inline

Copy constructor.

Definition at line 85 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const CMatrixTemplateNumeric< double > & m )

inline

Copy constructor.

Definition at line 90 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPose2D & p )

inlineexplicit

Constructor from a TPose2D, which generates a 3x1 matrix $[x y \phi]^T$ .

Definition at line 97 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPose3D & p )

inlineexplicit

Constructor from a mrpt::poses::CPose6D, which generates a 6x1 matrix $ [x y z yaw pitch roll]^T $ .

Definition at line 101 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPoint2D & p )

inlineexplicit

Constructor from a TPoint2D, which generates a 2x1 matrix $ [x y]^T $ .

Definition at line 105 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPoint3D & p )

inlineexplicit

Constructor from a TPoint3D, which generates a 3x1 matrix $ [x y z]^T $ .

Definition at line 109 of file CMatrix.h.

template<typename OtherDerived >

mrpt::math::CMatrix::CMatrix ( const Eigen::MatrixBase< OtherDerived > & other )

inline

Constructor from any other Eigen class

Definition at line 128 of file CMatrix.h.

Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrix::_GetBaseClass ( )

staticprotected

CObject* mrpt::utils::CObject::clone ( ) const

inlineinherited

Cloning interface for smart pointers.

Definition at line 154 of file CObject.h.

static BASE_IMPEXP CMatrixPtr mrpt::math::CMatrix::Create ( )

static

static BASE_IMPEXP mrpt::utils::CObject* mrpt::math::CMatrix::CreateObject ( )

static

virtual BASE_IMPEXP mrpt::utils::CObject* mrpt::math::CMatrix::duplicate ( ) const

virtual

Returns a copy of the object, indepently of its class.

Implements mrpt::utils::CObject.

mrpt::utils::CObjectPtr mrpt::utils::CObject::duplicateGetSmartPtr ( ) const

inlineinherited

Returns a copy of the object, indepently of its class, as a smart pointer (the newly created object will exist as long as any copy of this smart pointer).

Definition at line 151 of file CObject.h.

virtual BASE_IMPEXP const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrix::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

template<class OTHERMAT >

CMatrix& mrpt::math::CMatrix::operator= ( const OTHERMAT & m )

inline

Assignment operator for float matrixes.

Definition at line 114 of file CMatrix.h.

template<typename OtherDerived >

CMatrix& mrpt::math::CMatrix::operator= ( const Eigen::MatrixBase< OtherDerived > & other )

inline

Assignment operator from any other Eigen class

Definition at line 122 of file CMatrix.h.

BASE_IMPEXP void mrpt::math::CMatrix::readFromStream	(	mrpt::utils::CStream &	in,
		int	version
	)

protectedvirtual

Introduces a pure virtual method responsible for loading from a CStream This can not be used directly be users, instead use "stream >> object;" for reading it from a stream or "stream >> object_ptr;" if the class is unknown apriori.

Parameters

in	The input binary stream where the object data must read from.
version	The version of the object stored in the stream: use this version number in your code to know how to read the incoming data.

Exceptions

std::exception On any error, see CStream::ReadBuffer

See Also: CStream

Implements mrpt::utils::CSerializable.

BASE_IMPEXP void mrpt::math::CMatrix::writeToStream	(	mrpt::utils::CStream &	out,
		int *	getVersion
	)		const

protectedvirtual

Introduces a pure virtual method responsible for writing to a CStream.

This can not be used directly be users, instead use "stream << object;" for writing it to a stream.

Parameters

out	The output binary stream where object must be dumped.
getVersion	If NULL, the object must be dumped. If not, only the version of the object dump must be returned in this pointer. This enables the versioning of objects dumping and backward compatibility with previously stored data.

Exceptions

std::exception On any error, see CStream::WriteBuffer

See Also: CStream

Implements mrpt::utils::CSerializable.

Member Data Documentation

mrpt::utils::CLASSINIT mrpt::math::CMatrix::_init_CMatrix

staticprotected

Definition at line 57 of file CMatrix.h.

BASE_IMPEXP mrpt::utils::TRuntimeClassId mrpt::math::CMatrix::classCMatrix

static

Definition at line 61 of file CMatrix.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CObject::classCObject

staticinherited

Definition at line 139 of file CObject.h.

const mrpt::utils::TRuntimeClassId mrpt::utils::CSerializable::classCSerializable

staticinherited

Definition at line 56 of file CSerializable.h.

BASE_IMPEXP const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrix::classinfo

static

Definition at line 62 of file CMatrix.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation