nc::linalg::SVD Class Reference

#include <SVDClass.hpp>

Public Member Functions
	SVD (const NdArray< double > &inMatrix)
const NdArray< double > &	s () noexcept
NdArray< double >	solve (const NdArray< double > &inInput, double inThresh=-1.)
const NdArray< double > &	u () noexcept
const NdArray< double > &	v () noexcept

Detailed Description

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

Constructor & Destructor Documentation

SVD()

nc::linalg::SVD::SVD ( const NdArray< double > &  inMatrix )

inlineexplicit

Constructor

Parameters

inMatrix

matrix to perform SVD on

Member Function Documentation

s()

const NdArray< double > & nc::linalg::SVD::s ( )

inlinenoexcept

the resultant w matrix

Returns

s matrix

solve()

NdArray< double > nc::linalg::SVD::solve ( const NdArray< double > &  inInput, double  inThresh = -1.  )

inline

solves the linear least squares problem

Parameters

inInput
inThresh	(default -1.)

Returns

NdArray

u()

const NdArray< double > & nc::linalg::SVD::u ( )

inlinenoexcept

the resultant u matrix

Returns

u matrix

v()

const NdArray< double > & nc::linalg::SVD::v ( )

inlinenoexcept

the resultant v matrix

Returns

v matrix

---

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

• SVDClass.hpp