|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math3.optimization.AbstractConvergenceChecker<PAIR>
org.apache.commons.math3.optimization.SimplePointChecker<PAIR>
PAIR
- Type of the (point, value) pair.
The type of the "value" part of the pair (not used by this class).
@Deprecated public class SimplePointChecker<PAIR extends Pair<double[],? extends Object>>
Simple implementation of the ConvergenceChecker
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.
The converged
method will also return
true
if the number of iterations has been set (see
this constructor
).
Constructor Summary | |
---|---|
SimplePointChecker()
Deprecated. See AbstractConvergenceChecker.AbstractConvergenceChecker() |
|
SimplePointChecker(double relativeThreshold,
double absoluteThreshold)
Deprecated. Build an instance with specified thresholds. |
|
SimplePointChecker(double relativeThreshold,
double absoluteThreshold,
int maxIter)
Deprecated. Builds an instance with specified thresholds. |
Method Summary | |
---|---|
boolean |
converged(int iteration,
PAIR previous,
PAIR 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 SimplePointChecker()
AbstractConvergenceChecker.AbstractConvergenceChecker()
public SimplePointChecker(double relativeThreshold, double absoluteThreshold)
relativeThreshold
- relative tolerance thresholdabsoluteThreshold
- absolute tolerance thresholdpublic SimplePointChecker(double relativeThreshold, double absoluteThreshold, int maxIter)
relativeThreshold
- Relative tolerance threshold.absoluteThreshold
- Absolute tolerance threshold.maxIter
- Maximum iteration count.
NotStrictlyPositiveException
- if maxIter <= 0
.Method Detail |
---|
public boolean converged(int iteration, PAIR previous, PAIR current)
converged
in interface ConvergenceChecker<PAIR extends Pair<double[],? extends Object>>
converged
in class AbstractConvergenceChecker<PAIR extends Pair<double[],? extends Object>>
iteration
- Index of current iterationprevious
- Best point in the previous iteration.current
- Best point in the current iteration.
true
if the arguments satify the convergence criterion.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |