ERC CISST - cisst software

---

nmrInverseFixedSizeData< _size, _storageOrder > Class Template Reference
[Numerical Methods]

#include <nmrInverse.h>

Collaboration diagram for nmrInverseFixedSizeData< _size, _storageOrder >:

[legend]List of all members.

---

Detailed Description

template<vct::size_type _size, bool _storageOrder>
class nmrInverseFixedSizeData< _size, _storageOrder >

Data for Inverse problem (Fixed size).

This class is similar to nmrInverseDynamicData except that it is dedicated to fixed size containers. While nmrInverseDynamicData is designed to be modified dynamically, nmrInverseFixedSizeData is fully defined at compilation time using template parameters. The required parameters are the dimensions of the input matrix:

  nmrInverseFixedSizeData<4, VCT_COL_MAJOR> data;

Note:

An object of type nmrInverseFixedSizeData contains the memory required for the pivot indices and the workspace, i.e. its actual size will be equal to the memory required to store these vectors.

There is no dynamic memory allocation (no new) and the memory can not be used by reference. To use memory by reference, one must use nmrInverseDynamicData with vctDynamicMatrixRef and vctDynamicVectorRef (these dynamic references can actually be used to overlay a fixed size container).

Definition at line 417 of file nmrInverse.h.

Public Types

• typedef vctFixedSizeMatrix<
  CISSTNETLIB_DOUBLE, _size,
  _size, _storageOrder > MatrixTypeA
• typedef vctFixedSizeVector<
  CISSTNETLIB_INTEGER, MAX_SIZE_1 > VectorTypePivotIndices
• typedef vctFixedSizeVector<
  CISSTNETLIB_DOUBLE, LWORK > VectorTypeWorkspace

Public Member Functions

• nmrInverseFixedSizeData ()

Protected Attributes

• VectorTypePivotIndices PivotIndicesMember
• VectorTypeWorkspace WorkspaceMember

---

Member Typedef Documentation

template<vct::size_type _size, bool _storageOrder>

typedef vctFixedSizeMatrix<CISSTNETLIB_DOUBLE, _size, _size, _storageOrder> nmrInverseFixedSizeData< _size, _storageOrder >::MatrixTypeA

Type of the input matrix A (size computed from the data template parameters).

Definition at line 429 of file nmrInverse.h.

template<vct::size_type _size, bool _storageOrder>

typedef vctFixedSizeVector<CISSTNETLIB_INTEGER, MAX_SIZE_1> nmrInverseFixedSizeData< _size, _storageOrder >::VectorTypePivotIndices

Type of the output vector PivotIndices (size computed from the template parameters).

Definition at line 432 of file nmrInverse.h.

template<vct::size_type _size, bool _storageOrder>

typedef vctFixedSizeVector<CISSTNETLIB_DOUBLE, LWORK> nmrInverseFixedSizeData< _size, _storageOrder >::VectorTypeWorkspace

Type used to create the workspace (size computed from the template parameters).

Definition at line 435 of file nmrInverse.h.

---

Constructor & Destructor Documentation

template<vct::size_type _size, bool _storageOrder>

nmrInverseFixedSizeData< _size, _storageOrder >::nmrInverseFixedSizeData

(

)

[inline]

Default constructor. Does nothing since the allocation is performed on the stack.

Definition at line 467 of file nmrInverse.h.

---

Member Data Documentation

template<vct::size_type _size, bool _storageOrder>

VectorTypePivotIndices nmrInverseFixedSizeData< _size, _storageOrder >::PivotIndicesMember [protected]

Data member used to store the vector pivotIndices.

Definition at line 438 of file nmrInverse.h.

template<vct::size_type _size, bool _storageOrder>

VectorTypeWorkspace nmrInverseFixedSizeData< _size, _storageOrder >::WorkspaceMember [protected]

Data member used to store the workspace vector.

Definition at line 439 of file nmrInverse.h.

---

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

• nmrInverse.h

---