Top Description Fields Constructors Methods
org.apache.commons.math3.analysis.solvers

public abstract Class AbstractDifferentiableUnivariateSolver

extends BaseAbstractUnivariateSolver<DifferentiableUnivariateFunction>
implements DifferentiableUnivariateSolver
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.analysis.solvers.DifferentiableUnivariateSolver, org.apache.commons.math3.analysis.solvers.BaseUnivariateSolver
Known Direct Subclasses
org.apache.commons.math3.analysis.solvers.NewtonSolver
Annotations
@Deprecated
Imports
org.apache.commons.math3.analysis.DifferentiableUnivariateFunction, .UnivariateFunction, org.apache.commons.math3.exception.TooManyEvaluationsException

Deprecated

as of 3.1, replaced by AbstractUnivariateDifferentiableSolver

Provide a default implementation for several functions useful to generic solvers.
Since
3.0

Field Summary

Modifier and TypeField and Description
private UnivariateFunction
functionDerivative

Derivative of the function to solve.

Constructor Summary

AccessConstructor and Description
protected
AbstractDifferentiableUnivariateSolver(final double
Maximum absolute error.
absoluteAccuracy)

Construct a solver with given absolute accuracy.

protected
AbstractDifferentiableUnivariateSolver(final double
Maximum relative error.
relativeAccuracy, final double
Maximum absolute error.
absoluteAccuracy, final double
Maximum function value error.
functionValueAccuracy)

Construct a solver with given accuracies.

Method Summary

Modifier and TypeMethod and Description
protected double

Returns:

the objective function value at specified point.
computeDerivativeObjectiveValue(double
Point at which the objective function must be evaluated.
point)

Compute the objective function value.

protected void
setup(int
Maximum number of evaluations.
maxEval, DifferentiableUnivariateFunction
Function to solve.
f, double
Lower bound for the interval.
min, double
Upper bound for the interval.
max, double
Start value to use.
startValue)

Overrides org.apache.commons.math3.analysis.solvers.BaseAbstractUnivariateSolver.setup.

Deprecated as a consequence of DifferentiableUnivariateFunction being deprecated.

Prepare for computation.

Inherited from org.apache.commons.math3.analysis.solvers.BaseAbstractUnivariateSolver:
computeObjectiveValuedoSolvegetAbsoluteAccuracygetEvaluationsgetFunctionValueAccuracygetMaxgetMaxEvaluationsgetMingetRelativeAccuracygetStartValueincrementEvaluationCountisBracketingisSequencesolvesolvesolveverifyBracketingverifyIntervalverifySequence

Field Detail

functionDerivativeback to summary
private UnivariateFunction functionDerivative

Derivative of the function to solve.

Constructor Detail

AbstractDifferentiableUnivariateSolverback to summary
protected AbstractDifferentiableUnivariateSolver(final double absoluteAccuracy)

Construct a solver with given absolute accuracy.

Parameters
absoluteAccuracy:double

Maximum absolute error.

AbstractDifferentiableUnivariateSolverback to summary
protected AbstractDifferentiableUnivariateSolver(final double relativeAccuracy, final double absoluteAccuracy, final double functionValueAccuracy)

Construct a solver with given accuracies.

Parameters
relativeAccuracy:double

Maximum relative error.

absoluteAccuracy:double

Maximum absolute error.

functionValueAccuracy:double

Maximum function value error.

Method Detail

computeDerivativeObjectiveValueback to summary
protected double computeDerivativeObjectiveValue(double point) throws TooManyEvaluationsException

Compute the objective function value.

Parameters
point:double

Point at which the objective function must be evaluated.

Returns:double

the objective function value at specified point.

Exceptions
TooManyEvaluationsException:
if the maximal number of evaluations is exceeded.
setupback to summary
protected void setup(int maxEval, DifferentiableUnivariateFunction f, double min, double max, double startValue)

Overrides org.apache.commons.math3.analysis.solvers.BaseAbstractUnivariateSolver.setup.

Doc from org.apache.commons.math3.analysis.solvers.BaseAbstractUnivariateSolver.setup.

Deprecated

as a consequence of DifferentiableUnivariateFunction being deprecated. See corresponding docs for further information.

Prepare for computation. Subclasses must call this method if they override any of the solve methods.

Parameters
maxEval:int

Maximum number of evaluations.

f:DifferentiableUnivariateFunction

Function to solve.

min:double

Lower bound for the interval.

max:double

Upper bound for the interval.

startValue:double

Start value to use.

Annotations
@Override