Main MRPT website > C++ reference
MRPT logo
Public Types | Public Member Functions

mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS > Class Template Reference


Detailed Description

template<typename T, size_t NROWS, size_t NCOLS>
class mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >

A numeric matrix of compile-time fixed size.

Basically, this class is a wrapper on Eigen::Matrix<T,NROWS,NCOLS>, but with a RowMajor element memory layout (except for column vectors).

These matrices also have iterators to access all the elements in the matrix as a sequence, starting from the element (0,0), then row by row, from left to right.

Note:
This class exists for backward compatibility of ancient times when MRPT didn't rely on Eigen, feel free to directly use Eigen::Matrix<> types instead.
See also:
CMatrixTemplateNumeric (for dynamic-size matrices)

Definition at line 52 of file CMatrixFixedNumeric.h.

#include <mrpt/math/CMatrixFixedNumeric.h>

Inheritance diagram for mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Eigen::Matrix< T,
NROWS, NCOLS, Eigen::AutoAlign|((NCOLS==1
&&NROWS!=1)?Eigen::ColMajor:Eigen::RowMajor) > 
Base
typedef CMatrixFixedNumeric< T,
NROWS, NCOLS > 
mrpt_autotype

Public Member Functions

 MRPT_EIGEN_DERIVED_CLASS_CTOR_OPERATOR_EQUAL (CMatrixFixedNumeric) inline CMatrixFixedNumeric()
 Default constructor, initializes all elements to zero.
 CMatrixFixedNumeric (const T *vals)
 Constructor from an array in row major.
 CMatrixFixedNumeric (TConstructorFlags_Matrices constructor_flag)
 Constructor which leaves the matrix uninitialized.
template<size_t N, typename ReturnType >
ReturnType getVicinity (size_t c, size_t r) const
void loadFromArray (const T *vals)
template<typename Derived >
bool operator== (const Eigen::MatrixBase< Derived > &m2) const
 == comparison of two matrices; it differs from default Eigen operator in that returns false if matrices are of different sizes instead of raising an assert.
template<typename Derived >
bool operator!= (const Eigen::MatrixBase< Derived > &m2) const
 != comparison of two matrices; it differs from default Eigen operator in that returns true if matrices are of different sizes instead of raising an assert.

Member Typedef Documentation

template<typename T, size_t NROWS, size_t NCOLS>
typedef Eigen::Matrix<T,NROWS,NCOLS, Eigen::AutoAlign | ( (NCOLS==1 && NROWS!=1) ? Eigen::ColMajor : Eigen::RowMajor ) > mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::Base

Definition at line 63 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
typedef CMatrixFixedNumeric<T,NROWS,NCOLS> mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::mrpt_autotype

Definition at line 64 of file CMatrixFixedNumeric.h.


Constructor & Destructor Documentation

template<typename T, size_t NROWS, size_t NCOLS>
mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::CMatrixFixedNumeric ( const T *  vals  )  [inline]

Constructor from an array in row major.

Definition at line 73 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::CMatrixFixedNumeric ( TConstructorFlags_Matrices  constructor_flag  )  [inline]

Constructor which leaves the matrix uninitialized.

Example of usage: CMatrixFixedNumeric<double,3,2> M(UNINITIALIZED_MATRIX);

Definition at line 78 of file CMatrixFixedNumeric.h.


Member Function Documentation

template<typename T, size_t NROWS, size_t NCOLS>
template<size_t N, typename ReturnType >
ReturnType mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::getVicinity ( size_t  c,
size_t  r 
) const [inline]

Definition at line 80 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
void mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::loadFromArray ( const T *  vals  )  [inline]

Definition at line 84 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::MRPT_EIGEN_DERIVED_CLASS_CTOR_OPERATOR_EQUAL ( CMatrixFixedNumeric< T, NROWS, NCOLS >   )  [inline]

Default constructor, initializes all elements to zero.

Definition at line 66 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
template<typename Derived >
bool mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::operator!= ( const Eigen::MatrixBase< Derived > &  m2  )  const [inline]

!= comparison of two matrices; it differs from default Eigen operator in that returns true if matrices are of different sizes instead of raising an assert.

Definition at line 100 of file CMatrixFixedNumeric.h.

template<typename T, size_t NROWS, size_t NCOLS>
template<typename Derived >
bool mrpt::math::CMatrixFixedNumeric< T, NROWS, NCOLS >::operator== ( const Eigen::MatrixBase< Derived > &  m2  )  const [inline]

== comparison of two matrices; it differs from default Eigen operator in that returns false if matrices are of different sizes instead of raising an assert.

Definition at line 92 of file CMatrixFixedNumeric.h.




Page generated by Doxygen 1.7.1 for MRPT 0.9.4 SVN: at Mon Jan 10 23:33:19 UTC 2011