SimpleValueChecker (Apache Commons Math 3.3 API)

java.lang.Object
- org.apache.commons.math3.optim.AbstractConvergenceChecker<PointValuePair>
- - org.apache.commons.math3.optim.SimpleValueChecker

All Implemented Interfaces:

ConvergenceChecker<PointValuePair>
```
public class SimpleValueChecker
extends AbstractConvergenceChecker<PointValuePair>
```
Simple implementation of the ConvergenceChecker 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.
The converged method will also return true if the number of iterations has been set (see this constructor).

Since:

3.0

Version:

$Id: SimpleValueChecker.java 1591835 2014-05-02 09:04:01Z tn $

Constructor Summary

Constructors
Constructor and Description
`SimpleValueChecker(double relativeThreshold, double absoluteThreshold)` Build an instance with specified thresholds.
`SimpleValueChecker(double relativeThreshold, double absoluteThreshold, int maxIter)` Builds an instance with specified thresholds.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`converged(int iteration, PointValuePair previous, PointValuePair 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SimpleValueChecker
```
public SimpleValueChecker(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 threshold
    absoluteThreshold - absolute tolerance threshold
  - SimpleValueChecker
```
public SimpleValueChecker(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 - if maxIter <= 0.
    Since:
    
    3.1
- Method Detail
  - converged
```
public boolean converged(int iteration,
                PointValuePair previous,
                PointValuePair current)
```
    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.
    
    Specified by:
    
    converged in interface ConvergenceChecker<PointValuePair>
    
    Specified by:
    
    converged in class AbstractConvergenceChecker<PointValuePair>
    
    Parameters:
    iteration - Index of current iteration
    previous - Best point in the previous iteration.
    current - Best point in the current iteration.
    
    Returns:
    true if the algorithm has converged.

Class SimpleValueChecker

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.math3.optim.AbstractConvergenceChecker

Methods inherited from class java.lang.Object

Constructor Detail

SimpleValueChecker

SimpleValueChecker

Method Detail

converged