MathLin::QRResult Struct Reference

Result for QR decomposition using Householder reflections. More...

#include <MathLin_Householder.hxx>

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

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
std::optional< math_Matrix >	Q
	Orthogonal matrix Q (m x m)
std::optional< math_Matrix >	R
	Upper triangular matrix R (m x n)
int	Rank = 0
	Numerical rank.

Detailed Description

Result for QR decomposition using Householder reflections.

Member Function Documentation

IsDone()

bool MathLin::QRResult::IsDone ( ) const

inline

operator bool()

MathLin::QRResult::operator bool ( ) const

inlineexplicit

Field Documentation

Q

std::optional<math_Matrix> MathLin::QRResult::Q

Orthogonal matrix Q (m x m)

R

std::optional<math_Matrix> MathLin::QRResult::R

Upper triangular matrix R (m x n)

Rank

int MathLin::QRResult::Rank = 0

Numerical rank.

Status

MathUtils::Status MathLin::QRResult::Status = MathUtils::Status::NotConverged

---

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

• MathLin_Householder.hxx