Class BracketFinder
java.lang.Object
org.apache.commons.math3.optimization.univariate.BracketFinder
Deprecated.
As of 3.1 (to be removed in 4.0).
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final double
Deprecated.Tolerance to avoid division by zero.private final Incrementor
Deprecated.Counter for function evaluations.private double
Deprecated.Function value athi
.private double
Deprecated.Function value atlo
.private double
Deprecated.Function value atmid
.private static final double
Deprecated.Golden section.private final double
Deprecated.Factor for expanding the interval.private double
Deprecated.Higher bound of the bracket.private double
Deprecated.Lower bound of the bracket.private double
Deprecated.Point inside the bracket. -
Constructor Summary
ConstructorsConstructorDescriptionDeprecated.Constructor with default values100, 50
(see theother constructor
).BracketFinder
(double growLimit, int maxEvaluations) Deprecated.Create a bracketing interval finder. -
Method Summary
Modifier and TypeMethodDescriptionprivate double
eval
(UnivariateFunction f, double x) Deprecated.int
Deprecated.double
getFHi()
Deprecated.Get function value atgetHi()
.double
getFLo()
Deprecated.Get function value atgetLo()
.double
getFMid()
Deprecated.Get function value atgetMid()
.double
getHi()
Deprecated.double
getLo()
Deprecated.int
Deprecated.double
getMid()
Deprecated.void
search
(UnivariateFunction func, GoalType goal, double xA, double xB) Deprecated.Search new points that bracket a local optimum of the function.
-
Field Details
-
EPS_MIN
private static final double EPS_MINDeprecated.Tolerance to avoid division by zero.- See Also:
-
GOLD
private static final double GOLDDeprecated.Golden section.- See Also:
-
growLimit
private final double growLimitDeprecated.Factor for expanding the interval. -
evaluations
Deprecated.Counter for function evaluations. -
lo
private double loDeprecated.Lower bound of the bracket. -
hi
private double hiDeprecated.Higher bound of the bracket. -
mid
private double midDeprecated.Point inside the bracket. -
fLo
private double fLoDeprecated.Function value atlo
. -
fHi
private double fHiDeprecated.Function value athi
. -
fMid
private double fMidDeprecated.Function value atmid
.
-
-
Constructor Details
-
BracketFinder
public BracketFinder()Deprecated.Constructor with default values100, 50
(see theother constructor
). -
BracketFinder
public BracketFinder(double growLimit, int maxEvaluations) Deprecated.Create a bracketing interval finder.- Parameters:
growLimit
- Expanding factor.maxEvaluations
- Maximum number of evaluations allowed for finding a bracketing interval.
-
-
Method Details
-
search
Deprecated.Search new points that bracket a local optimum of the function.- Parameters:
func
- Function whose optimum should be bracketed.goal
-Goal type
.xA
- Initial point.xB
- Initial point.- Throws:
TooManyEvaluationsException
- if the maximum number of evaluations is exceeded.
-
getMaxEvaluations
public int getMaxEvaluations()Deprecated.- Returns:
- the number of evalutations.
-
getEvaluations
public int getEvaluations()Deprecated.- Returns:
- the number of evalutations.
-
getLo
public double getLo()Deprecated.- Returns:
- the lower bound of the bracket.
- See Also:
-
getFLo
public double getFLo()Deprecated.Get function value atgetLo()
.- Returns:
- function value at
getLo()
-
getHi
public double getHi()Deprecated.- Returns:
- the higher bound of the bracket.
- See Also:
-
getFHi
public double getFHi()Deprecated.Get function value atgetHi()
.- Returns:
- function value at
getHi()
-
getMid
public double getMid()Deprecated.- Returns:
- a point in the middle of the bracket.
- See Also:
-
getFMid
public double getFMid()Deprecated.Get function value atgetMid()
.- Returns:
- function value at
getMid()
-
eval
Deprecated.- Parameters:
f
- Function.x
- Argument.- Returns:
f(x)
- Throws:
TooManyEvaluationsException
- if the maximal number of evaluations is exceeded.
-