MRPT  1.9.9
List of all members | Public Member Functions | Static Public Member Functions
mrpt::math::CMatrixF Class Reference

Detailed Description

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

Note
For a complete introduction to Matrices and vectors in MRPT, see: https://www.mrpt.org/Matrices_vectors_arrays_and_Linear_Algebra_MRPT_and_Eigen_classes

Definition at line 22 of file CMatrixF.h.

#include <mrpt/math/CMatrixF.h>

Inheritance diagram for mrpt::math::CMatrixF:

Public Member Functions

 CMatrixF ()
 Constructor. More...
 
 CMatrixF (size_t row, size_t col)
 Constructor. More...
 
 CMatrixF (const CMatrixFloat &m)
 Copy constructor. More...
 
 CMatrixF (const CMatrixDynamic< double > &m)
 Copy constructor. More...
 
template<class OTHERMAT >
CMatrixFoperator= (const OTHERMAT &m)
 Assignment operator for float matrixes. More...
 
template<typename OtherDerived >
CMatrixFoperator= (const Eigen::MatrixBase< OtherDerived > &other)
 
template<typename OtherDerived >
 CMatrixF (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...
 
void swap (CMatrixDynamic< T > &o)
 Swap with another matrix very efficiently (just swaps a pointer and two integer values). More...
 
template<class MAT >
void setFromMatrixLike (const MAT &m)
 
size_type rows () const
 Number of rows in the matrix. More...
 
size_type cols () const
 Number of columns in the matrix. More...
 
matrix_size_t size () const
 Get a 2-vector with [NROWS NCOLS] (as in MATLAB command size(x)) More...
 
void setSize (size_t row, size_t col, bool zeroNewElements=false)
 Changes the size of matrix, maintaining the previous contents. More...
 
void resize (size_t row, size_t col)
 
void resize (size_t vectorLen)
 Resizes as a Nx1 vector. More...
 
void resize (const matrix_size_t &siz, bool zeroNewElements=false)
 Resize the matrix. More...
 
CMatrixDynamicderived ()
 
const CMatrixDynamicderived () const
 
void conservativeResize (size_t row, size_t col)
 
const T * data () const
 Return raw pointer to row-major data buffer. More...
 
T * data ()
 
T & operator() (size_t row, size_t col)
 Subscript operator to get/set individual elements. More...
 
const T & operator() (size_t row, size_t col) const
 Subscript operator to get individual elements. More...
 
T & operator[] (size_t ith)
 Subscript operator to get/set an individual element from a row or column matrix. More...
 
const T & operator[] (size_t ith) const
 Subscript operator to get/set an individual element from a row or column matrix. More...
 
template<typename VECTOR >
void appendRow (const VECTOR &in)
 Appends a new row to the MxN matrix from a 1xN vector. More...
 
template<typename VECTOR >
void setRow (const Index row, const VECTOR &v)
 
template<typename VECTOR >
void setCol (const Index col, const VECTOR &v)
 
template<typename VECTOR >
void appendCol (const VECTOR &in)
 Appends a new column to the matrix from a vector. More...
 
template<typename VECTOR >
void asVector (VECTOR &out) const
 Returns a vector containing the matrix's values. More...
 
template<typename EIGEN_MATRIX = eigen_t, typename EIGEN_MAP = Eigen::Map< EIGEN_MATRIX, MRPT_MAX_ALIGN_BYTES, Eigen::InnerStride<1>>>
EIGEN_MAP asEigen ()
 Get as an Eigen-compatible Eigen::Map object. More...
 
template<typename EIGEN_MATRIX = eigen_t, typename EIGEN_MAP = Eigen::Map< const EIGEN_MATRIX, MRPT_MAX_ALIGN_BYTES, Eigen::InnerStride<1>>>
EIGEN_MAP asEigen () const
 
CMatrixDynamic< float > cast_float () const
 
CMatrixDynamic< double > cast_double () const
 
CVectorDynamic< Scalarllt_solve (const CVectorDynamic< Scalar > &b) const
 Solves the linear system Ax=b, returns x, with A this symmetric matrix. More...
 
CVectorDynamic< Scalarlu_solve (const CVectorDynamic< Scalar > &b) const
 Solves the linear system Ax=b, returns x, with A this asymmetric matrix. More...
 
CMatrixDynamic< T > & mbDerived ()
 
const CMatrixDynamic< T > & mbDerived () const
 
void setDiagonal (const std::size_t N, const T value)
 Resize to NxN, set all entries to zero, except the main diagonal which is set to value More...
 
void setDiagonal (const T value)
 Set all entries to zero, except the main diagonal which is set to value More...
 
void setDiagonal (const std::vector< T > &diags)
 Resizes to NxN, with N the length of the input vector, set all entries to zero, except the main diagonal which is set to values in the vector. More...
 
void setIdentity ()
 
void setIdentity (const std::size_t N)
 
void matProductOf_AB (const CMatrixDynamic< T > &A, const CMatrixDynamic< T > &B)
 this = A*B, with A & B of the same type of this. More...
 
CMatrixDynamic< T > & mvbDerived ()
 
const CMatrixDynamic< T > & mvbDerived () const
 
RTTI classes and functions for polymorphic hierarchies
mrpt::rtti::CObject::Ptr duplicateGetSmartPtr () const
 Makes a deep copy of the object and returns a smart pointer to it. More...
 
Operations that DO require `#include <Eigen/Dense>` in user code
auto col (int colIdx)
 
auto col (int colIdx) const
 
auto row (int rowIdx)
 
auto row (int rowIdx) const
 
void extractRow (int rowIdx, VECTOR_LIKE &v) const
 
VECTOR_LIKE extractRow (int rowIdx) const
 
void extractColumn (int colIdx, VECTOR_LIKE &v) const
 
VECTOR_LIKE extractColumn (int colIdx) const
 
Standalone operations (do NOT require `#include <Eigen/Dense>`)
det () const
 Determinant of matrix. More...
 
CMatrixDynamic< T > inverse () const
 Returns the inverse of a general matrix using LU. More...
 
CMatrixDynamic< T > inverse_LLt () const
 Returns the inverse of a symmetric matrix using LLt. More...
 
int rank (T threshold=0) const
 Finds the rank of the matrix via LU decomposition. More...
 
bool chol (CMatrixDynamic< T > &U) const
 Cholesky M=UT * U decomposition for symmetric matrix (upper-half of the matrix is actually ignored. More...
 
bool eig (CMatrixDynamic< T > &eVecs, std::vector< T > &eVals, bool sorted=true) const
 Computes the eigenvectors and eigenvalues for a square, general matrix. More...
 
bool eig_symmetric (CMatrixDynamic< T > &eVecs, std::vector< T > &eVals, bool sorted=true) const
 Read: eig() More...
 
maximumDiagonal () const
 Returns the maximum value in the diagonal. More...
 
minimumDiagonal () const
 Returns the minimum value in the diagonal. More...
 
trace () const
 Returns the trace of the matrix (not necessarily square). More...
 
void unsafeRemoveColumns (const std::vector< std::size_t > &idxs)
 Removes columns of the matrix. More...
 
void removeColumns (const std::vector< std::size_t > &idxsToRemove)
 Removes columns of the matrix. More...
 
void unsafeRemoveRows (const std::vector< std::size_t > &idxs)
 Removes rows of the matrix. More...
 
void removeRows (const std::vector< std::size_t > &idxsToRemove)
 Removes rows of the matrix. More...
 
void insertMatrix (const int row_start, const int col_start, const OTHERMATVEC &submat)
 Copies the given input submatrix/vector into this matrix/vector, starting at the given top-left coordinates. More...
 
void insertMatrixTransposed (const int row_start, const int col_start, const OTHERMATVEC &submat)
 Like insertMatrix(), but inserts ‘submat’` (transposed) More...
 
CMatrixFixed< T, BLOCK_ROWS, BLOCK_COLS > blockCopy (int start_row=0, int start_col=0) const
 const blockCopy(): Returns a copy of the given block More...
 
CMatrixDynamic< T > blockCopy (int start_row, int start_col, int BLOCK_ROWS, int BLOCK_COLS) const
 const blockCopy(): Returns a copy of the given block (non templated version, dynamic sizes) More...
 
CMatrixFixed< T, BLOCK_ROWS, BLOCK_COLS > extractMatrix (const int start_row=0, const int start_col=0) const
 
CMatrixDynamic< T > extractMatrix (const int BLOCK_ROWS, const int BLOCK_COLS, const int start_row, const int start_col) const
 
void matProductOf_AAt (const MAT_A &A)
 this = A * AT More...
 
void matProductOf_AtA (const MAT_A &A)
 this = AT * A More...
 
Operations that DO require `#include <Eigen/Dense>` in user code
auto block (int start_row, int start_col)
 non-const block(): Returns an Eigen::Block reference to the block More...
 
auto block (int start_row, int start_col, int BLOCK_ROWS, int BLOCK_COLS)
 
auto block (int start_row, int start_col, int BLOCK_ROWS, int BLOCK_COLS) const
 
auto transpose ()
 
auto transpose () const
 
auto array ()
 
auto array () const
 
auto operator- () const
 
auto operator- (const MatrixVectorBase< S2, D2 > &m2) const
 
auto operator+ (const MatrixVectorBase< S2, D2 > &m2) const
 
void operator+= (const MatrixVectorBase< S2, D2 > &m2)
 
void operator-= (const MatrixVectorBase< S2, D2 > &m2)
 
auto operator* (const MatrixVectorBase< S2, D2 > &m2) const
 
auto operator* (const T s) const
 
CMatrixFixed< T, N, 1 > tail () const
 
CMatrixFixed< T, N, 1 > head () const
 
Standalone operations (do NOT require `#include <Eigen/Dense>`)
CMatrixDynamic< T > operator- (const CMatrixDynamic< T > &m2) const
 
CMatrixDynamic< T > operator+ (const CMatrixDynamic< T > &m2) const
 
void operator+= (T s)
 
void operator+= (const CMatrixDynamic< T > &m2)
 
void operator-= (T s)
 
void operator-= (const CMatrixDynamic< T > &m2)
 
CMatrixDynamic< T > operator* (const CMatrixDynamic< T > &v)
 
CMatrixDynamic< T > operator* (const CMatrixDynamic< T > &m2) const
 
T & coeffRef (int r, int c)
 
const T & coeff (int r, int c) const
 
minCoeff () const
 Minimum value in the matrix/vector. More...
 
minCoeff (std::size_t &outIndexOfMin) const
 
minCoeff (std::size_t &rowIdx, std::size_t &colIdx) const
 
maxCoeff () const
 Maximum value in the matrix/vector. More...
 
maxCoeff (std::size_t &outIndexOfMax) const
 
maxCoeff (std::size_t &rowIdx, std::size_t &colIdx) const
 
bool isSquare () const
 returns true if matrix is NxN More...
 
bool empty () const
 returns true if matrix/vector has size=0 More...
 
norm_inf () const
 Compute the norm-infinite of a vector ($f[ ||{v}||_ $f]), ie the maximum absolute value of the elements. More...
 
norm () const
 Compute the L2 norm of a vector/array/matrix (the Euclidean distance to the origin, taking all the elements as a single vector). More...
 
void operator*= (T s)
 
dot (const CVectorDynamic< T > &v) const
 dot product of this \cdot v More...
 
dot (const MatrixVectorBase< T, CMatrixDynamic< T > > &v) const
 
void matProductOf_Ab (const CMatrixDynamic< T > &A, const CVectorDynamic< T > &b)
 this = A * b , with A and b a dynamic matrix & vector More...
 
void matProductOf_Atb (const CMatrixDynamic< T > &A, const CVectorDynamic< T > &b)
 this = AT * b , with A and b a dynamic matrix & vector More...
 
sum () const
 Sum of all elements in matrix/vector. More...
 
sum_abs () const
 Sum of the absolute value of all elements in matrix/vector. More...
 
std::string asString () const
 Returns a string representation of the vector/matrix, using Eigen's default settings. More...
 
bool fromMatlabStringFormat (const std::string &s, mrpt::optional_ref< std::ostream > dump_errors_here=std::nullopt)
 Reads a matrix from a string in Matlab-like format, for example: "[1 0 2; 0 4 -1]" The string must start with '[' and end with ']'. More...
 
std::string inMatlabFormat (const std::size_t decimal_digits=6) const
 Exports the matrix as a string compatible with Matlab/Octave. More...
 
void saveToTextFile (const std::string &file, mrpt::math::TMatrixTextFileFormat fileFormat=mrpt::math::MATRIX_FORMAT_ENG, bool appendMRPTHeader=false, const std::string &userHeader=std::string()) const
 Saves the vector/matrix to a file compatible with MATLAB/Octave text format. More...
 
void loadFromTextFile (std::istream &f)
 Loads a vector/matrix from a text file, compatible with MATLAB text format. More...
 
void loadFromTextFile (const std::string &file)
 
bool operator== (const OTHERMATVEC &o) const
 
bool operator!= (const OTHERMATVEC &o) const
 

Static Public Member Functions

static CMatrixDynamic< T > Identity ()
 
static CMatrixDynamic< T > Identity (const std::size_t N)
 

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
 Serialize CSerializable Object to CSchemeArchiveBase derived object. More...
 
void serializeFrom (mrpt::serialization::CArchive &in, uint8_t serial_version) override
 Serialize CSchemeArchiveBase derived object to CSerializable Object. More...
 
CSerializable virtual methods
virtual void serializeTo (CSchemeArchiveBase &out) const
 Virtual method for writing (serializing) to an abstract schema based archive. More...
 
virtual void serializeFrom (CSchemeArchiveBase &in)
 Virtual method for reading (deserializing) from an abstract schema based archive. More...
 

Matrix type definitions

using value_type = T
 The type of the matrix elements. More...
 
using Scalar = T
 
using Index = int
 
using reference = T &
 
using const_reference = const T &
 
using size_type = int
 
using difference_type = std::ptrdiff_t
 
using eigen_t = Eigen::Matrix< T, RowsAtCompileTime, ColsAtCompileTime, StorageOrder, RowsAtCompileTime, ColsAtCompileTime >
 
static constexpr int RowsAtCompileTime = -1
 
static constexpr int ColsAtCompileTime = -1
 
static constexpr int SizeAtCompileTime = -1
 
static constexpr int is_mrpt_type = 1
 
static constexpr int StorageOrder = 1
 

Iterators interface

using iterator = typename vec_t::iterator
 
using const_iterator = typename vec_t::const_iterator
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
const_iterator cbegin () const
 
const_iterator cend () const
 

RTTI stuff

using Ptr = std::shared_ptr< mrpt::math ::CMatrixF >
 
using ConstPtr = std::shared_ptr< const mrpt::math ::CMatrixF >
 
using UniquePtr = std::unique_ptr< mrpt::math ::CMatrixF >
 
using ConstUniquePtr = std::unique_ptr< const mrpt::math ::CMatrixF >
 
static const mrpt::rtti::TRuntimeClassId runtimeClassId
 
static constexpr const char * className = "mrpt::math" "::" "CMatrixF"
 
static const mrpt::rtti::TRuntimeClassId_GetBaseClass ()
 
static constexpr auto getClassName ()
 
static const mrpt::rtti::TRuntimeClassIdGetRuntimeClassIdStatic ()
 
static std::shared_ptr< CObjectCreateObject ()
 
template<typename... Args>
static Ptr Create (Args &&... args)
 
template<typename Alloc , typename... Args>
static Ptr CreateAlloc (const Alloc &alloc, 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...
 

Initialization methods

static CMatrixDynamic< T > Constant (const T value)
 
static CMatrixDynamic< T > Constant (size_t nrows, size_t ncols, const T value)
 
static CMatrixDynamic< T > Zero ()
 
static CMatrixDynamic< T > Zero (size_t nrows, size_t ncols)
 
void fill (const T &val)
 
void setConstant (const T value)
 
void setConstant (size_t nrows, size_t ncols, const T value)
 
void setConstant (size_t nrows, const T value)
 
void assign (const std::size_t N, const T value)
 
void setZero ()
 
void setZero (size_t nrows, size_t ncols)
 
void setZero (size_t nrows)
 

Member Typedef Documentation

◆ const_iterator

template<class T>
using mrpt::math::CMatrixDynamic< T >::const_iterator = typename vec_t::const_iterator
inherited

Definition at line 74 of file CMatrixDynamic.h.

◆ const_reference

template<class T>
using mrpt::math::CMatrixDynamic< T >::const_reference = const T&
inherited

Definition at line 58 of file CMatrixDynamic.h.

◆ ConstPtr

Definition at line 24 of file CMatrixF.h.

◆ ConstUniquePtr

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

Definition at line 24 of file CMatrixF.h.

◆ difference_type

template<class T>
using mrpt::math::CMatrixDynamic< T >::difference_type = std::ptrdiff_t
inherited

Definition at line 60 of file CMatrixDynamic.h.

◆ eigen_t

Definition at line 68 of file CMatrixDynamic.h.

◆ Index

template<class T>
using mrpt::math::CMatrixDynamic< T >::Index = int
inherited

Definition at line 56 of file CMatrixDynamic.h.

◆ iterator

template<class T>
using mrpt::math::CMatrixDynamic< T >::iterator = typename vec_t::iterator
inherited

Definition at line 73 of file CMatrixDynamic.h.

◆ Ptr

A type for the associated smart pointer

Definition at line 24 of file CMatrixF.h.

◆ reference

template<class T>
using mrpt::math::CMatrixDynamic< T >::reference = T&
inherited

Definition at line 57 of file CMatrixDynamic.h.

◆ Scalar

template<class T>
using mrpt::math::CMatrixDynamic< T >::Scalar = T
inherited

Definition at line 55 of file CMatrixDynamic.h.

◆ size_type

template<class T>
using mrpt::math::CMatrixDynamic< T >::size_type = int
inherited

Definition at line 59 of file CMatrixDynamic.h.

◆ UniquePtr

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

Definition at line 24 of file CMatrixF.h.

◆ value_type

template<class T>
using mrpt::math::CMatrixDynamic< T >::value_type = T
inherited

The type of the matrix elements.

Definition at line 54 of file CMatrixDynamic.h.

Constructor & Destructor Documentation

◆ CMatrixF() [1/5]

mrpt::math::CMatrixF::CMatrixF ( )
inline

Constructor.

Definition at line 29 of file CMatrixF.h.

◆ CMatrixF() [2/5]

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

Constructor.

Definition at line 32 of file CMatrixF.h.

◆ CMatrixF() [3/5]

mrpt::math::CMatrixF::CMatrixF ( const CMatrixFloat m)
inlineexplicit

Copy constructor.

Definition at line 35 of file CMatrixF.h.

◆ CMatrixF() [4/5]

mrpt::math::CMatrixF::CMatrixF ( const CMatrixDynamic< double > &  m)
inlineexplicit

Copy constructor.

Definition at line 38 of file CMatrixF.h.

◆ CMatrixF() [5/5]

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

Constructor from any other Eigen class

Definition at line 59 of file CMatrixF.h.

Member Function Documentation

◆ _GetBaseClass()

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

◆ appendCol()

template<class T>
template<typename VECTOR >
void mrpt::math::CMatrixDynamic< T >::appendCol ( const VECTOR &  in)
inlineinherited

Appends a new column to the matrix from a vector.

The length of the vector must match the number of rows of the matrix, unless it is (0,0).

Exceptions
std::exceptionOn size mismatch.
See also
extractCol
appendRow

Definition at line 510 of file CMatrixDynamic.h.

◆ appendRow()

template<class T>
template<typename VECTOR >
void mrpt::math::CMatrixDynamic< T >::appendRow ( const VECTOR &  in)
inlineinherited

Appends a new row to the MxN matrix from a 1xN vector.

The lenght of the vector must match the width of the matrix, unless it's empty: in that case the matrix is resized to 1xN.

CVectorDouble v(7),w(7);
// ...
M.appendRow(v);
M.appendRow(w);
Exceptions
std::exceptionOn incorrect vector length.
See also
extractRow
appendCol

Definition at line 477 of file CMatrixDynamic.h.

◆ array() [1/2]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::array ( )
inlineinherited

Definition at line 170 of file MatrixVectorBase.h.

◆ array() [2/2]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::array ( ) const
inlineinherited

Definition at line 175 of file MatrixVectorBase.h.

◆ asEigen() [1/2]

template<class T>
template<typename EIGEN_MATRIX = eigen_t, typename EIGEN_MAP = Eigen::Map< EIGEN_MATRIX, MRPT_MAX_ALIGN_BYTES, Eigen::InnerStride<1>>>
EIGEN_MAP mrpt::math::CMatrixDynamic< T >::asEigen ( )
inlineinherited

◆ asEigen() [2/2]

template<class T>
template<typename EIGEN_MATRIX = eigen_t, typename EIGEN_MAP = Eigen::Map< const EIGEN_MATRIX, MRPT_MAX_ALIGN_BYTES, Eigen::InnerStride<1>>>
EIGEN_MAP mrpt::math::CMatrixDynamic< T >::asEigen ( ) const
inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 553 of file CMatrixDynamic.h.

◆ assign()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::assign ( const std::size_t  N,
const T  value 
)
inlineinherited

Definition at line 106 of file MatrixVectorBase.h.

◆ asString()

std::string mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::asString ( ) const
inherited

Returns a string representation of the vector/matrix, using Eigen's default settings.

Definition at line 337 of file MatrixVectorBase_impl.h.

◆ asVector()

template<class T>
template<typename VECTOR >
void mrpt::math::CMatrixDynamic< T >::asVector ( VECTOR &  out) const
inlineinherited

Returns a vector containing the matrix's values.

Definition at line 528 of file CMatrixDynamic.h.

◆ begin() [1/2]

template<class T>
iterator mrpt::math::CMatrixDynamic< T >::begin ( )
inlineinherited

Definition at line 75 of file CMatrixDynamic.h.

Referenced by mrpt::obs::CObservation3DRangeScan::load(), and mrpt::obs::CObservation3DRangeScan::rangeImage_convertToExternalStorage().

Here is the caller graph for this function:

◆ begin() [2/2]

template<class T>
const_iterator mrpt::math::CMatrixDynamic< T >::begin ( ) const
inlineinherited

Definition at line 77 of file CMatrixDynamic.h.

◆ block() [1/3]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::block ( int  start_row,
int  start_col 
)
inlineinherited

non-const block(): Returns an Eigen::Block reference to the block

Definition at line 138 of file MatrixVectorBase.h.

◆ block() [2/3]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::block ( int  start_row,
int  start_col,
int  BLOCK_ROWS,
int  BLOCK_COLS 
)
inlineinherited

Definition at line 145 of file MatrixVectorBase.h.

◆ block() [3/3]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::block ( int  start_row,
int  start_col,
int  BLOCK_ROWS,
int  BLOCK_COLS 
) const
inlineinherited

Definition at line 151 of file MatrixVectorBase.h.

◆ blockCopy() [1/2]

CMatrixFixed<T , BLOCK_ROWS, BLOCK_COLS> mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::blockCopy ( int  start_row = 0,
int  start_col = 0 
) const
inlineinherited

const blockCopy(): Returns a copy of the given block

Definition at line 233 of file MatrixBase.h.

◆ blockCopy() [2/2]

CMatrixDynamic<T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::blockCopy ( int  start_row,
int  start_col,
int  BLOCK_ROWS,
int  BLOCK_COLS 
) const
inlineinherited

const blockCopy(): Returns a copy of the given block (non templated version, dynamic sizes)

Definition at line 240 of file MatrixBase.h.

◆ cast_double()

template<typename T >
CMatrixDynamic< double > CMatrixDynamic::cast_double ( ) const
inherited

Definition at line 26 of file CMatrixDynamic.cpp.

Referenced by mrpt::obs::CObservationImage::serializeFrom().

Here is the caller graph for this function:

◆ cast_float()

template<typename T >
CMatrixDynamic< float > CMatrixDynamic::cast_float ( ) const
inherited

Definition at line 19 of file CMatrixDynamic.cpp.

◆ cbegin()

template<class T>
const_iterator mrpt::math::CMatrixDynamic< T >::cbegin ( ) const
inlineinherited

Definition at line 79 of file CMatrixDynamic.h.

◆ cend()

template<class T>
const_iterator mrpt::math::CMatrixDynamic< T >::cend ( ) const
inlineinherited

Definition at line 80 of file CMatrixDynamic.h.

◆ chol()

bool mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::chol ( CMatrixDynamic< T > &  U) const
inherited

Cholesky M=UT * U decomposition for symmetric matrix (upper-half of the matrix is actually ignored.

Returns
false if Cholesky fails

Definition at line 165 of file MatrixBase_impl.h.

◆ clone()

virtual mrpt::rtti::CObject* mrpt::math::CMatrixF::clone ( ) const
overridevirtual

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

Implements mrpt::rtti::CObject.

◆ coeff()

const T & mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::coeff ( int  r,
int  c 
) const
inlineinherited

Definition at line 244 of file MatrixVectorBase.h.

◆ coeffRef()

T & mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::coeffRef ( int  r,
int  c 
)
inlineinherited

Definition at line 243 of file MatrixVectorBase.h.

◆ col() [1/2]

auto mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::col ( int  colIdx)
inlineinherited

◆ col() [2/2]

auto mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::col ( int  colIdx) const
inlineinherited

Definition at line 94 of file MatrixBase.h.

◆ cols()

template<class T>
size_type mrpt::math::CMatrixDynamic< T >::cols ( ) const
inlineinherited

Number of columns in the matrix.

See also
rows()

Definition at line 340 of file CMatrixDynamic.h.

Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::vision::checkerBoardStereoCalibration(), mrpt::detectors::CFaceDetection::checkIfFaceRegions(), mrpt::opengl::CVectorField2D::cols(), mrpt::opengl::CVectorField3D::cols(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::computeDominantEigenVector(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::obs::detail::cost_func(), mrpt::poses::CPose3D::CPose3D(), mrpt::math::cross_correlation_FFT(), mrpt::slam::data_association_full_covariance(), mrpt::slam::data_association_independent_predictions(), mrpt::math::dft2_complex(), mrpt::math::dft2_real(), mrpt::random::CRandomGenerator::drawGaussianMultivariate(), mrpt::random::CRandomGenerator::drawGaussianMultivariateMany(), mrpt::obs::CObservation2DRangeScanWithUncertainty::evaluateScanLikelihood(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::maps::CRandomFieldGridMap2D::exist_relation_between2cells(), mrpt::poses::CPoint< CPoint3D, 3 >::fromString(), mrpt::math::TTwist2D::fromString(), mrpt::math::TPose3DQuat::fromString(), mrpt::math::TPose2D::fromString(), mrpt::math::TTwist3D::fromString(), mrpt::math::TPoint2D_< double >::fromString(), mrpt::math::TPose3D::fromString(), mrpt::math::TPoint3D_< float >::fromString(), mrpt::poses::CPose3DQuat::fromString(), mrpt::poses::CPose2D::fromString(), mrpt::poses::CPose3D::fromString(), mrpt::vision::generateMask(), mrpt::img::CImage::getAsMatrix(), mrpt::img::CImage::getAsMatrixTiled(), mrpt::img::CImage::getAsRGBMatrices(), mrpt::opengl::CVectorField3D::getBoundingBox(), mrpt::apps::MonteCarloLocalization_Base::getGroundTruth(), mrpt::math::idft2_complex(), mrpt::math::idft2_real(), mrpt::maps::CRandomFieldGridMap2D::insertObservation_KF(), mrpt::maps::CRandomFieldGridMap2D::insertObservation_KF2(), mrpt::vision::CFeature::internal_distanceBetweenPolarImages(), mrpt::nav::PlannerTPS_VirtualBase::internal_loadConfig_PTG(), mrpt::obs::CObservation3DRangeScan::load(), mrpt::poses::CPoseInterpolatorBase< 3 >::loadFromTextFile(), mrpt::math::mahalanobisDistance2(), mrpt::math::mahalanobisDistance2AndLogPDF(), mrpt::math::MATLAB_plotCovariance2D(), mempool_donate_range_matrix(), myGeneralDFT(), mrpt::vision::normalizeImage(), mrpt::math::normalPDF(), mrpt::opengl::CVectorField3D::onUpdateBuffers_Points(), mrpt::opengl::CVectorField3D::onUpdateBuffers_Wireframe(), mrpt::math::operator>>(), mrpt::topography::path_from_rtk_gps(), mrpt::apps::MonteCarloLocalization_Base::prepareGT(), mrpt::slam::CRangeBearingKFSLAM::processActionObservation(), mrpt::obs::detail::range2XYZ_LUT(), mrpt::obs::CObservation3DRangeScan::rangeImage_convertToExternalStorage(), mrpt::obs::CObservation3DRangeScan::rangeImageAsImage(), mrpt::math::ransac2Dline_distance(), mrpt::math::ransac3Dplane_distance(), mrpt::obs::CObservation3DRangeScan::recoverCameraCalibrationParameters(), mrpt::maps::CRandomFieldGridMap2D::resize(), mrpt::apps::KFSLAMApp::Run_KF_SLAM(), mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::runOneKalmanIteration(), mrpt::math::CMatrixB::serializeFrom(), mrpt::obs::CObservationImage::serializeFrom(), mrpt::math::CMatrixB::serializeTo(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::setFromMatrixLike(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::setRow(), mrpt::opengl::CVectorField2D::setVectorField(), mrpt::opengl::CVectorField3D::setVectorField(), TEST(), mrpt::obs::CObservation3DRangeScan::undistort(), and mrpt::obs::detail::unprojectInto().

Here is the caller graph for this function:

◆ conservativeResize()

template<class T>
void mrpt::math::CMatrixDynamic< T >::conservativeResize ( size_t  row,
size_t  col 
)
inlineinherited

Definition at line 370 of file CMatrixDynamic.h.

◆ Constant() [1/2]

static CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::Constant ( const T  value)
inlinestaticinherited

Definition at line 89 of file MatrixVectorBase.h.

◆ Constant() [2/2]

static CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::Constant ( size_t  nrows,
size_t  ncols,
const T  value 
)
inlinestaticinherited

Definition at line 99 of file MatrixVectorBase.h.

◆ Create()

template<typename... Args>
static Ptr mrpt::math::CMatrixF::Create ( Args &&...  args)
inlinestatic

Definition at line 24 of file CMatrixF.h.

◆ CreateAlloc()

template<typename Alloc , typename... Args>
static Ptr mrpt::math::CMatrixF::CreateAlloc ( const Alloc &  alloc,
Args &&...  args 
)
inlinestatic

Definition at line 24 of file CMatrixF.h.

◆ CreateObject()

static std::shared_ptr<CObject> mrpt::math::CMatrixF::CreateObject ( )
static

◆ CreateUnique()

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

Definition at line 24 of file CMatrixF.h.

◆ data() [1/2]

template<class T>
const T* mrpt::math::CMatrixDynamic< T >::data ( ) const
inlineinherited

Return raw pointer to row-major data buffer.

All matrix cells can be assumed to be stored contiguously in memory, i.e. row stride = column count.

Definition at line 375 of file CMatrixDynamic.h.

Referenced by mrpt::obs::CObservation3DRangeScan::load(), mrpt::obs::CObservation3DRangeScan::rangeImage_convertToExternalStorage(), and mrpt::obs::CObservation3DRangeScan::undistort().

Here is the caller graph for this function:

◆ data() [2/2]

template<class T>
T* mrpt::math::CMatrixDynamic< T >::data ( )
inlineinherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 381 of file CMatrixDynamic.h.

◆ derived() [1/2]

template<class T>
CMatrixDynamic& mrpt::math::CMatrixDynamic< T >::derived ( )
inlineinherited

Definition at line 368 of file CMatrixDynamic.h.

◆ derived() [2/2]

template<class T>
const CMatrixDynamic& mrpt::math::CMatrixDynamic< T >::derived ( ) const
inlineinherited

Definition at line 369 of file CMatrixDynamic.h.

◆ det()

T mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::det ( ) const
inherited

Determinant of matrix.

Definition at line 76 of file MatrixBase_impl.h.

Referenced by mrpt::slam::joint_pdf_metric(), and mrpt::math::productIntegralTwoGaussians().

◆ dot() [1/2]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::dot ( const CVectorDynamic< T > &  v) const
inherited

dot product of this \cdot v

Definition at line 511 of file MatrixVectorBase_impl.h.

◆ dot() [2/2]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::dot ( const MatrixVectorBase< T , CMatrixDynamic< T > > &  v) const
inherited

Definition at line 524 of file MatrixVectorBase_impl.h.

◆ duplicateGetSmartPtr()

mrpt::rtti::CObject::Ptr CObject::duplicateGetSmartPtr ( ) const
inlineinherited

Makes a deep copy of the object and returns a smart pointer to it.

Definition at line 204 of file CObject.h.

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

Referenced by mrpt::obs::CRawlog::insert().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ eig()

bool mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::eig ( CMatrixDynamic< T > &  eVecs,
std::vector< T > &  eVals,
bool  sorted = true 
) const
inherited

Computes the eigenvectors and eigenvalues for a square, general matrix.

Use eig_symmetric() for symmetric matrices for better accuracy and performance. Eigenvectors are the columns of the returned matrix, and their order matches that of returned eigenvalues.

Parameters
[in]sortedIf true, eigenvalues (and eigenvectors) will be sorted in ascending order.
[out]eVecsThe container where eigenvectors will be stored.
[out]eValsThe container where eigenvalues will be stored.
Returns
false if eigenvalues could not be determined.

Definition at line 107 of file MatrixBase_impl.h.

◆ eig_symmetric()

bool mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::eig_symmetric ( CMatrixDynamic< T > &  eVecs,
std::vector< T > &  eVals,
bool  sorted = true 
) const
inherited

Read: eig()

Note
This only uses the lower-triangular part of the matrix

Definition at line 131 of file MatrixBase_impl.h.

◆ empty()

bool mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::empty ( ) const
inlineinherited

returns true if matrix/vector has size=0

Definition at line 260 of file MatrixVectorBase.h.

◆ end() [1/2]

template<class T>
iterator mrpt::math::CMatrixDynamic< T >::end ( )
inlineinherited

Definition at line 76 of file CMatrixDynamic.h.

◆ end() [2/2]

template<class T>
const_iterator mrpt::math::CMatrixDynamic< T >::end ( ) const
inlineinherited

Definition at line 78 of file CMatrixDynamic.h.

◆ extractColumn() [1/2]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractColumn ( int  colIdx,
VECTOR_LIKE &  v 
) const
inlineinherited

Definition at line 128 of file MatrixBase.h.

◆ extractColumn() [2/2]

VECTOR_LIKE mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractColumn ( int  colIdx) const
inlineinherited

Definition at line 136 of file MatrixBase.h.

◆ extractMatrix() [1/2]

CMatrixFixed<T , BLOCK_ROWS, BLOCK_COLS> mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractMatrix ( const int  start_row = 0,
const int  start_col = 0 
) const
inlineinherited

Definition at line 247 of file MatrixBase.h.

◆ extractMatrix() [2/2]

CMatrixDynamic<T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractMatrix ( const int  BLOCK_ROWS,
const int  BLOCK_COLS,
const int  start_row,
const int  start_col 
) const
inlineinherited

Definition at line 260 of file MatrixBase.h.

◆ extractRow() [1/2]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractRow ( int  rowIdx,
VECTOR_LIKE &  v 
) const
inlineinherited

Definition at line 112 of file MatrixBase.h.

◆ extractRow() [2/2]

VECTOR_LIKE mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::extractRow ( int  rowIdx) const
inlineinherited

Definition at line 120 of file MatrixBase.h.

◆ fill()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::fill ( const T &  val)
inlineinherited

Fill all the elements with a given value (Note: named "fillAll" since "fill" will be used by child classes)

Definition at line 70 of file MatrixVectorBase.h.

◆ fromMatlabStringFormat()

bool mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::fromMatlabStringFormat ( const std::string &  s,
mrpt::optional_ref< std::ostream >  dump_errors_here = std::nullopt 
)
inherited

Reads a matrix from a string in Matlab-like format, for example: "[1 0 2; 0 4 -1]" The string must start with '[' and end with ']'.

Rows are separated by semicolons ';' and columns in each row by one or more whitespaces ' ' or tabs ''. Commas ',' between elements are NOT allowed.

This format is also used for CConfigFile::read_matrix.

Returns
true on success. false if the string is malformed, and then the matrix will be resized to 0x0.
See also
inMatlabFormat, CConfigFile::read_matrix

Definition at line 24 of file MatrixVectorBase_impl.h.

Referenced by mrpt::math::TPoint2D_< double >::fromString(), and mrpt::math::TPoint3D_< float >::fromString().

◆ getClassName()

static constexpr auto mrpt::math::CMatrixF::getClassName ( )
inlinestatic

Definition at line 24 of file CMatrixF.h.

◆ GetRuntimeClass()

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

◆ head()

CMatrixFixed<T , N, 1> mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::head ( ) const
inlineinherited

Definition at line 232 of file MatrixVectorBase.h.

◆ Identity() [1/2]

static CMatrixDynamic< T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::Identity ( )
inlinestaticinherited

Definition at line 64 of file MatrixBase.h.

Referenced by TEST().

◆ Identity() [2/2]

static CMatrixDynamic< T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::Identity ( const std::size_t  N)
inlinestaticinherited

Definition at line 74 of file MatrixBase.h.

◆ inMatlabFormat()

std::string mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::inMatlabFormat ( const std::size_t  decimal_digits = 6) const
inherited

Exports the matrix as a string compatible with Matlab/Octave.

See also
fromMatlabStringFormat()

Definition at line 141 of file MatrixVectorBase_impl.h.

◆ insertMatrix()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::insertMatrix ( const int  row_start,
const int  col_start,
const OTHERMATVEC &  submat 
)
inlineinherited

Copies the given input submatrix/vector into this matrix/vector, starting at the given top-left coordinates.

Definition at line 210 of file MatrixBase.h.

◆ insertMatrixTransposed()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::insertMatrixTransposed ( const int  row_start,
const int  col_start,
const OTHERMATVEC &  submat 
)
inlineinherited

Like insertMatrix(), but inserts ‘submat’` (transposed)

Definition at line 221 of file MatrixBase.h.

◆ inverse()

CMatrixDynamic< T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::inverse ( ) const
inherited

Returns the inverse of a general matrix using LU.

Definition at line 183 of file MatrixBase_impl.h.

◆ inverse_LLt()

CMatrixDynamic< T > mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::inverse_LLt ( ) const
inherited

Returns the inverse of a symmetric matrix using LLt.

Definition at line 195 of file MatrixBase_impl.h.

Referenced by mrpt::slam::joint_pdf_metric(), mrpt::math::leastSquareLinearFit(), and mrpt::math::productIntegralTwoGaussians().

◆ isSquare()

bool mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::isSquare ( ) const
inlineinherited

returns true if matrix is NxN

Definition at line 257 of file MatrixVectorBase.h.

◆ llt_solve()

template<typename T >
CVectorDynamic< T > CMatrixDynamic::llt_solve ( const CVectorDynamic< Scalar > &  b) const
inherited

Solves the linear system Ax=b, returns x, with A this symmetric matrix.

See also
lu_solve()

Definition at line 34 of file CMatrixDynamic.cpp.

◆ loadFromTextFile() [1/2]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::loadFromTextFile ( std::istream &  f)
inherited

Loads a vector/matrix from a text file, compatible with MATLAB text format.

Lines starting with '' or '#' are interpreted as comments and ignored.

Exceptions
std::runtime_errorOn format error.
See also
saveToTextFile, fromMatlabStringFormat

Definition at line 238 of file MatrixVectorBase_impl.h.

◆ loadFromTextFile() [2/2]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::loadFromTextFile ( const std::string &  file)
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 326 of file MatrixVectorBase_impl.h.

◆ lu_solve()

template<typename T >
CVectorDynamic< T > CMatrixDynamic::lu_solve ( const CVectorDynamic< Scalar > &  b) const
inherited

Solves the linear system Ax=b, returns x, with A this asymmetric matrix.

See also
llt_solve()

Definition at line 40 of file CMatrixDynamic.cpp.

◆ matProductOf_AAt()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::matProductOf_AAt ( const MAT_A &  A)
inlineinherited

this = A * AT

Definition at line 276 of file MatrixBase.h.

Referenced by mrpt::math::leastSquareLinearFit().

◆ matProductOf_AB()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::matProductOf_AB ( const CMatrixDynamic< T > &  A,
const CMatrixDynamic< T > &  B 
)
inherited

this = A*B, with A & B of the same type of this.

For products of different matrix types, use the regular * operator (which requires the <Eigen/Dense> header)

Definition at line 175 of file MatrixBase_impl.h.

◆ matProductOf_Ab()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::matProductOf_Ab ( const CMatrixDynamic< T > &  A,
const CVectorDynamic< T > &  b 
)
inherited

this = A * b , with A and b a dynamic matrix & vector

Definition at line 485 of file MatrixVectorBase_impl.h.

Referenced by mrpt::math::leastSquareLinearFit().

◆ matProductOf_AtA()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::matProductOf_AtA ( const MAT_A &  A)
inlineinherited

this = AT * A

Definition at line 295 of file MatrixBase.h.

◆ matProductOf_Atb()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::matProductOf_Atb ( const CMatrixDynamic< T > &  A,
const CVectorDynamic< T > &  b 
)
inherited

this = AT * b , with A and b a dynamic matrix & vector

Definition at line 492 of file MatrixVectorBase_impl.h.

◆ maxCoeff() [1/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::maxCoeff ( ) const
inherited

Maximum value in the matrix/vector.

Definition at line 363 of file MatrixVectorBase_impl.h.

◆ maxCoeff() [2/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::maxCoeff ( std::size_t &  outIndexOfMax) const
inherited

Definition at line 384 of file MatrixVectorBase_impl.h.

◆ maxCoeff() [3/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::maxCoeff ( std::size_t &  rowIdx,
std::size_t &  colIdx 
) const
inherited

Definition at line 409 of file MatrixVectorBase_impl.h.

◆ maximumDiagonal()

T mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::maximumDiagonal ( ) const
inherited

Returns the maximum value in the diagonal.

Definition at line 207 of file MatrixBase_impl.h.

◆ mbDerived() [1/2]

CMatrixDynamic< T > & mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::mbDerived ( )
inlineinherited

Definition at line 26 of file MatrixBase.h.

◆ mbDerived() [2/2]

const CMatrixDynamic< T > & mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::mbDerived ( ) const
inlineinherited

Definition at line 27 of file MatrixBase.h.

◆ minCoeff() [1/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::minCoeff ( ) const
inherited

Minimum value in the matrix/vector.

Definition at line 357 of file MatrixVectorBase_impl.h.

◆ minCoeff() [2/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::minCoeff ( std::size_t &  outIndexOfMin) const
inherited

Definition at line 369 of file MatrixVectorBase_impl.h.

◆ minCoeff() [3/3]

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::minCoeff ( std::size_t &  rowIdx,
std::size_t &  colIdx 
) const
inherited

Definition at line 398 of file MatrixVectorBase_impl.h.

◆ minimumDiagonal()

T mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::minimumDiagonal ( ) const
inherited

Returns the minimum value in the diagonal.

Definition at line 213 of file MatrixBase_impl.h.

◆ mvbDerived() [1/2]

CMatrixDynamic< T > & mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::mvbDerived ( )
inlineinherited

Definition at line 59 of file MatrixVectorBase.h.

◆ mvbDerived() [2/2]

const CMatrixDynamic< T > & mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::mvbDerived ( ) const
inlineinherited

Definition at line 60 of file MatrixVectorBase.h.

◆ norm()

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::norm ( ) const
inherited

Compute the L2 norm of a vector/array/matrix (the Euclidean distance to the origin, taking all the elements as a single vector).

See also
norm

Definition at line 505 of file MatrixVectorBase_impl.h.

◆ norm_inf()

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::norm_inf ( ) const
inherited

Compute the norm-infinite of a vector ($f[ ||{v}||_ $f]), ie the maximum absolute value of the elements.

Definition at line 499 of file MatrixVectorBase_impl.h.

◆ operator!=()

bool mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator!= ( const OTHERMATVEC &  o) const
inlineinherited

Definition at line 432 of file MatrixVectorBase.h.

◆ operator()() [1/2]

template<class T>
T& mrpt::math::CMatrixDynamic< T >::operator() ( size_t  row,
size_t  col 
)
inlineinherited

Subscript operator to get/set individual elements.

Definition at line 389 of file CMatrixDynamic.h.

◆ operator()() [2/2]

template<class T>
const T& mrpt::math::CMatrixDynamic< T >::operator() ( size_t  row,
size_t  col 
) const
inlineinherited

Subscript operator to get individual elements.

Definition at line 405 of file CMatrixDynamic.h.

◆ operator*() [1/4]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator* ( const MatrixVectorBase< S2, D2 > &  m2) const
inlineinherited

Definition at line 214 of file MatrixVectorBase.h.

◆ operator*() [2/4]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator* ( const T  s) const
inlineinherited

Definition at line 219 of file MatrixVectorBase.h.

◆ operator*() [3/4]

CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator* ( const CMatrixDynamic< T > &  v)
inherited

Definition at line 438 of file MatrixVectorBase_impl.h.

◆ operator*() [4/4]

CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator* ( const CMatrixDynamic< T > &  m2) const
inherited

Definition at line 470 of file MatrixVectorBase_impl.h.

◆ operator*=()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator*= ( s)
inherited

Definition at line 432 of file MatrixVectorBase_impl.h.

◆ operator+() [1/2]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator+ ( const MatrixVectorBase< S2, D2 > &  m2) const
inlineinherited

Definition at line 188 of file MatrixVectorBase.h.

◆ operator+() [2/2]

CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator+ ( const CMatrixDynamic< T > &  m2) const
inlineinherited

Definition at line 279 of file MatrixVectorBase.h.

◆ operator+=() [1/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator+= ( const MatrixVectorBase< S2, D2 > &  m2)
inlineinherited

Definition at line 194 of file MatrixVectorBase.h.

◆ operator+=() [2/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator+= ( s)
inherited

Definition at line 420 of file MatrixVectorBase_impl.h.

◆ operator+=() [3/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator+= ( const CMatrixDynamic< T > &  m2)
inlineinherited

Definition at line 294 of file MatrixVectorBase.h.

◆ operator-() [1/3]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator- ( ) const
inlineinherited

Definition at line 181 of file MatrixVectorBase.h.

◆ operator-() [2/3]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator- ( const MatrixVectorBase< S2, D2 > &  m2) const
inlineinherited

Definition at line 201 of file MatrixVectorBase.h.

◆ operator-() [3/3]

CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator- ( const CMatrixDynamic< T > &  m2) const
inlineinherited

Definition at line 309 of file MatrixVectorBase.h.

◆ operator-=() [1/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator-= ( const MatrixVectorBase< S2, D2 > &  m2)
inlineinherited

Definition at line 207 of file MatrixVectorBase.h.

◆ operator-=() [2/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator-= ( s)
inherited

Definition at line 426 of file MatrixVectorBase_impl.h.

◆ operator-=() [3/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator-= ( const CMatrixDynamic< T > &  m2)
inlineinherited

Definition at line 324 of file MatrixVectorBase.h.

◆ operator=() [1/2]

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

Assignment operator for float matrixes.

Definition at line 44 of file CMatrixF.h.

References mrpt::math::CMatrixDynamic< T >::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

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

Assignment operator from any other Eigen class

Definition at line 52 of file CMatrixF.h.

References mrpt::math::CMatrixDynamic< T >::operator=().

Here is the call graph for this function:

◆ operator==()

bool mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::operator== ( const OTHERMATVEC &  o) const
inlineinherited

Definition at line 422 of file MatrixVectorBase.h.

◆ operator[]() [1/2]

template<class T>
T& mrpt::math::CMatrixDynamic< T >::operator[] ( size_t  ith)
inlineinherited

Subscript operator to get/set an individual element from a row or column matrix.

Exceptions
std::exceptionIf the object is not a column or row matrix.

Definition at line 423 of file CMatrixDynamic.h.

◆ operator[]() [2/2]

template<class T>
const T& mrpt::math::CMatrixDynamic< T >::operator[] ( size_t  ith) const
inlineinherited

Subscript operator to get/set an individual element from a row or column matrix.

For non-vectors (NxM matrices), it returns the i-th matrix element, in RowMajor order.

Exceptions
std::exceptionIf the object is not a column or row matrix.

Definition at line 454 of file CMatrixDynamic.h.

◆ rank()

int mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::rank ( threshold = 0) const
inherited

Finds the rank of the matrix via LU decomposition.

Uses Eigen's default threshold unless threshold>0.

Definition at line 156 of file MatrixBase_impl.h.

◆ removeColumns()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::removeColumns ( const std::vector< std::size_t > &  idxsToRemove)
inherited

Removes columns of the matrix.

Indices may be unsorted and duplicated

Definition at line 38 of file MatrixBase_impl.h.

◆ removeRows()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::removeRows ( const std::vector< std::size_t > &  idxsToRemove)
inherited

Removes rows of the matrix.

Indices may be unsorted and duplicated

Definition at line 65 of file MatrixBase_impl.h.

◆ resize() [1/3]

template<class T>
void mrpt::math::CMatrixDynamic< T >::resize ( size_t  row,
size_t  col 
)
inlineinherited

◆ resize() [2/3]

template<class T>
void mrpt::math::CMatrixDynamic< T >::resize ( size_t  vectorLen)
inlineinherited

Resizes as a Nx1 vector.

Definition at line 359 of file CMatrixDynamic.h.

◆ resize() [3/3]

template<class T>
void mrpt::math::CMatrixDynamic< T >::resize ( const matrix_size_t siz,
bool  zeroNewElements = false 
)
inlineinherited

Resize the matrix.

Definition at line 362 of file CMatrixDynamic.h.

◆ row() [1/2]

auto mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::row ( int  rowIdx)
inlineinherited

◆ row() [2/2]

auto mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::row ( int  rowIdx) const
inlineinherited

Definition at line 105 of file MatrixBase.h.

◆ rows()

template<class T>
size_type mrpt::math::CMatrixDynamic< T >::rows ( ) const
inlineinherited

Number of rows in the matrix.

See also
rows()

Definition at line 337 of file CMatrixDynamic.h.

Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::opengl::CMeshFast::assignImageAndZ(), mrpt::opengl::CMesh::assignImageAndZ(), mrpt::detectors::CFaceDetection::checkIfFaceRegions(), mrpt::obs::CObservation3DRangeScan::convertTo2DScan(), mrpt::obs::detail::cost_func(), mrpt::poses::CPose3D::CPose3D(), mrpt::math::cross_correlation_FFT(), mrpt::slam::data_association_full_covariance(), mrpt::slam::data_association_independent_predictions(), mrpt::math::dft2_complex(), mrpt::math::dft2_real(), mrpt::apps::MonteCarloLocalization_Base::do_pf_localization(), kfslam_traits< CRangeBearingKFSLAM >::doPartitioningExperiment(), mrpt::random::CRandomGenerator::drawGaussianMultivariate(), mrpt::random::CRandomGenerator::drawGaussianMultivariateMany(), mrpt::obs::CObservation2DRangeScanWithUncertainty::evaluateScanLikelihood(), mrpt::math::RANSAC_Template< NUMTYPE >::execute(), mrpt::maps::CRandomFieldGridMap2D::exist_relation_between2cells(), mrpt::poses::CPoint< CPoint3D, 3 >::fromString(), mrpt::math::TTwist2D::fromString(), mrpt::math::TPose3DQuat::fromString(), mrpt::math::TPose2D::fromString(), mrpt::math::TTwist3D::fromString(), mrpt::math::TPoint2D_< double >::fromString(), mrpt::math::TPose3D::fromString(), mrpt::math::TPoint3D_< float >::fromString(), mrpt::poses::CPose3DQuat::fromString(), mrpt::poses::CPose2D::fromString(), mrpt::poses::CPose3D::fromString(), mrpt::vision::generateMask(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::generatePWConsistenciesMatrix(), mrpt::img::CImage::getAsMatrix(), mrpt::img::CImage::getAsMatrixTiled(), mrpt::img::CImage::getAsRGBMatrices(), mrpt::opengl::CVectorField3D::getBoundingBox(), mrpt::apps::MonteCarloLocalization_Base::getGroundTruth(), mrpt::math::idft2_complex(), mrpt::math::idft2_real(), mrpt::maps::CRandomFieldGridMap2D::insertObservation_KF(), mrpt::maps::CRandomFieldGridMap2D::insertObservation_KF2(), mrpt::vision::CFeature::internal_distanceBetweenPolarImages(), mrpt::nav::PlannerTPS_VirtualBase::internal_loadConfig_PTG(), mrpt::obs::CObservation3DRangeScan::load(), mrpt::poses::CPoseInterpolatorBase< 3 >::loadFromTextFile(), mrpt::math::MATLAB_plotCovariance2D(), mempool_donate_range_matrix(), myGeneralDFT(), mrpt::vision::normalizeImage(), mrpt::opengl::CVectorField3D::onUpdateBuffers_Points(), mrpt::opengl::CVectorField3D::onUpdateBuffers_Wireframe(), mrpt::math::operator>>(), mrpt::topography::path_from_rtk_gps(), mrpt::apps::MonteCarloLocalization_Base::prepareGT(), mrpt::obs::detail::range2XYZ_LUT(), mrpt::obs::CObservation3DRangeScan::rangeImage_convertToExternalStorage(), mrpt::obs::CObservation3DRangeScan::rangeImageAsImage(), mrpt::math::ransac3Dplane_distance(), mrpt::obs::CObservation3DRangeScan::recoverCameraCalibrationParameters(), mrpt::maps::CRandomFieldGridMap2D::resize(), mrpt::opengl::CVectorField2D::rows(), mrpt::opengl::CVectorField3D::rows(), mrpt::apps::KFSLAMApp::Run_KF_SLAM(), mrpt::math::CMatrixB::serializeFrom(), mrpt::obs::CObservationImage::serializeFrom(), mrpt::obs::CObservation3DRangeScan::serializeFrom(), mrpt::math::CMatrixB::serializeTo(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::setCol(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::setFromMatrixLike(), mrpt::opengl::CVectorField2D::setGridCenterAndCellSize(), mrpt::opengl::CVectorField3D::setPointCoordinates(), mrpt::opengl::CVectorField2D::setVectorField(), mrpt::opengl::CVectorField3D::setVectorField(), TEST(), mrpt::obs::CObservation3DRangeScan::undistort(), and mrpt::obs::detail::unprojectInto().

Here is the caller graph for this function:

◆ saveToTextFile()

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::saveToTextFile ( const std::string &  file,
mrpt::math::TMatrixTextFileFormat  fileFormat = mrpt::math::MATRIX_FORMAT_ENG,
bool  appendMRPTHeader = false,
const std::string &  userHeader = std::string() 
) const
inherited

Saves the vector/matrix to a file compatible with MATLAB/Octave text format.

Parameters
fileThe target filename.
fileFormatSee TMatrixTextFileFormat. The format of the numbers in the text file.
appendMRPTHeaderInsert this header to the file "% File generated by MRPT. Load with MATLAB with: VAR=load(FILENAME);"
userHeaderAdditional text to be written at the head of the file. Typically MALAB comments "% This file blah blah". Final end-of-line is not needed.
See also
loadFromTextFile, CMatrixDynamic::inMatlabFormat, SAVE_MATRIX

Definition at line 159 of file MatrixVectorBase_impl.h.

◆ serializeFrom() [1/2]

void CMatrixF::serializeFrom ( mrpt::serialization::CArchive in,
uint8_t  serial_version 
)
overrideprotectedvirtual

Serialize CSchemeArchiveBase derived object to CSerializable Object.

Implements mrpt::serialization::CSerializable.

Definition at line 35 of file CMatrixF.cpp.

References MRPT_THROW_UNKNOWN_SERIALIZATION_VERSION, mrpt::serialization::CArchive::ReadAs(), and mrpt::serialization::CArchive::ReadBufferFixEndianness().

Here is the call graph for this function:

◆ serializeFrom() [2/2]

virtual void mrpt::serialization::CSerializable::serializeFrom ( CSchemeArchiveBase in)
inlineprotectedvirtualinherited

Virtual method for reading (deserializing) from an abstract schema based archive.

Definition at line 74 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ serializeGetVersion()

uint8_t CMatrixF::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 CMatrixF.cpp.

◆ serializeTo() [1/2]

void CMatrixF::serializeTo ( mrpt::serialization::CArchive out) const
overrideprotectedvirtual

Serialize CSerializable Object to CSchemeArchiveBase derived object.

Implements mrpt::serialization::CSerializable.

Definition at line 24 of file CMatrixF.cpp.

References out.

◆ serializeTo() [2/2]

virtual void mrpt::serialization::CSerializable::serializeTo ( CSchemeArchiveBase out) const
inlineprotectedvirtualinherited

Virtual method for writing (serializing) to an abstract schema based archive.

Definition at line 64 of file CSerializable.h.

References mrpt::serialization::CSerializable::GetRuntimeClass(), and THROW_EXCEPTION.

Here is the call graph for this function:

◆ setCol()

template<class T>
template<typename VECTOR >
void mrpt::math::CMatrixDynamic< T >::setCol ( const Index  col,
const VECTOR &  v 
)
inlineinherited

Definition at line 496 of file CMatrixDynamic.h.

◆ setConstant() [1/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setConstant ( const T  value)
inlineinherited

Definition at line 75 of file MatrixVectorBase.h.

◆ setConstant() [2/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setConstant ( size_t  nrows,
size_t  ncols,
const T  value 
)
inlineinherited

Definition at line 76 of file MatrixVectorBase.h.

◆ setConstant() [3/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setConstant ( size_t  nrows,
const T  value 
)
inlineinherited

Definition at line 81 of file MatrixVectorBase.h.

◆ setDiagonal() [1/3]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::setDiagonal ( const std::size_t  N,
const T  value 
)
inlineinherited

Resize to NxN, set all entries to zero, except the main diagonal which is set to value

Definition at line 34 of file MatrixBase.h.

◆ setDiagonal() [2/3]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::setDiagonal ( const T  value)
inlineinherited

Set all entries to zero, except the main diagonal which is set to value

Definition at line 43 of file MatrixBase.h.

◆ setDiagonal() [3/3]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::setDiagonal ( const std::vector< T > &  diags)
inlineinherited

Resizes to NxN, with N the length of the input vector, set all entries to zero, except the main diagonal which is set to values in the vector.

Definition at line 51 of file MatrixBase.h.

◆ setFromMatrixLike()

template<class T>
template<class MAT >
void mrpt::math::CMatrixDynamic< T >::setFromMatrixLike ( const MAT &  m)
inlineinherited

Definition at line 252 of file CMatrixDynamic.h.

Referenced by mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::operator=().

Here is the caller graph for this function:

◆ setIdentity() [1/2]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::setIdentity ( )
inlineinherited

Definition at line 57 of file MatrixBase.h.

◆ setIdentity() [2/2]

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::setIdentity ( const std::size_t  N)
inlineinherited

Definition at line 62 of file MatrixBase.h.

◆ setRow()

template<class T>
template<typename VECTOR >
void mrpt::math::CMatrixDynamic< T >::setRow ( const Index  row,
const VECTOR &  v 
)
inlineinherited

Definition at line 489 of file CMatrixDynamic.h.

Referenced by mrpt::obs::CObservation3DRangeScan::points3D_convertToExternalStorage(), and mrpt::math::ransac_detect_2D_lines().

Here is the caller graph for this function:

◆ setSize()

template<class T>
void mrpt::math::CMatrixDynamic< T >::setSize ( size_t  row,
size_t  col,
bool  zeroNewElements = false 
)
inlineinherited

Changes the size of matrix, maintaining the previous contents.

Definition at line 352 of file CMatrixDynamic.h.

Referenced by mrpt::bayes::detail::addNewLandmarks(), mrpt::detectors::CFaceDetection::checkIfDiagonalSurface(), mrpt::detectors::CFaceDetection::checkIfFaceRegions(), mrpt::slam::TDataAssociationResults::clear(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::conservativeResize(), mrpt::math::cross_correlation_FFT(), mrpt::img::CImage::cross_correlation_FFT(), mrpt::math::dft2_complex(), mrpt::math::dft2_real(), mrpt::poses::CPointPDFSOG::evaluatePDFInArea(), mrpt::poses::CPosePDFSOG::evaluatePDFInArea(), mrpt::math::RANSAC_Template< NUMTYPE >::execute(), mrpt::math::CLevenbergMarquardtTempl< VECTORTYPE, USERPARAM >::execute(), mrpt::detectors::CFaceDetection::experimental_segmentFace(), mrpt::hwdrivers::CRoboticHeadInterface::Get3SoundBuffer(), mrpt::maps::CHeightGridMap2D::getAs3DObject(), mrpt::hmtslam::CLocalMetricHypothesis::getAs3DScene(), mrpt::math::MatrixBlockSparseCols< Scalar, NROWS, NCOLS, INFO, HAS_REMAP, INDEX_REMAP_MAP_IMPL >::getAsDense(), mrpt::img::CImage::getAsMatrix(), mrpt::img::CImage::getAsRGBMatrices(), mrpt::poses::CPose3DPDFGaussian::getCovSubmatrix2D(), mrpt::vision::CFeature::getFirstDescriptorAsMatrix(), mrpt::poses::CPose3DPDFGaussianInf::getInvCovSubmatrix2D(), mrpt::hwdrivers::CSwissRanger3DCamera::getNextObservation(), mrpt::slam::CICP::ICP_Method_LM(), mrpt::math::idft2_complex(), mrpt::math::idft2_real(), mrpt::maps::CBeaconMap::internal_insertObservation(), myGeneralDFT(), mrpt::slam::CRangeBearingKFSLAM2D::OnGetObservationsAndDataAssociation(), mrpt::slam::CRangeBearingKFSLAM::OnGetObservationsAndDataAssociation(), mrpt::topography::path_from_rtk_gps(), mrpt::maps::CMultiMetricMapPDF::prediction_and_update_pfOptimalProposal(), mrpt::math::ransac2Dline_fit(), mrpt::math::ransac3Dplane_fit(), mrpt::slam::CRangeBearingKFSLAM2D::reset(), mrpt::slam::CRangeBearingKFSLAM::reset(), mrpt::maps::CRandomFieldGridMap2D::resize(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::resize(), mrpt::bayes::CKalmanFilterCapable< 7, 3, 3, 7 >::runOneKalmanIteration(), mrpt::math::CMatrixB::serializeFrom(), mrpt::math::CMatrixDynamic< mrpt::math::TPoint3D_data< double > >::setFromMatrixLike(), and TEST().

Here is the caller graph for this function:

◆ setZero() [1/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setZero ( )
inlineinherited

Definition at line 112 of file MatrixVectorBase.h.

◆ setZero() [2/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setZero ( size_t  nrows,
size_t  ncols 
)
inlineinherited

Definition at line 113 of file MatrixVectorBase.h.

◆ setZero() [3/3]

void mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::setZero ( size_t  nrows)
inlineinherited

Definition at line 117 of file MatrixVectorBase.h.

◆ size()

template<class T>
matrix_size_t mrpt::math::CMatrixDynamic< T >::size ( ) const
inlineinherited

◆ sum()

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::sum ( ) const
inherited

Sum of all elements in matrix/vector.

Definition at line 345 of file MatrixVectorBase_impl.h.

◆ sum_abs()

T mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::sum_abs ( ) const
inherited

Sum of the absolute value of all elements in matrix/vector.

Definition at line 351 of file MatrixVectorBase_impl.h.

◆ swap()

template<class T>
void mrpt::math::CMatrixDynamic< T >::swap ( CMatrixDynamic< T > &  o)
inlineinherited

Swap with another matrix very efficiently (just swaps a pointer and two integer values).

Definition at line 141 of file CMatrixDynamic.h.

Referenced by mempool_donate_range_matrix().

Here is the caller graph for this function:

◆ tail()

CMatrixFixed<T , N, 1> mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::tail ( ) const
inlineinherited

Definition at line 226 of file MatrixVectorBase.h.

◆ trace()

T mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::trace ( ) const
inherited

Returns the trace of the matrix (not necessarily square).

Definition at line 219 of file MatrixBase_impl.h.

◆ transpose() [1/2]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::transpose ( )
inlineinherited

Definition at line 159 of file MatrixVectorBase.h.

◆ transpose() [2/2]

auto mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::transpose ( ) const
inlineinherited

Definition at line 164 of file MatrixVectorBase.h.

◆ unsafeRemoveColumns()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::unsafeRemoveColumns ( const std::vector< std::size_t > &  idxs)
inherited

Removes columns of the matrix.

This "unsafe" version assumes indices sorted in ascending order.

Definition at line 22 of file MatrixBase_impl.h.

◆ unsafeRemoveRows()

void mrpt::math::MatrixBase< T , CMatrixDynamic< T > >::unsafeRemoveRows ( const std::vector< std::size_t > &  idxs)
inherited

Removes rows of the matrix.

This "unsafe" version assumes indices sorted in ascending order.

Definition at line 49 of file MatrixBase_impl.h.

◆ 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 90 of file CSerializable.h.

◆ Zero() [1/2]

static CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::Zero ( )
inlinestaticinherited

Definition at line 125 of file MatrixVectorBase.h.

◆ Zero() [2/2]

static CMatrixDynamic< T > mrpt::math::MatrixVectorBase< T , CMatrixDynamic< T > >::Zero ( size_t  nrows,
size_t  ncols 
)
inlinestaticinherited

Definition at line 126 of file MatrixVectorBase.h.

Member Data Documentation

◆ className

constexpr const char* mrpt::math::CMatrixF::className = "mrpt::math" "::" "CMatrixF"
static

Definition at line 24 of file CMatrixF.h.

◆ ColsAtCompileTime

template<class T>
constexpr int mrpt::math::CMatrixDynamic< T >::ColsAtCompileTime = -1
staticinherited

Definition at line 62 of file CMatrixDynamic.h.

◆ is_mrpt_type

template<class T>
constexpr int mrpt::math::CMatrixDynamic< T >::is_mrpt_type = 1
staticinherited

Definition at line 64 of file CMatrixDynamic.h.

◆ RowsAtCompileTime

template<class T>
constexpr int mrpt::math::CMatrixDynamic< T >::RowsAtCompileTime = -1
staticinherited

Definition at line 61 of file CMatrixDynamic.h.

◆ runtimeClassId

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

Definition at line 24 of file CMatrixF.h.

◆ SizeAtCompileTime

template<class T>
constexpr int mrpt::math::CMatrixDynamic< T >::SizeAtCompileTime = -1
staticinherited

Definition at line 63 of file CMatrixDynamic.h.

◆ StorageOrder

template<class T>
constexpr int mrpt::math::CMatrixDynamic< T >::StorageOrder = 1
staticinherited

Definition at line 65 of file CMatrixDynamic.h.




Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: c7a3bec24 Sun Mar 29 18:33:13 2020 +0200 at dom mar 29 18:50:38 CEST 2020