mrpt::math::CMatrixB Class Reference

Detailed Description

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

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 47 of file CMatrixB.h.

#include <mrpt/math/CMatrixB.h>

Inheritance diagram for mrpt::math::CMatrixB:

Public Member Functions
	CMatrixB (size_t row=1, size_t col=1)
	Constructor.
	CMatrixB (const CMatrixBool &m)
	Copy constructor.
CMatrixB &	operator= (const CMatrixBool &m)
	Assignment operator for float matrixes.
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 Attributes
static const mrpt::utils::TRuntimeClassId	classCObject
RTTI stuff
static const mrpt::utils::TRuntimeClassId	classCSerializable

Protected Member Functions
CSerializable virtual methods
void	writeToStream (mrpt::utils::CStream &out, int *getVersion) const
	Introduces a pure virtual method responsible for writing to a CStream.
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.

RTTI stuff
typedef CMatrixBPtr	SmartPtr
static mrpt::utils::CLASSINIT	_init_CMatrixB
static mrpt::utils::TRuntimeClassId	classCMatrixB
static const mrpt::utils::TRuntimeClassId *	classinfo
static const mrpt::utils::TRuntimeClassId *	_GetBaseClass ()
virtual const mrpt::utils::TRuntimeClassId *	GetRuntimeClass () const
	Returns information about the class of an object in runtime.
virtual mrpt::utils::CObject *	duplicate () const
	Returns a copy of the object, indepently of its class.
static mrpt::utils::CObject *	CreateObject ()
static CMatrixBPtr	Create ()

Member Typedef Documentation

typedef CMatrixBPtr mrpt::math::CMatrixB::SmartPtr

A typedef for the associated smart pointer

Definition at line 50 of file CMatrixB.h.

Constructor & Destructor Documentation

mrpt::math::CMatrixB::CMatrixB ( size_t  row = 1, size_t  col = 1  )

inline

Constructor.

Definition at line 54 of file CMatrixB.h.

mrpt::math::CMatrixB::CMatrixB ( const CMatrixBool &  m )

inline

Copy constructor.

Definition at line 60 of file CMatrixB.h.

Member Function Documentation

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

staticprotected

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

inlineinherited

Cloning interface for smart pointers.

Definition at line 154 of file CObject.h.

static CMatrixBPtr mrpt::math::CMatrixB::Create ( )

static

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

static

virtual mrpt::utils::CObject* mrpt::math::CMatrixB::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 const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrixB::GetRuntimeClass ( ) const

virtual

Returns information about the class of an object in runtime.

Reimplemented from mrpt::utils::CSerializable.

CMatrixB& mrpt::math::CMatrixB::operator= ( const CMatrixBool &  m )

inline

Assignment operator for float matrixes.

Definition at line 66 of file CMatrixB.h.

void mrpt::math::CMatrixB::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.

void mrpt::math::CMatrixB::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::CMatrixB::_init_CMatrixB

staticprotected

Definition at line 50 of file CMatrixB.h.

mrpt::utils::TRuntimeClassId mrpt::math::CMatrixB::classCMatrixB

static

Definition at line 50 of file CMatrixB.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.

const mrpt::utils::TRuntimeClassId* mrpt::math::CMatrixB::classinfo

static

Definition at line 50 of file CMatrixB.h.