Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Static Protected Attributes

mrpt::math::CMatrix Class Reference


Detailed Description

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

Definition at line 48 of file CMatrix.h.

#include <mrpt/math/CMatrix.h>

Inheritance diagram for mrpt::math::CMatrix:
Inheritance graph
[legend]

List of all members.

Public Types

typedef CMatrixPtr SmartPtr

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 $ [x y z yaw pitch roll]^T $.
 CMatrix (const TPoint2D &p)
 Constructor from a TPoint2D, which generates a 2x1 matrix $ [x y]^T $.
 CMatrix (const TPoint3D &p)
 Constructor from a TPoint3D, which generates a 3x1 matrix $ [x y z]^T $.
template<class OTHERMAT >
CMatrixoperator= (const OTHERMAT &m)
 Assignment operator for float matrixes.
template<typename OtherDerived >
CMatrixoperator= (const Eigen::MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
 CMatrix (const Eigen::MatrixBase< OtherDerived > &other)

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

Protected Member Functions

CSerializable virtual methods
BASE_IMPEXP void writeToStream (mrpt::utils::CStream &out, int *getVersion) const
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

A typedef for the associated smart pointer

Definition at line 58 of file CMatrix.h.


Constructor & Destructor Documentation

mrpt::math::CMatrix::CMatrix ( ) [inline]

Constructor.

Definition at line 74 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( size_t  row,
size_t  col 
) [inline]

Constructor.

Definition at line 78 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const CMatrixFloat m) [inline]

Copy constructor.

Definition at line 83 of file CMatrix.h.

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

Copy constructor.

Definition at line 88 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPose2D p) [inline, explicit]

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

Definition at line 95 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPose3D p) [inline, explicit]

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

Definition at line 99 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPoint2D p) [inline, explicit]

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

Definition at line 103 of file CMatrix.h.

mrpt::math::CMatrix::CMatrix ( const TPoint3D p) [inline, explicit]

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

Definition at line 107 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 126 of file CMatrix.h.


Member Function Documentation

static const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrix::_GetBaseClass ( ) [static, protected]

Reimplemented from mrpt::utils::CSerializable.

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.

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<typename OtherDerived >
CMatrix& mrpt::math::CMatrix::operator= ( const Eigen::MatrixBase< OtherDerived > &  other) [inline]

Assignment operator from any other Eigen class

Definition at line 120 of file CMatrix.h.

template<class OTHERMAT >
CMatrix& mrpt::math::CMatrix::operator= ( const OTHERMAT &  m) [inline]

Assignment operator for float matrixes.

Definition at line 112 of file CMatrix.h.

BASE_IMPEXP void mrpt::math::CMatrix::readFromStream ( mrpt::utils::CStream in,
int  version 
) [protected, virtual]

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:
inThe input binary stream where the object data must read from.
versionThe 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::exceptionOn 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 [protected, virtual]

Member Data Documentation

Definition at line 55 of file CMatrix.h.

Definition at line 59 of file CMatrix.h.

Definition at line 60 of file CMatrix.h.




Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN:exported at Tue Jan 25 21:56:31 UTC 2011