MathSys::NewtonResultN< N > Struct Template Reference

Result of N-dimensional Newton solver. More...

#include <MathSys_NewtonTypes.hxx>

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

Data Fields
MathUtils::Status	Status = MathUtils::Status::NotConverged
	Final solver status.
std::array< double, N >	X = {}
	Solution estimate.
size_t	NbIterations = 0
	Performed iterations.
double	ResidualNorm = 0.0
	Final residual norm ||F||.
double	StepNorm = 0.0
	Final step norm ||dX||.

Detailed Description

template<int N>
struct MathSys::NewtonResultN< N >

Result of N-dimensional Newton solver.

Member Function Documentation

IsDone()

template<int N>

bool MathSys::NewtonResultN< N >::IsDone ( ) const

inline

Returns true if computation converged.

operator bool()

template<int N>

MathSys::NewtonResultN< N >::operator bool ( ) const

inlineexplicit

Conversion to bool for convenient checking.

Field Documentation

NbIterations

template<int N>

size_t MathSys::NewtonResultN< N >::NbIterations = 0

Performed iterations.

ResidualNorm

template<int N>

double MathSys::NewtonResultN< N >::ResidualNorm = 0.0

Final residual norm ||F||.

Status

template<int N>

MathUtils::Status MathSys::NewtonResultN< N >::Status = MathUtils::Status::NotConverged

Final solver status.

StepNorm

template<int N>

double MathSys::NewtonResultN< N >::StepNorm = 0.0

Final step norm ||dX||.

X

template<int N>

std::array<double, N> MathSys::NewtonResultN< N >::X = {}

Solution estimate.

---

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

• MathSys_NewtonTypes.hxx