|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UnivariateRealSolver
Interface for (univariate real) rootfinding algorithms.
Implementations will search for only one zero in the given interval.
Method Summary | |
---|---|
double |
getFunctionValue()
Get the result of the last run of the solver. |
double |
getFunctionValueAccuracy()
Get the actual function value accuracy. |
double |
getResult()
Get the result of the last run of the solver. |
void |
resetFunctionValueAccuracy()
Reset the actual function accuracy to the default. |
void |
setFunctionValueAccuracy(double accuracy)
Set the function value accuracy. |
double |
solve(double min,
double max)
Deprecated. replaced by solve(UnivariateRealFunction, double, double)
since 2.0 |
double |
solve(double min,
double max,
double startValue)
Deprecated. replaced by solve(UnivariateRealFunction, double, double, double)
since 2.0 |
double |
solve(UnivariateRealFunction f,
double min,
double max)
Solve for a zero root in the given interval. |
double |
solve(UnivariateRealFunction f,
double min,
double max,
double startValue)
Solve for a zero in the given interval, start at startValue. |
Methods inherited from interface org.apache.commons.math.ConvergingAlgorithm |
---|
getAbsoluteAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, resetAbsoluteAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setMaximalIterationCount, setRelativeAccuracy |
Method Detail |
---|
void setFunctionValueAccuracy(double accuracy)
This is used to determine when an evaluated function value or some other value which is used as divisor is zero.
This is a safety guard and it shouldn't be necessary to change this in general.
accuracy
- the accuracy.
java.lang.IllegalArgumentException
- if the accuracy can't be achieved by
the solver or is otherwise deemed unreasonable.double getFunctionValueAccuracy()
void resetFunctionValueAccuracy()
@Deprecated double solve(double min, double max) throws ConvergenceException, FunctionEvaluationException
solve(UnivariateRealFunction, double, double)
since 2.0
A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.
min
- the lower bound for the interval.max
- the upper bound for the interval.
ConvergenceException
- if the maximum iteration count is exceeded
or the solver detects convergence problems otherwise.
FunctionEvaluationException
- if an error occurs evaluating the
function
java.lang.IllegalArgumentException
- if min > max or the endpoints do not
satisfy the requirements specified by the solverdouble solve(UnivariateRealFunction f, double min, double max) throws ConvergenceException, FunctionEvaluationException
A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.
f
- the function to solve.min
- the lower bound for the interval.max
- the upper bound for the interval.
ConvergenceException
- if the maximum iteration count is exceeded
or the solver detects convergence problems otherwise.
FunctionEvaluationException
- if an error occurs evaluating the
function
java.lang.IllegalArgumentException
- if min > max or the endpoints do not
satisfy the requirements specified by the solver@Deprecated double solve(double min, double max, double startValue) throws ConvergenceException, FunctionEvaluationException, java.lang.IllegalArgumentException
solve(UnivariateRealFunction, double, double, double)
since 2.0
A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.
min
- the lower bound for the interval.max
- the upper bound for the interval.startValue
- the start value to use
ConvergenceException
- if the maximum iteration count is exceeded
or the solver detects convergence problems otherwise.
FunctionEvaluationException
- if an error occurs evaluating the
function
java.lang.IllegalArgumentException
- if min > max or the arguments do not
satisfy the requirements specified by the solverdouble solve(UnivariateRealFunction f, double min, double max, double startValue) throws ConvergenceException, FunctionEvaluationException, java.lang.IllegalArgumentException
A solver may require that the interval brackets a single zero root. Solvers that do require bracketing should be able to handle the case where one of the endpoints is itself a root.
f
- the function to solve.min
- the lower bound for the interval.max
- the upper bound for the interval.startValue
- the start value to use
ConvergenceException
- if the maximum iteration count is exceeded
or the solver detects convergence problems otherwise.
FunctionEvaluationException
- if an error occurs evaluating the
function
java.lang.IllegalArgumentException
- if min > max or the arguments do not
satisfy the requirements specified by the solverdouble getResult()
java.lang.IllegalStateException
- if there is no result available, either
because no result was yet computed or the last attempt failed.double getFunctionValue()
java.lang.IllegalStateException
- if there is no result available, either
because no result was yet computed or the last attempt failed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |