Deprecated
As of 3.1 (to be removed in 4.0).
org.apache.commons.math3.optimization.ConvergenceChecker interface
that uses 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.
converged method will also return true if the number of iterations
has been set (see this constructor).
| Modifier and Type | Field and Description |
|---|---|
| private static final int | ITERATION_CHECK_DISABLED
If |
| private final int | maxIterationCount
Number of iterations after which the
|
| Access | Constructor and Description |
|---|---|
| public | SimpleUnivariateValueChecker()
Deprecated
See
AbstractConvergenceChecker#AbstractConvergenceChecker()
Build an instance with default thresholds. |
| public | SimpleUnivariateValueChecker(final double
relative tolerance threshold relativeThreshold, final double absolute tolerance threshold absoluteThreshold)Build an instance with specified thresholds. |
| public | SimpleUnivariateValueChecker(final double
relative tolerance threshold relativeThreshold, final double absolute tolerance threshold absoluteThreshold, final int Maximum iteration count. maxIter)Builds an instance with specified thresholds. |
| Modifier and Type | Method and Description |
|---|---|
| public boolean | Returns: true if the algorithm has converged.Index of current iteration iteration, final UnivariatePointValuePair Best point in the previous iteration. previous, final UnivariatePointValuePair Best point in the current iteration. current)Implements abstract org. Implements org.
Deprecated
as a consequence of
UnivariatePointValuePair being deprecated.
Check if the optimization algorithm has converged considering the last two points. |
| ITERATION_CHECK_DISABLED | back to summary |
|---|---|
| private static final int ITERATION_CHECK_DISABLED If | |
| maxIterationCount | back to summary |
|---|---|
| private final int maxIterationCount Number of iterations after which the
| |
| SimpleUnivariateValueChecker | back to summary |
|---|---|
| public SimpleUnivariateValueChecker()
Deprecated Build an instance with default thresholds.
| |
| SimpleUnivariateValueChecker | back to summary |
|---|---|
| public SimpleUnivariateValueChecker(final double relativeThreshold, final 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.
| |
| SimpleUnivariateValueChecker | back to summary |
|---|---|
| public SimpleUnivariateValueChecker(final double relativeThreshold, final double absoluteThreshold, final 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.
| |
| converged | back to summary |
|---|---|
| public boolean converged(final int iteration, final UnivariatePointValuePair previous, final UnivariatePointValuePair current) Implements abstract org. Implements org. Deprecated as a consequence of Check if the optimization algorithm has converged considering the last two 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.
| |