Package org.apache.commons.math3.optim
Class SimplePointChecker<PAIR extends Pair<double[],? extends java.lang.Object>>
- java.lang.Object
-
- org.apache.commons.math3.optim.AbstractConvergenceChecker<PAIR>
-
- org.apache.commons.math3.optim.SimplePointChecker<PAIR>
-
- Type Parameters:
PAIR
- Type of the (point, value) pair. The type of the "value" part of the pair (not used by this class).
- All Implemented Interfaces:
ConvergenceChecker<PAIR>
public class SimplePointChecker<PAIR extends Pair<double[],? extends java.lang.Object>> extends AbstractConvergenceChecker<PAIR>
Simple implementation of theConvergenceChecker
interface using only point coordinates. Convergence is considered to have been reached if either the relative difference between each point coordinate are smaller than a threshold or if either the absolute difference between the point coordinates are smaller than another threshold.
Theconverged
method will also returntrue
if the number of iterations has been set (seethis constructor
).- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private static int
ITERATION_CHECK_DISABLED
IfmaxIterationCount
is set to this value, the number of iterations will never causeconverged(int, Pair, Pair)
to returntrue
.private int
maxIterationCount
Number of iterations after which theconverged(int, Pair, Pair)
method will return true (unless the check is disabled).
-
Constructor Summary
Constructors Constructor Description SimplePointChecker(double relativeThreshold, double absoluteThreshold)
Build an instance with specified thresholds.SimplePointChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
Builds an instance with specified thresholds.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
converged(int iteration, PAIR previous, PAIR current)
Check if the optimization algorithm has converged considering the last two points.-
Methods inherited from class org.apache.commons.math3.optim.AbstractConvergenceChecker
getAbsoluteThreshold, getRelativeThreshold
-
-
-
-
Field Detail
-
ITERATION_CHECK_DISABLED
private static final int ITERATION_CHECK_DISABLED
IfmaxIterationCount
is set to this value, the number of iterations will never causeconverged(int, Pair, Pair)
to returntrue
.- See Also:
- Constant Field Values
-
maxIterationCount
private final int maxIterationCount
Number of iterations after which theconverged(int, Pair, Pair)
method will return true (unless the check is disabled).
-
-
Constructor Detail
-
SimplePointChecker
public SimplePointChecker(double relativeThreshold, double absoluteThreshold)
Build an instance with specified thresholds. In order to perform only relative checks, the absolute tolerance must be set to a negative value. In order to perform only absolute checks, the relative tolerance must be set to a negative value.- Parameters:
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance threshold
-
SimplePointChecker
public SimplePointChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
Builds an instance with specified thresholds. In order to perform only relative checks, the absolute tolerance must be set to a negative value. In order to perform only absolute checks, the relative tolerance must be set to a negative value.- Parameters:
relativeThreshold
- Relative tolerance threshold.absoluteThreshold
- Absolute tolerance threshold.maxIter
- Maximum iteration count.- Throws:
NotStrictlyPositiveException
- ifmaxIter <= 0
.- Since:
- 3.1
-
-
Method Detail
-
converged
public boolean converged(int iteration, PAIR previous, PAIR current)
Check if the optimization algorithm has converged considering the last two points. This method may be called several times from the same algorithm iteration with different points. This can be detected by checking the iteration number at each call if needed. Each time this method is called, the previous and current point correspond to points with the same role at each iteration, so they can be compared. As an example, simplex-based algorithms call this method for all points of the simplex, not only for the best or worst ones.- Specified by:
converged
in interfaceConvergenceChecker<PAIR extends Pair<double[],? extends java.lang.Object>>
- Specified by:
converged
in classAbstractConvergenceChecker<PAIR extends Pair<double[],? extends java.lang.Object>>
- Parameters:
iteration
- Index of current iterationprevious
- Best point in the previous iteration.current
- Best point in the current iteration.- Returns:
true
if the arguments satify the convergence criterion.
-
-