NDEVR
API Documentation
SVD

Performs the singular value decomposition of a general matrix, taken and adapted from Numerical Recipes Third Edition svd.h. More...

Public Member Functions

 SVD (const NdArray &inMatrix)
 Constructor.
const Buffer< double > & s () noexcept
 the resultant w matrix
Buffer< double > solve (const Buffer< double > &inInput, double inThresh=-1.)
 solves the linear least squares problem
const NdArray & u () noexcept
 the resultant u matrix
const NdArray & v () noexcept
 the resultant v matrix

Detailed Description

Performs the singular value decomposition of a general matrix, taken and adapted from Numerical Recipes Third Edition svd.h.


Definition at line 12 of file SVD.hpp.

Constructor & Destructor Documentation

◆ SVD()

SVD::SVD ( const NdArray & inMatrix)
inlineexplicit

Constructor.

Parameters
inMatrixmatrix to perform SVD on

Definition at line 21 of file SVD.hpp.

Member Function Documentation

◆ s()

const Buffer< double > & SVD::s ( )
inlinenoexcept

the resultant w matrix

Returns
s matrix

Definition at line 64 of file SVD.hpp.

◆ solve()

Buffer< double > SVD::solve ( const Buffer< double > & inInput,
double inThresh = -1. )
inline

solves the linear least squares problem

Parameters
inInput
inThresh(default -1.)
Returns
NdArray

Definition at line 78 of file SVD.hpp.

◆ u()

const NdArray & SVD::u ( )
inlinenoexcept

the resultant u matrix

Returns
u matrix

Definition at line 42 of file SVD.hpp.

◆ v()

const NdArray & SVD::v ( )
inlinenoexcept

the resultant v matrix

Returns
v matrix

Definition at line 53 of file SVD.hpp.


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