MathUtils::ScalarResult Struct Reference

Result for scalar (1D) root finding and minimization. Contains the found root/minimum location and diagnostic 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. Example: if (aResult) { use *aResult.Root; }.

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Computation status.
size_t	NbIterations = 0
	Number of iterations performed.
std::optional< double >	Root
	Found root or minimum location.
std::optional< double >	Value
	Function value at root/minimum.
std::optional< double >	Derivative
	Derivative at root (if computed)

Detailed Description

Result for scalar (1D) root finding and minimization. Contains the found root/minimum location and diagnostic information.

Member Function Documentation

IsDone()

bool MathUtils::ScalarResult::IsDone ( ) const

inline

Returns true if computation succeeded.

operator bool()

MathUtils::ScalarResult::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking. Example: if (aResult) { use *aResult.Root; }.

Field Documentation

Derivative

std::optional<double> MathUtils::ScalarResult::Derivative

Derivative at root (if computed)

NbIterations

size_t MathUtils::ScalarResult::NbIterations = 0

Number of iterations performed.

Root

std::optional<double> MathUtils::ScalarResult::Root

Found root or minimum location.

Status

MathUtils::Status MathUtils::ScalarResult::Status = MathUtils::Status::NotConverged

Computation status.

Value

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

Function value at root/minimum.

---

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

• MathUtils_Types.hxx