MathLin::LeastSquaresResult Struct Reference

Result for least squares problems. More...

#include <MathLin_LeastSquares.hxx>

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

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
std::optional< math_Vector >	Solution
	Least squares solution x.
std::optional< double >	Residual
	||Ax - b||_2 (L2 norm of residual)
std::optional< double >	ResidualSq
	||Ax - b||_2^2 (squared residual)
int	Rank = 0
	Numerical rank of A (for SVD)

Detailed Description

Result for least squares problems.

Member Function Documentation

IsDone()

bool MathLin::LeastSquaresResult::IsDone ( ) const

inline

operator bool()

MathLin::LeastSquaresResult::operator bool ( ) const

inlineexplicit

Field Documentation

Rank

int MathLin::LeastSquaresResult::Rank = 0

Numerical rank of A (for SVD)

Residual

std::optional<double> MathLin::LeastSquaresResult::Residual

||Ax - b||_2 (L2 norm of residual)

ResidualSq

std::optional<double> MathLin::LeastSquaresResult::ResidualSq

||Ax - b||_2^2 (squared residual)

Solution

std::optional<math_Vector> MathLin::LeastSquaresResult::Solution

Least squares solution x.

Status

MathUtils::Status MathLin::LeastSquaresResult::Status = MathUtils::Status::NotConverged

---

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

• MathLin_LeastSquares.hxx