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

#include <mrpt/math/CMatrix.h>

Inheritance diagram for mrpt::math::CMatrix:

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

using	mrpt_autotype = CMatrixTemplateNumeric< T >

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

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

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

Protected Member Functions
CSerializable virtual methods
uint8_t	serializeGetVersion () const override
	Must return the current versioning number of the object. More...

void	serializeTo (mrpt::serialization::CArchive &out) const override
	Pure virtual method for writing (serializing) to an abstract archive. More...

void	serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
	Pure virtual method for reading (deserializing) from an abstract archive. More...

RTTI stuff

using	Ptr = std::shared_ptr< CMatrix >

using	ConstPtr = std::shared_ptr< const CMatrix >

using	UniquePtr = std::unique_ptr< CMatrix >

using	ConstUniquePtr = std::unique_ptr< const CMatrix >

static mrpt::rtti::CLASSINIT	_init_CMatrix

static const mrpt::rtti::TRuntimeClassId	runtimeClassId

static constexpr const char *	className = "CMatrix"

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

static constexpr auto	getClassName ()

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

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

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

template<typename... Args>
static UniquePtr	CreateUnique (Args &&... args)

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

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

Member Typedef Documentation

◆ Base

template<class T >

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

inherited

Definition at line 46 of file CMatrixTemplateNumeric.h.

◆ ConstPtr

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

Definition at line 26 of file CMatrix.h.

◆ ConstUniquePtr

using mrpt::math::CMatrix::ConstUniquePtr = std::unique_ptr<const CMatrix >

Definition at line 26 of file CMatrix.h.

◆ mrpt_autotype

template<class T >

using mrpt::math::CMatrixTemplateNumeric< T >::mrpt_autotype = CMatrixTemplateNumeric<T>

inherited

Definition at line 47 of file CMatrixTemplateNumeric.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 26 of file CMatrix.h.

◆ UniquePtr

using mrpt::math::CMatrix::UniquePtr = std::unique_ptr< CMatrix >

Definition at line 26 of file CMatrix.h.

Constructor & Destructor Documentation

◆ CMatrix() [1/5]

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

inline

Constructor

Definition at line 30 of file CMatrix.h.

◆ CMatrix() [2/5]

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

inline

Constructor

Definition at line 32 of file CMatrix.h.

◆ CMatrix() [3/5]

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

inline

Copy constructor.

Definition at line 35 of file CMatrix.h.

◆ CMatrix() [4/5]

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

inline

Copy constructor.

Definition at line 38 of file CMatrix.h.

◆ CMatrix() [5/5]

template<typename OtherDerived >

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

inline

Constructor from any other Eigen class

Definition at line 62 of file CMatrix.h.

Member Function Documentation

◆ _GetBaseClass()

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

staticprotected

◆ clone()

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

overridevirtual

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

Implements mrpt::rtti::CObject.

◆ Create()

template<typename... Args>

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

inlinestatic

Definition at line 26 of file CMatrix.h.

◆ CreateObject()

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

static

◆ CreateUnique()

template<typename... Args>

static UniquePtr mrpt::math::CMatrix::CreateUnique ( Args &&... args )

inlinestatic

Definition at line 26 of file CMatrix.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr 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 169 of file CObject.h.

References mrpt::rtti::CObject::clone().

Referenced by mrpt::obs::CRawlog::addActions(), and mrpt::obs::CRawlog::addObservations().

◆ getClassName()

static constexpr auto mrpt::math::CMatrix::getClassName ( )

inlinestaticconstexpr

Definition at line 26 of file CMatrix.h.

◆ GetRuntimeClass()

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

overridevirtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::serialization::CSerializable.

◆ GetRuntimeClassIdStatic()

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

static

◆ operator delete() [1/3]

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

inlinenoexcept

Definition at line 26 of file CMatrix.h.

◆ operator delete() [2/3]

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

inlinenoexcept

Definition at line 26 of file CMatrix.h.

◆ operator delete() [3/3]

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

inlinenoexcept

Definition at line 26 of file CMatrix.h.

◆ operator delete[]()

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

inlinenoexcept

Definition at line 26 of file CMatrix.h.

◆ operator new() [1/3]

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

inline

Definition at line 26 of file CMatrix.h.

◆ operator new() [2/3]

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

inlinenoexcept

Definition at line 26 of file CMatrix.h.

◆ operator new() [3/3]

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

inlinestatic

Definition at line 26 of file CMatrix.h.

◆ operator new[]()

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

inline

Definition at line 26 of file CMatrix.h.

◆ operator=() [1/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 55 of file CMatrix.h.

◆ operator=() [2/2]

template<class OTHERMAT >

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

inline

Assignment operator for float matrixes.

Definition at line 47 of file CMatrix.h.

◆ serializeFrom()

void CMatrix::serializeFrom	(	mrpt::serialization::CArchive &	in,
		uint8_t	serial_version
	)

overrideprotectedvirtual

Pure virtual method for reading (deserializing) from an abstract archive.

Users don't call this method directly. Instead, use stream >> object;.

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 I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 34 of file CMatrix.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and setSize().

◆ serializeGetVersion()

uint8_t CMatrix::serializeGetVersion ( ) const

overrideprotectedvirtual

Must return the current versioning number of the object.

Start in zero for new classes, and increments each time there is a change in the stored format.

Implements mrpt::serialization::CSerializable.

Definition at line 23 of file CMatrix.cpp.

◆ serializeTo()

void CMatrix::serializeTo ( mrpt::serialization::CArchive & out ) const

overrideprotectedvirtual

Pure virtual method for writing (serializing) to an abstract archive.

Users don't call this method directly. Instead, use stream << object;.

Exceptions

std::exception On any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 24 of file CMatrix.cpp.

References mrpt::serialization::CArchive::WriteBufferFixEndianness().

◆ writeToMatlab()

virtual mxArray* mrpt::serialization::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 70 of file CSerializable.h.

Member Data Documentation

◆ _init_CMatrix

mrpt::rtti::CLASSINIT mrpt::math::CMatrix::_init_CMatrix

staticprotected

Definition at line 26 of file CMatrix.h.

◆ className

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

staticconstexpr

Definition at line 26 of file CMatrix.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::math::CMatrix::runtimeClassId

staticprotected

Definition at line 26 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

◆ ConstUniquePtr

◆ mrpt_autotype

◆ Ptr

◆ UniquePtr

Constructor & Destructor Documentation

◆ CMatrix() [1/5]

◆ CMatrix() [2/5]

◆ CMatrix() [3/5]

◆ CMatrix() [4/5]

◆ CMatrix() [5/5]

Member Function Documentation

◆ _GetBaseClass()

◆ clone()

◆ Create()

◆ CreateObject()

◆ CreateUnique()

◆ duplicateGetSmartPtr()

◆ getClassName()

◆ 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]

◆ serializeFrom()

◆ serializeGetVersion()

◆ serializeTo()

◆ writeToMatlab()

Member Data Documentation

◆ _init_CMatrix

◆ className

◆ runtimeClassId