|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.math.ConvergingAlgorithmImpl
org.apache.commons.math.analysis.solvers.UnivariateRealSolverImpl
org.apache.commons.math.analysis.solvers.SecantSolver
public class SecantSolver
Implements a modified version of the secant method for approximating a zero of a real univariate function.
The algorithm is modified to maintain bracketing of a root by successive approximations. Because of forced bracketing, convergence may be slower than the unrestricted secant algorithm. However, this implementation should in general outperform the regula falsi method.
The function is assumed to be continuous but not necessarily smooth.
Field Summary |
---|
Fields inherited from class org.apache.commons.math.analysis.solvers.UnivariateRealSolverImpl |
---|
defaultFunctionValueAccuracy, f, functionValue, functionValueAccuracy, result, resultComputed |
Fields inherited from class org.apache.commons.math.ConvergingAlgorithmImpl |
---|
absoluteAccuracy, defaultAbsoluteAccuracy, defaultMaximalIterationCount, defaultRelativeAccuracy, iterationCount, maximalIterationCount, relativeAccuracy |
Constructor Summary | |
---|---|
SecantSolver()
Construct a solver. |
|
SecantSolver(UnivariateRealFunction f)
Deprecated. as of 2.0 the function to solve is passed as an argument to the solve(UnivariateRealFunction, double, double) or
UnivariateRealSolver.solve(UnivariateRealFunction, double, double, double)
method. |
Method Summary | |
---|---|
double |
solve(double min,
double max)
Deprecated. |
double |
solve(double min,
double max,
double initial)
Deprecated. |
double |
solve(UnivariateRealFunction f,
double min,
double max)
Find a zero in the given interval. |
double |
solve(UnivariateRealFunction f,
double min,
double max,
double initial)
Find a zero in the given interval. |
Methods inherited from class org.apache.commons.math.analysis.solvers.UnivariateRealSolverImpl |
---|
checkResultComputed, clearResult, getFunctionValue, getFunctionValueAccuracy, getResult, isBracketing, isSequence, resetFunctionValueAccuracy, setFunctionValueAccuracy, setResult, setResult, verifyBracketing, verifyInterval, verifySequence |
Methods inherited from class org.apache.commons.math.ConvergingAlgorithmImpl |
---|
getAbsoluteAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, resetAbsoluteAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setMaximalIterationCount, setRelativeAccuracy |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.commons.math.ConvergingAlgorithm |
---|
getAbsoluteAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, resetAbsoluteAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setMaximalIterationCount, setRelativeAccuracy |
Constructor Detail |
---|
@Deprecated public SecantSolver(UnivariateRealFunction f)
solve(UnivariateRealFunction, double, double)
or
UnivariateRealSolver.solve(UnivariateRealFunction, double, double, double)
method.
f
- function to solve.public SecantSolver()
Method Detail |
---|
@Deprecated public double solve(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.
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@Deprecated public double solve(double min, double max, double initial) 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.
min
- the lower bound for the interval.max
- the upper bound for the interval.initial
- 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
functionpublic double solve(UnivariateRealFunction f, double min, double max, double initial) throws MaxIterationsExceededException, FunctionEvaluationException
f
- the function to solvemin
- the lower bound for the intervalmax
- the upper bound for the intervalinitial
- the start value to use (ignored)
MaxIterationsExceededException
- if the maximum iteration count is exceeded
FunctionEvaluationException
- if an error occurs evaluating the
function
IllegalArgumentException
- if min is not less than max or the
signs of the values of the function at the endpoints are not oppositespublic double solve(UnivariateRealFunction f, double min, double max) throws MaxIterationsExceededException, FunctionEvaluationException
f
- the function to solvemin
- the lower bound for the interval.max
- the upper bound for the interval.
MaxIterationsExceededException
- if the maximum iteration count is exceeded
FunctionEvaluationException
- if an error occurs evaluating the
function
IllegalArgumentException
- if min is not less than max or the
signs of the values of the function at the endpoints are not opposites
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |