Main MRPT website > C++ reference for MRPT 1.9.9
List of all members | Public Types | Public Member Functions | Static Public Member Functions
mrpt::math::CMatrixD Class Reference

Detailed Description

This class is a "CSerializable" wrapper for "CMatrixTemplateNumeric<double>".

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

#include <mrpt/math/CMatrixD.h>

Inheritance diagram for mrpt::math::CMatrixD:
Inheritance graph

Public Types

using Base = Eigen::Matrix< double, Eigen::Dynamic, Eigen::Dynamic, Eigen::AutoAlign|Eigen::RowMajor >
 
using mrpt_autotype = CMatrixTemplateNumeric< double >
 

Public Member Functions

voidoperator new (size_t size)
 
voidoperator new[] (size_t size)
 
void operator delete (void *ptr) noexcept
 
void operator delete[] (void *ptr) noexcept
 
void operator delete (void *memory, void *ptr) noexcept
 
voidoperator new (size_t size, const std::nothrow_t &) noexcept
 
void operator delete (void *ptr, const std::nothrow_t &) noexcept
 
 CMatrixD ()
 Constructor. More...
 
 CMatrixD (size_t row, size_t col)
 Constructor. More...
 
 CMatrixD (const CMatrixTemplateNumeric< double > &m)
 Copy constructor. More...
 
 CMatrixD (const CMatrixFloat &m)
 Copy constructor
More...
 
template<typename OtherDerived >
CMatrixDoperator= (const Eigen::MatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
 CMatrixD (const Eigen::MatrixBase< OtherDerived > &other)
 
virtual mxArraywriteToMatlab () 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 voidoperator 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< CMatrixD >
 
using ConstPtr = std::shared_ptr< const CMatrixD >
 
using UniquePtr = std::unique_ptr< CMatrixD >
 
using ConstUniquePtr = std::unique_ptr< const CMatrixD >
 
static mrpt::rtti::CLASSINIT _init_CMatrixD
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "CMatrixD"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static mrpt::rtti::CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename... Args>
static UniquePtr CreateUnique (Args &&... args)
 
virtual const mrpt::rtti::TRuntimeClassIdGetRuntimeClass () const override
 Returns information about the class of an object in runtime. More...
 
virtual mrpt::rtti::CObjectclone () const override
 Returns a deep copy (clone) of the object, indepently of its class. More...
 

Member Typedef Documentation

◆ Base

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

Definition at line 46 of file CMatrixTemplateNumeric.h.

◆ ConstPtr

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

Definition at line 27 of file CMatrixD.h.

◆ ConstUniquePtr

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

Definition at line 27 of file CMatrixD.h.

◆ mrpt_autotype

Definition at line 47 of file CMatrixTemplateNumeric.h.

◆ Ptr

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

A type for the associated smart pointer

Definition at line 27 of file CMatrixD.h.

◆ UniquePtr

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

Definition at line 27 of file CMatrixD.h.

Constructor & Destructor Documentation

◆ CMatrixD() [1/5]

mrpt::math::CMatrixD::CMatrixD ( )
inline

Constructor.

Definition at line 30 of file CMatrixD.h.

◆ CMatrixD() [2/5]

mrpt::math::CMatrixD::CMatrixD ( size_t  row,
size_t  col 
)
inline

Constructor.

Definition at line 32 of file CMatrixD.h.

◆ CMatrixD() [3/5]

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

Copy constructor.

Definition at line 37 of file CMatrixD.h.

◆ CMatrixD() [4/5]

mrpt::math::CMatrixD::CMatrixD ( const CMatrixFloat m)
inline

Copy constructor

Definition at line 43 of file CMatrixD.h.

◆ CMatrixD() [5/5]

template<typename OtherDerived >
mrpt::math::CMatrixD::CMatrixD ( const Eigen::MatrixBase< OtherDerived > &  other)
inline

Constructor from any other Eigen class

Definition at line 57 of file CMatrixD.h.

Member Function Documentation

◆ _GetBaseClass()

static const mrpt::rtti::TRuntimeClassId* mrpt::math::CMatrixD::_GetBaseClass ( )
staticprotected

◆ clone()

virtual mrpt::rtti::CObject* mrpt::math::CMatrixD::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::CMatrixD::Create ( Args &&...  args)
inlinestatic

Definition at line 27 of file CMatrixD.h.

◆ CreateObject()

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

◆ CreateUnique()

template<typename... Args>
static UniquePtr mrpt::math::CMatrixD::CreateUnique ( Args &&...  args)
inlinestatic

Definition at line 27 of file CMatrixD.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::CMatrixD::getClassName ( )
inlinestaticconstexpr

Definition at line 27 of file CMatrixD.h.

◆ GetRuntimeClass()

virtual const mrpt::rtti::TRuntimeClassId* mrpt::math::CMatrixD::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::CMatrixD::GetRuntimeClassIdStatic ( )
static

◆ operator delete() [1/3]

void mrpt::math::CMatrixD::operator delete ( void memory,
void ptr 
)
inlinenoexcept

Definition at line 27 of file CMatrixD.h.

◆ operator delete() [2/3]

void mrpt::math::CMatrixD::operator delete ( void ptr)
inlinenoexcept

Definition at line 27 of file CMatrixD.h.

◆ operator delete() [3/3]

void mrpt::math::CMatrixD::operator delete ( void ptr,
const std::nothrow_t &   
)
inlinenoexcept

Definition at line 27 of file CMatrixD.h.

◆ operator delete[]()

void mrpt::math::CMatrixD::operator delete[] ( void ptr)
inlinenoexcept

Definition at line 27 of file CMatrixD.h.

◆ operator new() [1/3]

void* mrpt::math::CMatrixD::operator new ( size_t  size)
inline

Definition at line 27 of file CMatrixD.h.

◆ operator new() [2/3]

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

Definition at line 27 of file CMatrixD.h.

◆ operator new() [3/3]

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

Definition at line 27 of file CMatrixD.h.

◆ operator new[]()

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

Definition at line 27 of file CMatrixD.h.

◆ operator=()

template<typename OtherDerived >
CMatrixD& mrpt::math::CMatrixD::operator= ( const Eigen::MatrixBase< OtherDerived > &  other)
inline

Assignment operator from any other Eigen class

Definition at line 50 of file CMatrixD.h.

◆ serializeFrom()

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

Implements mrpt::serialization::CSerializable.

Definition at line 32 of file CMatrixD.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, and setSize().

◆ serializeGetVersion()

uint8_t CMatrixD::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 22 of file CMatrixD.cpp.

◆ serializeTo()

void CMatrixD::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::exceptionOn any I/O error

Implements mrpt::serialization::CSerializable.

Definition at line 23 of file CMatrixD.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_CMatrixD

mrpt::rtti::CLASSINIT mrpt::math::CMatrixD::_init_CMatrixD
staticprotected

Definition at line 27 of file CMatrixD.h.

◆ className

constexpr const char* mrpt::math::CMatrixD::className = "CMatrixD"
staticconstexpr

Definition at line 27 of file CMatrixD.h.

◆ runtimeClassId

const mrpt::rtti::TRuntimeClassId mrpt::math::CMatrixD::runtimeClassId
staticprotected

Definition at line 27 of file CMatrixD.h.




Page generated by Doxygen 1.8.17 for MRPT 1.9.9 Git: ad3a9d8ae Tue May 1 23:10:22 2018 -0700 at miƩ 12 jul 2023 10:03:34 CEST