Class SimpleVectorialValueChecker
- All Implemented Interfaces:
VectorialConvergenceChecker
VectorialConvergenceChecker
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.
- Since:
- 2.0
- Version:
- $Revision: 990655 $ $Date: 2010-08-29 23:49:40 +0200 (dim. 29 août 2010) $
-
Constructor Summary
ConstructorsConstructorDescriptionBuild an instance with default threshold.SimpleVectorialValueChecker
(double relativeThreshold, double absoluteThreshold) Build an instance with a specified threshold. -
Method Summary
Modifier and TypeMethodDescriptionboolean
converged
(int iteration, VectorialPointValuePair previous, VectorialPointValuePair current) Check if the optimization algorithm has converged considering the last points.
-
Constructor Details
-
SimpleVectorialValueChecker
public SimpleVectorialValueChecker()Build an instance with default threshold. -
SimpleVectorialValueChecker
public SimpleVectorialValueChecker(double relativeThreshold, double absoluteThreshold) Build an instance with a specified threshold.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
-
-
Method Details
-
converged
public boolean converged(int iteration, VectorialPointValuePair previous, VectorialPointValuePair current) Check if the optimization algorithm has converged considering the last points.This method may be called several time 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 interfaceVectorialConvergenceChecker
- Parameters:
iteration
- index of current iterationprevious
- point from previous iterationcurrent
- point from current iteration- Returns:
- true if the algorithm is considered to have converged
-