MathUtils::VectorResult Struct Reference

Result for N-dimensional optimization and system solving. Contains the solution vector and optional gradient/Jacobian information. 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 >	Solution
	Solution vector (set by solver on success)
std::optional< double >	Value
	Function value at solution (if computed)
std::optional< math_Vector >	Gradient
	Gradient at solution (if computed)
std::optional< math_Matrix >	Jacobian
	Jacobian at solution (if computed)

Detailed Description

Result for N-dimensional optimization and system solving. Contains the solution vector and optional gradient/Jacobian information.

Member Function Documentation

IsDone()

bool MathUtils::VectorResult::IsDone ( ) const

inline

Returns true if computation succeeded.

operator bool()

MathUtils::VectorResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

Gradient

std::optional<math_Vector> MathUtils::VectorResult::Gradient

Gradient at solution (if computed)

Jacobian

std::optional<math_Matrix> MathUtils::VectorResult::Jacobian

Jacobian at solution (if computed)

NbIterations

size_t MathUtils::VectorResult::NbIterations = 0

Number of iterations performed.

Solution

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

Solution vector (set by solver on success)

Status

MathUtils::Status MathUtils::VectorResult::Status = MathUtils::Status::NotConverged

Computation status.

Value

std::optional<double> MathUtils::VectorResult::Value

Function value at solution (if computed)

---

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

• MathUtils_Types.hxx