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 25 of file CMatrix.h.

#include <mrpt/math/CMatrix.h>

Inheritance diagram for mrpt::math::CMatrix:

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

typedef CMatrixTemplateNumeric< T >	mrpt_autotype

Public Member Functions
void *	operator new (size_t size)

void *	operator new[] (size_t size)

void	operator delete (void *ptr) noexcept

void	operator delete[] (void *ptr) noexcept

void	operator delete (void memory, void ptr) noexcept

void *	operator new (size_t size, const std::nothrow_t &) noexcept

void	operator delete (void *ptr, const std::nothrow_t &) noexcept

	CMatrix ()
	Constructor. More...

	CMatrix (size_t row, size_t col)
	Constructor. More...

	CMatrix (const CMatrixFloat &m)
	Copy constructor. More...

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

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

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

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

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

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

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

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

virtual mxArray *	writeToMatlab () const
	Introduces a pure virtual method responsible for writing to a `mxArray` Matlab object, typically a MATLAB `struct` whose contents are documented in each derived class. More...

RTTI classes and functions
mrpt::utils::CObject::Ptr	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). More...

Static Public Member Functions
static void *	operator new (size_t size, void *ptr)

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

void	readFromStream (mrpt::utils::CStream &in, int version) override
	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. More...

RTTI stuff
using	Ptr = std::shared_ptr< CMatrix >

using	ConstPtr = std::shared_ptr< const CMatrix >

static mrpt::utils::CLASSINIT	_init_CMatrix

static const mrpt::utils::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CMatrix"

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

static const mrpt::utils::TRuntimeClassId &	GetRuntimeClassIdStatic ()

static mrpt::utils::CObject *	CreateObject ()

template<typename... Args>
static Ptr	Create (Args &&... args)

virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const override
	Returns information about the class of an object in runtime. More...

virtual mrpt::utils::CObject *	clone () const override
	Returns a deep copy (clone) of the object, indepently of its class. More...

Member Typedef Documentation

◆ Base

template<class T>

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

inherited

Definition at line 47 of file CMatrixTemplateNumeric.h.

◆ ConstPtr

using mrpt::math::CMatrix::ConstPtr = std::shared_ptr<const CMatrix >

Definition at line 27 of file CMatrix.h.

◆ mrpt_autotype

template<class T>

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

inherited

Definition at line 48 of file CMatrixTemplateNumeric.h.

◆ Ptr

using mrpt::math::CMatrix::Ptr = std::shared_ptr< CMatrix >

A typedef for the associated smart pointer

Definition at line 27 of file CMatrix.h.

Constructor & Destructor Documentation

◆ CMatrix() [1/9]

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

inline

Constructor.

Definition at line 31 of file CMatrix.h.

◆ CMatrix() [2/9]

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

inline

Constructor.

Definition at line 33 of file CMatrix.h.

◆ CMatrix() [3/9]

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

inline

Copy constructor.

Definition at line 36 of file CMatrix.h.

◆ CMatrix() [4/9]

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

inline

Copy constructor.

Definition at line 39 of file CMatrix.h.

◆ CMatrix() [5/9]

CMatrix::CMatrix ( const TPose2D & p )

explicit

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

Definition at line 25 of file CMatrix.cpp.

◆ CMatrix() [6/9]

CMatrix::CMatrix ( const TPose3D & p )

explicit

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

Definition at line 28 of file CMatrix.cpp.

◆ CMatrix() [7/9]

CMatrix::CMatrix ( const TPoint2D & p )

explicit

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

Definition at line 30 of file CMatrix.cpp.

◆ CMatrix() [8/9]

CMatrix::CMatrix ( const TPoint3D & p )

explicit

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

Definition at line 33 of file CMatrix.cpp.

◆ CMatrix() [9/9]

template<typename OtherDerived >

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

inline

Constructor from any other Eigen class

Definition at line 75 of file CMatrix.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

virtual mrpt::utils::CObject* mrpt::math::CMatrix::clone ( ) const

overridevirtual

Returns a deep copy (clone) of the object, indepently of its class.

Implements mrpt::utils::CObject.

◆ Create()

template<typename... Args>

static Ptr mrpt::math::CMatrix::Create ( Args &&... args )

inlinestatic

Definition at line 27 of file CMatrix.h.

◆ CreateObject()

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

static

◆ GetRuntimeClass()

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

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

◆ GetRuntimeClassIdStatic()

static const mrpt::utils::TRuntimeClassId& mrpt::math::CMatrix::GetRuntimeClassIdStatic ( )

static

◆ operator delete() [1/3]

void mrpt::math::CMatrix::operator delete ( void * ptr )

inlinenoexcept

Definition at line 27 of file CMatrix.h.

◆ operator delete() [2/3]

void mrpt::math::CMatrix::operator delete	(	void *	memory,
		void *	ptr
	)

inlinenoexcept

Definition at line 27 of file CMatrix.h.

◆ operator delete() [3/3]

void mrpt::math::CMatrix::operator delete	(	void *	ptr,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 27 of file CMatrix.h.

◆ operator delete[]()

void mrpt::math::CMatrix::operator delete[] ( void * ptr )

inlinenoexcept

Definition at line 27 of file CMatrix.h.

◆ operator new() [1/3]

static void* mrpt::math::CMatrix::operator new	(	size_t	size,
		void *	ptr
	)

inlinestatic

Definition at line 27 of file CMatrix.h.

◆ operator new() [2/3]

void* mrpt::math::CMatrix::operator new ( size_t size )

inline

Definition at line 27 of file CMatrix.h.

◆ operator new() [3/3]

void* mrpt::math::CMatrix::operator new	(	size_t	size,
		const std::nothrow_t &
	)

inlinenoexcept

Definition at line 27 of file CMatrix.h.

◆ operator new[]()

void* mrpt::math::CMatrix::operator new[] ( size_t size )

inline

Definition at line 27 of file CMatrix.h.

◆ operator=() [1/2]

template<class OTHERMAT >

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

inline

Assignment operator for float matrixes.

Definition at line 60 of file CMatrix.h.

◆ operator=() [2/2]

template<typename OtherDerived >

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

inline

Assignment operator from any other Eigen class

Definition at line 68 of file CMatrix.h.

◆ readFromStream()

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

overrideprotectedvirtual

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.

Definition at line 55 of file CMatrix.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and setSize().

Here is the call graph for this function:

◆ writeToMatlab()

virtual mxArray* mrpt::utils::CSerializable::writeToMatlab ( ) const

inlinevirtualinherited

Introduces a pure virtual method responsible for writing to a mxArray Matlab object, typically a MATLAB struct whose contents are documented in each derived class.

Returns: A new mxArray (caller is responsible of memory freeing) or nullptr is class does not support conversion to MATLAB.

Definition at line 89 of file CSerializable.h.

◆ writeToStream()

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

overrideprotectedvirtual

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 nullptr, 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.

Definition at line 37 of file CMatrix.cpp.

References mrpt::utils::CStream::WriteBufferFixEndianness().

Here is the call graph for this function:

Member Data Documentation

◆ _init_CMatrix

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

staticprotected

Definition at line 27 of file CMatrix.h.

◆ className

constexpr const char* mrpt::math::CMatrix::className = "CMatrix"

static

Definition at line 27 of file CMatrix.h.

◆ runtimeClassId

const mrpt::utils::TRuntimeClassId mrpt::math::CMatrix::runtimeClassId

staticprotected

Definition at line 27 of file CMatrix.h.

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

RTTI stuff

Member Typedef Documentation

◆ Base

◆ ConstPtr

◆ mrpt_autotype

◆ Ptr

Constructor & Destructor Documentation

◆ CMatrix() [1/9]

◆ CMatrix() [2/9]

◆ CMatrix() [3/9]

◆ CMatrix() [4/9]

◆ CMatrix() [5/9]

◆ CMatrix() [6/9]

◆ CMatrix() [7/9]

◆ CMatrix() [8/9]

◆ CMatrix() [9/9]

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ GetRuntimeClass()

◆ GetRuntimeClassIdStatic()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]()

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ readFromStream()

◆ writeToMatlab()

◆ writeToStream()

Member Data Documentation

◆ _init_CMatrix

◆ className

◆ runtimeClassId