Class BracketFinder
java.lang.Object
org.apache.commons.math.optimization.univariate.BracketFinder
Provide an interval that brackets a local optimum of a function.
This code is based on a Python implementation (from SciPy,
module
optimize.py
v0.5).- Since:
- 2.2
- Version:
- $Revision$ $Date$
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor with default values100, 50
(see theother constructor
).BracketFinder
(double growLimit, int maxIterations) Create a bracketing interval finder. -
Method Summary
Modifier and TypeMethodDescriptionint
double
getFHi()
Get function value atgetHi()
.double
getFLow()
Get function value atgetLo()
.double
getFMid()
Get function value atgetMid()
.double
getHi()
int
double
getLo()
double
getMid()
void
search
(UnivariateRealFunction func, GoalType goal, double xA, double xB) Search new points that bracket a local optimum of the function.
-
Constructor Details
-
BracketFinder
public BracketFinder()Constructor with default values100, 50
(see theother constructor
). -
BracketFinder
public BracketFinder(double growLimit, int maxIterations) Create a bracketing interval finder.- Parameters:
growLimit
- Expanding factor.maxIterations
- Maximum number of iterations allowed for finding a bracketing interval.
-
-
Method Details
-
search
public void search(UnivariateRealFunction func, GoalType goal, double xA, double xB) throws MaxIterationsExceededException, FunctionEvaluationException Search new points that bracket a local optimum of the function.- Parameters:
func
- Function whose optimum should be bracketted.goal
-Goal type
.xA
- Initial point.xB
- Initial point.- Throws:
MaxIterationsExceededException
- if the maximum iteration count is exceeded.FunctionEvaluationException
- if an error occurs evaluating the function.
-
getIterations
public int getIterations()- Returns:
- the number of iterations.
-
getEvaluations
public int getEvaluations()- Returns:
- the number of evaluations.
-
getLo
public double getLo()- Returns:
- the lower bound of the bracket.
- See Also:
-
getFLow
public double getFLow()Get function value atgetLo()
.- Returns:
- function value at
getLo()
-
getHi
public double getHi()- Returns:
- the higher bound of the bracket.
- See Also:
-
getFHi
public double getFHi()Get function value atgetHi()
.- Returns:
- function value at
getHi()
-
getMid
public double getMid()- Returns:
- a point in the middle of the bracket.
- See Also:
-
getFMid
public double getFMid()Get function value atgetMid()
.- Returns:
- function value at
getMid()
-