Package org.hipparchus.optim.nonlinear.vector.leastsquares

Interface LeastSquaresOptimizer.Optimum

All Superinterfaces:

LeastSquaresProblem.Evaluation

Enclosing interface:

LeastSquaresOptimizer

public static interface LeastSquaresOptimizer.Optimum
extends LeastSquaresProblem.Evaluation

The optimum found by the optimizer. This object contains the point, its value, and some metadata.

Method Summary

Modifier and Type	Method	Description
int	getEvaluations()	Get the number of times the model was evaluated in order to produce this optimum.
int	getIterations()	Get the number of times the algorithm iterated in order to produce this optimum.
static LeastSquaresOptimizer.Optimum	of(LeastSquaresProblem.Evaluation value, int evaluations, int iterations)	Create a new optimum from an evaluation and the values of the counters.

Methods inherited from interface org.hipparchus.optim.nonlinear.vector.leastsquares.LeastSquaresProblem.Evaluation

getChiSquare, getCost, getCovariances, getJacobian, getPoint, getReducedChiSquare, getResiduals, getRMS, getSigma

Method Detail

getEvaluations

int getEvaluations()

Get the number of times the model was evaluated in order to produce this optimum.

Returns:

the number of model (objective) function evaluations

getIterations

int getIterations()

Get the number of times the algorithm iterated in order to produce this optimum. In general least squares it is common to have one evaluation per iterations.

Returns:

the number of iterations

of

static LeastSquaresOptimizer.Optimum of(LeastSquaresProblem.Evaluation value,
                                        int evaluations,
                                        int iterations)

Create a new optimum from an evaluation and the values of the counters.

Parameters:

value - the function value

evaluations - number of times the function was evaluated

iterations - number of iterations of the algorithm

Returns:

a new optimum based on the given data.