Information about the result of a non-linear solver. More...

#include <ikarus/solver/nonlinearsolver/solverinfos.hh>

Public Member Functions
	operator bool () const
	Conversion operator to check the success of the solver. More...

Public Attributes
bool	success {false}

double	residualNorm {std::numeric_limits<double>::infinity()}

double	correctionNorm {std::numeric_limits<double>::infinity()}

int	iterations {-1}

Detailed Description

This structure holds information about the success of a non-linear solver, including the residual norm, correction norm, and the number of iterations performed.

Member Function Documentation

◆ operator bool()

Ikarus::NonLinearSolverInformation::operator bool ( ) const

inlineexplicit

Returns: true if the solver was successful, false otherwise.

Member Data Documentation

◆ correctionNorm

double Ikarus::NonLinearSolverInformation::correctionNorm {std::numeric_limits<double>::infinity()}

◆ iterations

int Ikarus::NonLinearSolverInformation::iterations {-1}

◆ residualNorm

double Ikarus::NonLinearSolverInformation::residualNorm {std::numeric_limits<double>::infinity()}

◆ success

bool Ikarus::NonLinearSolverInformation::success {false}

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

solverinfos.hh

Public Member Functions

Public Attributes