MathUtils::InverseResult Struct Reference

Result for matrix inverse computation. Contains the inverse matrix if computation succeeded. More...

#include <MathUtils_Types.hxx>

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

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
std::optional< math_Matrix >	Inverse
	Computed inverse matrix.
std::optional< double >	Determinant
	Determinant of matrix (if computed)

Detailed Description

Result for matrix inverse computation. Contains the inverse matrix if computation succeeded.

Member Function Documentation

IsDone()

bool MathUtils::InverseResult::IsDone ( ) const

inline

Returns true if inversion succeeded.

operator bool()

MathUtils::InverseResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

Determinant

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

Determinant of matrix (if computed)

Inverse

std::optional<math_Matrix> MathUtils::InverseResult::Inverse

Computed inverse matrix.

Status

MathUtils::Status MathUtils::InverseResult::Status = MathUtils::Status::NotConverged

Computation status.

---

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

• MathUtils_Types.hxx