public abstract class ConvergingAlgorithmImpl extends java.lang.Object implements ConvergingAlgorithm
Modifier and Type | Method and Description |
---|---|
double |
getAbsoluteAccuracy()
Deprecated.
Get the actual absolute accuracy.
|
int |
getIterationCount()
Deprecated.
Get the number of iterations in the last run of the algorithm.
|
int |
getMaximalIterationCount()
Deprecated.
Get the upper limit for the number of iterations.
|
double |
getRelativeAccuracy()
Deprecated.
Get the actual relative accuracy.
|
void |
resetAbsoluteAccuracy()
Deprecated.
Reset the absolute accuracy to the default.
|
void |
resetMaximalIterationCount()
Deprecated.
Reset the upper limit for the number of iterations to the default.
|
void |
resetRelativeAccuracy()
Deprecated.
Reset the relative accuracy to the default.
|
void |
setAbsoluteAccuracy(double accuracy)
Deprecated.
Set the absolute accuracy.
|
void |
setMaximalIterationCount(int count)
Deprecated.
Set the upper limit for the number of iterations.
|
void |
setRelativeAccuracy(double accuracy)
Deprecated.
Set the relative accuracy.
|
public int getIterationCount()
This is mainly meant for testing purposes. It may occasionally help track down performance problems: if the iteration count is notoriously high, check whether the problem is evaluated properly, and whether another algorithm is more amenable to the problem.
getIterationCount
in interface ConvergingAlgorithm
public void setAbsoluteAccuracy(double accuracy)
The default is usually chosen so that results in the interval -10..-0.1 and +0.1..+10 can be found with a reasonable accuracy. If the expected absolute value of your results is of much smaller magnitude, set this to a smaller value.
Algorithms are advised to do a plausibility check with the relative accuracy, but clients should not rely on this.
setAbsoluteAccuracy
in interface ConvergingAlgorithm
accuracy
- the accuracy.public double getAbsoluteAccuracy()
getAbsoluteAccuracy
in interface ConvergingAlgorithm
public void resetAbsoluteAccuracy()
The default value is provided by the algorithm implementation.
resetAbsoluteAccuracy
in interface ConvergingAlgorithm
public void setMaximalIterationCount(int count)
Usually a high iteration count indicates convergence problems. However, the "reasonable value" varies widely for different algorithms. Users are advised to use the default value supplied by the algorithm.
A ConvergenceException
will be thrown if this number
is exceeded.
setMaximalIterationCount
in interface ConvergingAlgorithm
count
- maximum number of iterationspublic int getMaximalIterationCount()
getMaximalIterationCount
in interface ConvergingAlgorithm
public void resetMaximalIterationCount()
The default value is supplied by the algorithm implementation.
resetMaximalIterationCount
in interface ConvergingAlgorithm
ConvergingAlgorithm.setMaximalIterationCount(int)
public void setRelativeAccuracy(double accuracy)
This is used to stop iterations if the absolute accuracy can't be achieved due to large values or short mantissa length.
If this should be the primary criterion for convergence rather then a
safety measure, set the absolute accuracy to a ridiculously small value,
like MathUtils.SAFE_MIN
.
setRelativeAccuracy
in interface ConvergingAlgorithm
accuracy
- the relative accuracy.public double getRelativeAccuracy()
getRelativeAccuracy
in interface ConvergingAlgorithm
public void resetRelativeAccuracy()
resetRelativeAccuracy
in interface ConvergingAlgorithm
Copyright © 2010 - 2020 Adobe. All Rights Reserved