Top Description Fields Constructors Methods
org.apache.commons.math3.optimization

public abstract Class AbstractConvergenceChecker<PAIR>

extends Object
implements ConvergenceChecker<PAIR>
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.optimization.ConvergenceChecker
Known Direct Subclasses
org.apache.commons.math3.optimization.SimplePointChecker, org.apache.commons.math3.optimization.SimpleValueChecker, org.apache.commons.math3.optimization.SimpleVectorValueChecker, org.apache.commons.math3.optimization.univariate.SimpleUnivariateValueChecker
Annotations
@Deprecated
Type Parameters
<PAIR>
Type of (point, value) pair.
Imports
org.apache.commons.math3.util.Precision

Deprecated

As of 3.1 (to be removed in 4.0).

Base class for all convergence checker implementations.
Since
3.0

Field Summary

Modifier and TypeField and Description
private final double
absoluteThreshold

Absolute tolerance threshold.

private static final double
DEFAULT_ABSOLUTE_THRESHOLD

Deprecated in 3.1 (to be removed in 4.0) because this value is too small to be useful as a default (cf. MATH-798).
Default absolute threshold.
private static final double
DEFAULT_RELATIVE_THRESHOLD

Deprecated in 3.1 (to be removed in 4.0) because this value is too small to be useful as a default (cf. MATH-798).
Default relative threshold.
private final double
relativeThreshold

Relative tolerance threshold.

Constructor Summary

AccessConstructor and Description
public
AbstractConvergenceChecker()
Deprecated in 3.1 (to be removed in 4.0).

Build an instance with default thresholds.

public
AbstractConvergenceChecker(final double
relative tolerance threshold
relativeThreshold, final double
absolute tolerance threshold
absoluteThreshold)

Build an instance with a specified thresholds.

Method Summary

Modifier and TypeMethod 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.optimization.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:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

absoluteThresholdback to summary
private final double absoluteThreshold

Absolute tolerance threshold.

DEFAULT_ABSOLUTE_THRESHOLDback to summary
private static final double DEFAULT_ABSOLUTE_THRESHOLD

Deprecated

in 3.1 (to be removed in 4.0) because this value is too small to be useful as a default (cf. MATH-798).

Default absolute threshold.

Annotations
@Deprecated
DEFAULT_RELATIVE_THRESHOLDback to summary
private static final double DEFAULT_RELATIVE_THRESHOLD

Deprecated

in 3.1 (to be removed in 4.0) because this value is too small to be useful as a default (cf. MATH-798).

Default relative threshold.

Annotations
@Deprecated
relativeThresholdback to summary
private final double relativeThreshold

Relative tolerance threshold.

Constructor Detail

AbstractConvergenceCheckerback to summary
public AbstractConvergenceChecker()

Deprecated

in 3.1 (to be removed in 4.0). Convergence thresholds are problem-dependent. As this class is intended for users who want to set their own convergence criterion instead of relying on an algorithm's default procedure, they should also set the thresholds appropriately (cf. MATH-798).

Build an instance with default thresholds.

Annotations
@Deprecated
AbstractConvergenceCheckerback 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

Method Detail

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

Redeclares org.apache.commons.math3.optimization.ConvergenceChecker.converged.

Doc from org.apache.commons.math3.optimization.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.

getAbsoluteThresholdback to summary
public double getAbsoluteThreshold()
Returns:double

the absolute threshold.

getRelativeThresholdback to summary
public double getRelativeThreshold()
Returns:double

the relative threshold.