ERC CISST - cisst software

---

nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n > Class Template Reference

#include <nmrLSqLin.h>

Collaboration diagram for nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >:

[legend]List of all members.

---

Detailed Description

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>
class nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >

This provides the solution class for fixed size matrices and provides a easy to use template. That is nmrSVDSolutionFixedSize<4, 3, VCT_COL_MAJOR> vs. nmrSVDSolutionBase<vctFixedSizeMatrix<4, 3, VCT_COL_MAJOR> No extra work of allocation etc is required for fixed size.

Definition at line 1593 of file nmrLSqLin.h.

Public Types

• enum
• enum
• enum
• enum
• enum
• enum
• enum
• enum
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE, _ma,
  _n, 1, _ma > TypeA
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE,(_me==0)?1:_me, _n, 1,(_me==0)?1:_me > TypeE
• typedef vctFixedSizeMatrixRef<
  CISSTNETLIB_DOUBLE,(_mg==0)?1:_mg, _n, 1,(_mg==0)?1:_mg > TypeG
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE, _ma, 1 > Typeb
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE,(_me==0)?1:_me, 1 > Typef
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE,(_mg==0)?1:_mg, 1 > Typeh
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE,(_me==0)?1:_me, 1 > TypeRNormE
• typedef vctFixedSizeVectorRef<
  CISSTNETLIB_DOUBLE, _ma, 1 > TypeRNormL
• typedef vctFixedSizeVector<
  CISSTNETLIB_DOUBLE, LWORK > TypeWork
• typedef vctFixedSizeVector<
  CISSTNETLIB_INTEGER, LIWORK > TypeIWork
• typedef vctFixedSizeVector<
  CISSTNETLIB_DOUBLE, _n > TypeX
• typedef vctFixedSizeVector<
  CISSTNETLIB_DOUBLE, _ma+_me > TypeRNorm
• typedef vctFixedSizeMatrix<
  CISSTNETLIB_DOUBLE, _ma+_me+_mg, _n+1, VCT_COL_MAJOR > TypeInput

Public Member Functions

• nmrLSqLinSolutionFixedSize ()
• const TypeX & GetX (void) const
• const TypeRNormL & GetRNorm (void) const
• const TypeRNormE & GetRNormE (void) const

Protected Attributes

• TypeWork WorkspaceMemory
• TypeIWork IWorkspaceMemory
• TypeRNorm RNorm
• TypeInput InputMemory
• TypeX X
• TypeRNormL RNormL
• TypeRNormE RNormE

Friends

• class Friend

Classes

• class Friend

---

Member Function Documentation

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>

const TypeX& nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::GetX

(

void

)

const [inline]

In order to get access to X, after the have been computed by calling nmrLSqLin function. use the following methods.

Definition at line 1696 of file nmrLSqLin.h.

References nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::X.

Referenced by nmrLSqLin().

---

Member Data Documentation

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>

TypeWork nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::WorkspaceMemory [protected]

Memory allocated for Workspace matrices if needed

Definition at line 1623 of file nmrLSqLin.h.

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>

TypeRNorm nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::RNorm [protected]

Memory allocated for norms if needed.

Definition at line 1628 of file nmrLSqLin.h.

Referenced by nmrLSqLin().

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>

TypeInput nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::InputMemory [protected]

Memory allocated for input if needed The LSEI (constrained least squares) require that the the input matrices be in one continous memory block ordered accoring to fortran order (Column Major format), such that first Mc rows and N columns represent A, Ma rows and N+1 th column represent b next Me rows represent (E, f) and last Mg rows represent (G, h) where the original LSEI problem is arg min || A x - b ||, s.t. E x = f and G x >= h. The input for LSI is similar other than Me == 0.

Definition at line 1641 of file nmrLSqLin.h.

template<vct::size_type _ma, vct::size_type _me, vct::size_type _mg, vct::size_type _n>

TypeX nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::X [protected]

References to work or return or input types, these point either to user allocated memory or our memory chunks if needed

Definition at line 1645 of file nmrLSqLin.h.

Referenced by nmrLSqLinSolutionFixedSize< _ma, _me, _mg, _n >::GetX().

---

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

• nmrLSqLin.h

---