org.apache.commons.math3.analysis.solvers
Interface BracketedUnivariateSolver<FUNC extends UnivariateFunction>

Type Parameters:
FUNC - Type of function to solve.
All Superinterfaces:
BaseUnivariateSolver<FUNC>
All Known Implementing Classes:
BaseSecantSolver, BracketingNthOrderBrentSolver, IllinoisSolver, PegasusSolver, RegulaFalsiSolver

public interface BracketedUnivariateSolver<FUNC extends UnivariateFunction>
extends BaseUnivariateSolver<FUNC>

Interface for (univariate real) root-finding algorithms that maintain a bracketed solution. There are several advantages to having such root-finding algorithms:

For backwards compatibility, all root-finding algorithms must have ANY_SIDE as default for the allowed solutions.

Since:
3.0
Version:
$Id: BracketedUnivariateSolver.java 1364387 2012-07-22 18:14:11Z tn $
See Also:
AllowedSolution

Method Summary
 double solve(int maxEval, FUNC f, double min, double max, AllowedSolution allowedSolution)
          Solve for a zero in the given interval.
 double solve(int maxEval, FUNC f, double min, double max, double startValue, AllowedSolution allowedSolution)
          Solve for a zero in the given interval, start at startValue.
 
Methods inherited from interface org.apache.commons.math3.analysis.solvers.BaseUnivariateSolver
getAbsoluteAccuracy, getEvaluations, getFunctionValueAccuracy, getMaxEvaluations, getRelativeAccuracy, solve, solve, solve
 

Method Detail

solve

double solve(int maxEval,
             FUNC f,
             double min,
             double max,
             AllowedSolution allowedSolution)
Solve for a zero in the given interval. 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.

Parameters:
maxEval - Maximum number of evaluations.
f - Function to solve.
min - Lower bound for the interval.
max - Upper bound for the interval.
allowedSolution - The kind of solutions that the root-finding algorithm may accept as solutions.
Returns:
A value where the function is zero.
Throws:
MathIllegalArgumentException - if the arguments do not satisfy the requirements specified by the solver.
TooManyEvaluationsException - if the allowed number of evaluations is exceeded.

solve

double solve(int maxEval,
             FUNC f,
             double min,
             double max,
             double startValue,
             AllowedSolution allowedSolution)
Solve for a zero in the given interval, start at startValue. 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.

Parameters:
maxEval - Maximum number of evaluations.
f - Function to solve.
min - Lower bound for the interval.
max - Upper bound for the interval.
startValue - Start value to use.
allowedSolution - The kind of solutions that the root-finding algorithm may accept as solutions.
Returns:
A value where the function is zero.
Throws:
MathIllegalArgumentException - if the arguments do not satisfy the requirements specified by the solver.
TooManyEvaluationsException - if the allowed number of evaluations is exceeded.


Copyright © 2003-2012 The Apache Software Foundation. All Rights Reserved.