MathUtils::DecompResult Struct Reference

Result for matrix decomposition (LU, SVD, QR). Structure depends on decomposition type. More...

#include <MathUtils_Types.hxx>

Public Member Functions
bool	IsDone () const
	Returns true if decomposition succeeded.
	operator bool () const
	Conversion to bool for convenient checking.

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
std::optional< math_Matrix >	L
	Lower triangular (LU) or left singular vectors (SVD)
std::optional< math_Matrix >	U
	Upper triangular (LU) or right singular vectors (SVD)
std::optional< math_Vector >	D
	Diagonal elements or singular values.
std::optional< double >	Determinant
	Matrix determinant (if computed)

Detailed Description

Result for matrix decomposition (LU, SVD, QR). Structure depends on decomposition type.

Member Function Documentation

IsDone()

bool MathUtils::DecompResult::IsDone ( ) const

inline

Returns true if decomposition succeeded.

operator bool()

MathUtils::DecompResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

D

std::optional<math_Vector> MathUtils::DecompResult::D

Diagonal elements or singular values.

Determinant

std::optional<double> MathUtils::DecompResult::Determinant

Matrix determinant (if computed)

L

std::optional<math_Matrix> MathUtils::DecompResult::L

Lower triangular (LU) or left singular vectors (SVD)

Status

MathUtils::Status MathUtils::DecompResult::Status = MathUtils::Status::NotConverged

Computation status.

U

std::optional<math_Matrix> MathUtils::DecompResult::U

Upper triangular (LU) or right singular vectors (SVD)

---

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

• MathUtils_Types.hxx