|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.optimization.SimpleVectorialPointChecker
public class SimpleVectorialPointChecker
Simple implementation of the VectorialConvergenceChecker
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.
Field Summary | |
---|---|
private double |
absoluteThreshold
Absolute tolerance threshold. |
private static double |
DEFAULT_ABSOLUTE_THRESHOLD
Default absolute threshold. |
private static double |
DEFAULT_RELATIVE_THRESHOLD
Default relative threshold. |
private double |
relativeThreshold
Relative tolerance threshold. |
Constructor Summary | |
---|---|
SimpleVectorialPointChecker()
Build an instance with default threshold. |
|
SimpleVectorialPointChecker(double relativeThreshold,
double absoluteThreshold)
Build an instance with a specified threshold. |
Method Summary | |
---|---|
boolean |
converged(int iteration,
VectorialPointValuePair previous,
VectorialPointValuePair current)
Check if the optimization algorithm has converged considering the last points. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final double DEFAULT_RELATIVE_THRESHOLD
private static final double DEFAULT_ABSOLUTE_THRESHOLD
private final double relativeThreshold
private final double absoluteThreshold
Constructor Detail |
---|
public SimpleVectorialPointChecker()
public SimpleVectorialPointChecker(double relativeThreshold, double absoluteThreshold)
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.
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance thresholdMethod Detail |
---|
public boolean converged(int iteration, VectorialPointValuePair previous, VectorialPointValuePair current)
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.
converged
in interface VectorialConvergenceChecker
iteration
- index of current iterationprevious
- point from previous iterationcurrent
- point from current iteration
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |