MathLin::SVDResult Struct Reference

Result for SVD decomposition. More...

#include <MathLin_SVD.hxx>

Public Member Functions
bool	IsDone () const
	operator bool () const

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
std::optional< math_Matrix >	U
	Left singular vectors (m x n)
std::optional< math_Vector >	SingularValues
	Singular values (n elements)
std::optional< math_Matrix >	V
	Right singular vectors (n x n)
int	Rank = 0
	Numerical rank.

Detailed Description

Result for SVD decomposition.

Member Function Documentation

IsDone()

bool MathLin::SVDResult::IsDone ( ) const

inline

operator bool()

MathLin::SVDResult::operator bool ( ) const

inlineexplicit

Field Documentation

Rank

int MathLin::SVDResult::Rank = 0

Numerical rank.

SingularValues

std::optional<math_Vector> MathLin::SVDResult::SingularValues

Singular values (n elements)

Status

MathUtils::Status MathLin::SVDResult::Status = MathUtils::Status::NotConverged

U

std::optional<math_Matrix> MathLin::SVDResult::U

Left singular vectors (m x n)

V

std::optional<math_Matrix> MathLin::SVDResult::V

Right singular vectors (n x n)

---

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

• MathLin_SVD.hxx