MathUtils::EigenResult Struct Reference

Result for eigenvalue/eigenvector computation. Contains eigenvalues and optionally eigenvectors. 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.
size_t	NbIterations = 0
	Number of iterations performed.
std::optional< math_Vector >	EigenValues
	Computed eigenvalues (set by solver)
std::optional< math_Matrix >	EigenVectors
	Computed eigenvectors (set by solver)

Detailed Description

Result for eigenvalue/eigenvector computation. Contains eigenvalues and optionally eigenvectors.

Member Function Documentation

IsDone()

bool MathUtils::EigenResult::IsDone ( ) const

inline

Returns true if computation succeeded.

operator bool()

MathUtils::EigenResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

EigenValues

std::optional<math_Vector> MathUtils::EigenResult::EigenValues

Computed eigenvalues (set by solver)

EigenVectors

std::optional<math_Matrix> MathUtils::EigenResult::EigenVectors

Computed eigenvectors (set by solver)

NbIterations

size_t MathUtils::EigenResult::NbIterations = 0

Number of iterations performed.

Status

MathUtils::Status MathUtils::EigenResult::Status = MathUtils::Status::NotConverged

Computation status.

---

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

• MathUtils_Types.hxx