public abstract Class AbstractConvergenceChecker<PAIR>

Class Inheritance

extends Object
implements ConvergenceChecker<PAIR>

All Implemented Interfaces

org.apache.commons.math3.optim.ConvergenceChecker

Known Direct Subclasses

Type Parameters

Base class for all convergence checker implementations.

Field Summary

Modifier and Type	Field and Description
private final double	absoluteThreshold Absolute tolerance threshold.
private final double	relativeThreshold Relative tolerance threshold.

Access	Constructor and Description
public	AbstractConvergenceChecker(final double relative tolerance threshold relativeThreshold, final double absolute tolerance threshold absoluteThreshold) Build an instance with a specified thresholds.

Modifier and Type	Method and Description
public abstract boolean	converged(int Current iteration. iteration, PAIR Best point in the previous iteration. previous, PAIR Best point in the current iteration. current) Redeclares org.apache.commons.math3.optim.ConvergenceChecker.converged. Check if the optimization algorithm has converged.
public double	Returns: the absolute threshold. getAbsoluteThreshold()
public double	Returns: the relative threshold. getRelativeThreshold()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

absoluteThreshold	back to summary
private final double absoluteThreshold Absolute tolerance threshold.

relativeThreshold	back to summary
private final double relativeThreshold Relative tolerance threshold.

AbstractConvergenceChecker	back to summary
public AbstractConvergenceChecker(final double relativeThreshold, final double absoluteThreshold) Build an instance with a specified thresholds. Parameters relativeThreshold:double relative tolerance threshold absoluteThreshold:double absolute tolerance threshold

AbstractConvergenceChecker

public AbstractConvergenceChecker(final double relativeThreshold, final double absoluteThreshold)

Build an instance with a specified thresholds.

Parameters

converged back to summary

converged	back to summary
public abstract boolean converged(int iteration, PAIR previous, PAIR current) Redeclares org.apache.commons.math3.optim.ConvergenceChecker.converged. Doc from org.apache.commons.math3.optim.ConvergenceChecker.converged. Check if the optimization algorithm has converged. Parameters iteration:int Current iteration. previous:PAIR Best point in the previous iteration. current:PAIR Best point in the current iteration. Returns:boolean `true` if the algorithm is considered to have converged.

public abstract boolean converged(int iteration, PAIR previous, PAIR current)

Check if the optimization algorithm has converged.

Parameters

Returns:boolean

true if the algorithm is considered to have converged.

getAbsoluteThreshold	back to summary
public double getAbsoluteThreshold() Returns:double the absolute threshold.

getRelativeThreshold	back to summary
public double getRelativeThreshold() Returns:double the relative threshold.