ERC CISST - cisst software

---

nmrPInverseFixedSizeData< _rows, _cols, _storageOrder > Class Template Reference

#include <nmrPInverse.h>

Collaboration diagram for nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >:

[legend]List of all members.

---

Detailed Description

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>
class nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >

This provides the data class for fixed size matrices and provides a easy to use template. That is nmrPInverseFixedSizeData<4, 3, VCT_COL_MAJOR> vs. nmrPInverseDataBase<vctFixedSizeMatrix<4, 3, VCT_COL_MAJOR> No extra workspace of allocation etc is required for fixed size.

Definition at line 500 of file nmrPInverse.h.

• nmrPInverseFixedSizeData ()

Public Types

• typedef vct::size_type size_type
• typedef vctFixedSizeMatrix<
  CISSTNETLIB_DOUBLE, _rows,
  _cols, _storageOrder > MatrixTypeA
• typedef vctFixedSizeMatrix<
  CISSTNETLIB_DOUBLE, _cols,
  _rows, _storageOrder > MatrixTypePInverse
• typedef vctFixedSizeVector<
  CISSTNETLIB_DOUBLE, LWORK > VectorTypeWorkspace
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE, _rows,
  _rows, _storageOrder?_rows:1,
  _storageOrder?1:_rows > MatrixTypeU
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE, _cols,
  _cols, _storageOrder?_cols:1,
  _storageOrder?1:_cols > MatrixTypeVt
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE, MIN_MN, 1 > VectorTypeS
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE, LWORK_3, 1 > VectorTypeSVDWorkspace
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE, _cols,
  _rows, _storageOrder?_cols:1,
  _storageOrder?1:_rows > MatrixTypeP

Public Member Functions

Retrieving results

In order to get access to U, V^t and S, after the have been computed by calling nmrPInverse function, use the following methods.

• const MatrixTypePInverse & PInverse (void) const
• const VectorTypeS & S (void) const
• const MatrixTypeU & U (void) const
• const MatrixTypeVt & Vt (void) const
• const MatrixTypeP & P (void) const

---

Member Typedef Documentation

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeMatrix<CISSTNETLIB_DOUBLE, _rows, _cols, _storageOrder> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::MatrixTypeA

Type of the input matrix

Definition at line 513 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeMatrix<CISSTNETLIB_DOUBLE, _cols, _rows, _storageOrder> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::MatrixTypePInverse

Type of the pseudo inverse matrix

Definition at line 515 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeVector<CISSTNETLIB_DOUBLE, LWORK> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::VectorTypeWorkspace

Type used for the workspace

Definition at line 517 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeMatrixRef<CISSTNETLIB_DOUBLE, _rows, _rows, _storageOrder ? _rows : 1, _storageOrder ? 1 : _rows> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::MatrixTypeU

Type used for the U matrix of the SVD

Definition at line 519 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeMatrixRef<CISSTNETLIB_DOUBLE, _cols, _cols, _storageOrder ? _cols : 1, _storageOrder ? 1 : _cols> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::MatrixTypeVt

Type used for the Vt matrix of the SVD

Definition at line 521 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeVectorRef<CISSTNETLIB_DOUBLE, MIN_MN, 1> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::VectorTypeS

Type used for the S vector of the SVD

Definition at line 523 of file nmrPInverse.h.

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

typedef vctFixedSizeVectorRef<CISSTNETLIB_DOUBLE, LWORK_3, 1> nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::VectorTypeSVDWorkspace

Type used for the workspace of SVD

Definition at line 525 of file nmrPInverse.h.

---

Constructor & Destructor Documentation

template<vct::size_type _rows, vct::size_type _cols, bool _storageOrder>

nmrPInverseFixedSizeData< _rows, _cols, _storageOrder >::nmrPInverseFixedSizeData

(

)

[inline]

Default constructor. This constructor sets all the references used to call the SVD routines using a contiguous block of memory (aka workspace). The memory is stack allocated but the references are computed at runtime.

Definition at line 591 of file nmrPInverse.h.

---

The documentation for this class was generated from the following file:

• nmrPInverse.h

---