Class SimpleVectorValueChecker
- java.lang.Object
-
- org.apache.commons.math4.legacy.optim.AbstractConvergenceChecker<PointVectorValuePair>
-
- org.apache.commons.math4.legacy.optim.SimpleVectorValueChecker
-
- All Implemented Interfaces:
ConvergenceChecker<PointVectorValuePair>
public class SimpleVectorValueChecker extends AbstractConvergenceChecker<PointVectorValuePair>
Simple implementation of theConvergenceChecker
interface using only objective function values. Convergence is considered to have been reached if either the relative difference between the objective function values is smaller than a threshold or if either the absolute difference between the objective function values is smaller than another threshold for all vectors elements.
Theconverged
method will also returntrue
if the number of iterations has been set (seethis constructor
).- Since:
- 3.0
-
-
Constructor Summary
Constructors Constructor Description SimpleVectorValueChecker(double relativeThreshold, double absoluteThreshold)
Build an instance with specified thresholds.SimpleVectorValueChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
Builds an instance with specified tolerance thresholds and iteration count.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
converged(int iteration, PointVectorValuePair previous, PointVectorValuePair current)
Check if the optimization algorithm has converged considering the last two points.-
Methods inherited from class org.apache.commons.math4.legacy.optim.AbstractConvergenceChecker
getAbsoluteThreshold, getRelativeThreshold
-
-
-
-
Constructor Detail
-
SimpleVectorValueChecker
public SimpleVectorValueChecker(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
-
SimpleVectorValueChecker
public SimpleVectorValueChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
Builds an instance with specified tolerance thresholds and iteration count. 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, PointVectorValuePair previous, PointVectorValuePair 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<PointVectorValuePair>
- Specified by:
converged
in classAbstractConvergenceChecker<PointVectorValuePair>
- Parameters:
iteration
- Index of current iterationprevious
- Best point in the previous iteration.current
- Best point in the current iteration.- Returns:
true
if the arguments satisfy the convergence criterion.
-
-