MathUtils::LinearResult Struct Reference

Result for linear system solving (Ax = b). Contains the solution vector and matrix determinant if computed. More...

#include <MathUtils_Types.hxx>

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

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
std::optional< math_Vector >	Solution
	Solution vector X in AX = B (set by solver)
std::optional< double >	Determinant
	Determinant of matrix (if computed)

Detailed Description

Result for linear system solving (Ax = b). Contains the solution vector and matrix determinant if computed.

Member Function Documentation

IsDone()

bool MathUtils::LinearResult::IsDone ( ) const

inline

Returns true if computation succeeded.

operator bool()

MathUtils::LinearResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

Determinant

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

Determinant of matrix (if computed)

Solution

std::optional<math_Vector> MathUtils::LinearResult::Solution

Solution vector X in AX = B (set by solver)

Status

MathUtils::Status MathUtils::LinearResult::Status = MathUtils::Status::NotConverged

Computation status.

---

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

• MathUtils_Types.hxx