Package org.hipparchus.optim
Class AbstractConvergenceChecker<P>
java.lang.Object
org.hipparchus.optim.AbstractConvergenceChecker<P>
- Type Parameters:
P
- Type of (point, value) pair.
- All Implemented Interfaces:
ConvergenceChecker<P>
- Direct Known Subclasses:
SimplePointChecker
,SimpleUnivariateValueChecker
,SimpleValueChecker
,SimpleVectorValueChecker
Base class for all convergence checker implementations.
-
Constructor Summary
ConstructorDescriptionAbstractConvergenceChecker
(double relativeThreshold, double absoluteThreshold) Build an instance with a specified thresholds. -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
Check if the optimization algorithm has converged.double
Get absolute threshold.double
Get relative threshold.
-
Constructor Details
-
AbstractConvergenceChecker
public AbstractConvergenceChecker(double relativeThreshold, double absoluteThreshold) Build an instance with a specified thresholds.- Parameters:
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance threshold
-
-
Method Details
-
getRelativeThreshold
public double getRelativeThreshold()Get relative threshold.- Returns:
- the relative threshold.
-
getAbsoluteThreshold
public double getAbsoluteThreshold()Get absolute threshold.- Returns:
- the absolute threshold.
-
converged
Check if the optimization algorithm has converged.- Specified by:
converged
in interfaceConvergenceChecker<P>
- Parameters:
iteration
- Current iteration.previous
- Best point in the previous iteration.current
- Best point in the current iteration.- Returns:
true
if the algorithm is considered to have converged.
-