|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math3.optimization.AbstractConvergenceChecker<PointValuePair>
org.apache.commons.math3.optimization.SimpleValueChecker
@Deprecated public class SimpleValueChecker
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
).
Constructor Summary | |
---|---|
SimpleValueChecker()
Deprecated. See AbstractConvergenceChecker.AbstractConvergenceChecker() |
|
SimpleValueChecker(double relativeThreshold,
double absoluteThreshold)
Deprecated. Build an instance with specified thresholds. |
|
SimpleValueChecker(double relativeThreshold,
double absoluteThreshold,
int maxIter)
Deprecated. Builds an instance with specified thresholds. |
Method Summary | |
---|---|
boolean |
converged(int iteration,
PointValuePair previous,
PointValuePair current)
Deprecated. Check if the optimization algorithm has converged considering the last two points. |
Methods inherited from class org.apache.commons.math3.optimization.AbstractConvergenceChecker |
---|
getAbsoluteThreshold, getRelativeThreshold |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
@Deprecated public SimpleValueChecker()
AbstractConvergenceChecker.AbstractConvergenceChecker()
public SimpleValueChecker(double relativeThreshold, double absoluteThreshold)
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance thresholdpublic SimpleValueChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance thresholdmaxIter
- Maximum iteration count.
NotStrictlyPositiveException
- if maxIter <= 0
.Method Detail |
---|
public boolean converged(int iteration, PointValuePair previous, PointValuePair current)
converged
in interface ConvergenceChecker<PointValuePair>
converged
in class AbstractConvergenceChecker<PointValuePair>
iteration
- Index of current iterationprevious
- Best point in the previous iteration.current
- Best point in the current iteration.
true
if the algorithm has converged.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |