org.apache.commons.math.analysis.solvers
Class AbstractDifferentiableUnivariateRealSolver

java.lang.Object
  org.apache.commons.math.analysis.solvers.BaseAbstractUnivariateRealSolver<DifferentiableUnivariateRealFunction>
      org.apache.commons.math.analysis.solvers.AbstractDifferentiableUnivariateRealSolver

All Implemented Interfaces:

BaseUnivariateRealSolver<DifferentiableUnivariateRealFunction>, DifferentiableUnivariateRealSolver

Direct Known Subclasses:

NewtonSolver

public abstract class AbstractDifferentiableUnivariateRealSolver
extends BaseAbstractUnivariateRealSolver<DifferentiableUnivariateRealFunction>
implements DifferentiableUnivariateRealSolver

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

Since:

3.0

Version:

$Id$

Constructor Summary

protected	AbstractDifferentiableUnivariateRealSolver(double absoluteAccuracy) Construct a solver with given absolute accuracy.
protected	AbstractDifferentiableUnivariateRealSolver(double relativeAccuracy, double absoluteAccuracy, double functionValueAccuracy) Construct a solver with given accuracies.

Method Summary

protected double	computeDerivativeObjectiveValue(double point) Compute the objective function value.
protected void	setup(int maxEval, DifferentiableUnivariateRealFunction f, double min, double max, double startValue) Prepare for computation.

Methods inherited from class org.apache.commons.math.analysis.solvers.BaseAbstractUnivariateRealSolver

computeObjectiveValue, doSolve, getAbsoluteAccuracy, getEvaluations, getFunctionValueAccuracy, getMax, getMaxEvaluations, getMin, getRelativeAccuracy, getStartValue, incrementEvaluationCount, isBracketing, isSequence, solve, solve, solve, verifyBracketing, verifyInterval, verifySequence

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.analysis.solvers.BaseUnivariateRealSolver

getAbsoluteAccuracy, getEvaluations, getFunctionValueAccuracy, getMaxEvaluations, getRelativeAccuracy, solve, solve, solve

Constructor Detail

AbstractDifferentiableUnivariateRealSolver

protected AbstractDifferentiableUnivariateRealSolver(double absoluteAccuracy)

Construct a solver with given absolute accuracy.

Parameters:

absoluteAccuracy - Maximum absolute error.

AbstractDifferentiableUnivariateRealSolver

protected AbstractDifferentiableUnivariateRealSolver(double relativeAccuracy,
                                                     double absoluteAccuracy,
                                                     double functionValueAccuracy)

Construct a solver with given accuracies.

Parameters:

relativeAccuracy - Maximum relative error.

absoluteAccuracy - Maximum absolute error.

functionValueAccuracy - Maximum function value error.

Method Detail

computeDerivativeObjectiveValue

protected double computeDerivativeObjectiveValue(double point)

Compute the objective function value.

Parameters:

point - Point at which the objective function must be evaluated.

Returns:

the objective function value at specified point.

Throws:

TooManyEvaluationsException - if the maximal number of evaluations is exceeded.

setup

protected void setup(int maxEval,
                     DifferentiableUnivariateRealFunction f,
                     double min,
                     double max,
                     double startValue)

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

Overrides:

setup in class BaseAbstractUnivariateRealSolver<DifferentiableUnivariateRealFunction>

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.