Class RiddersSolver

java.lang.Object

org.apache.commons.math3.analysis.solvers.BaseAbstractUnivariateSolver<UnivariateFunction>

org.apache.commons.math3.analysis.solvers.AbstractUnivariateSolver

org.apache.commons.math3.analysis.solvers.RiddersSolver

All Implemented Interfaces:

BaseUnivariateSolver<UnivariateFunction>, UnivariateSolver

public class RiddersSolver
extends AbstractUnivariateSolver

Implements the Ridders' Method for root finding of real univariate functions. For reference, see C. Ridders, A new algorithm for computing a single root of a real continuous function , IEEE Transactions on Circuits and Systems, 26 (1979), 979 - 980.

The function should be continuous but not necessarily smooth.

Since:

1.2

Field Summary

Fields

Modifier and Type	Field	Description
private static final double	DEFAULT_ABSOLUTE_ACCURACY	Default absolute accuracy.

Constructor Summary

Constructors

Constructor	Description
RiddersSolver()	Construct a solver with default accuracy (1e-6).
RiddersSolver(double absoluteAccuracy)	Construct a solver.
RiddersSolver(double relativeAccuracy, double absoluteAccuracy)	Construct a solver.

Method Summary

Modifier and Type	Method	Description
protected double	doSolve()	Method for implementing actual optimization algorithms in derived classes.

Methods inherited from class BaseAbstractUnivariateSolver

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface BaseUnivariateSolver

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

Field Details

DEFAULT_ABSOLUTE_ACCURACY

private static final double DEFAULT_ABSOLUTE_ACCURACY

Default absolute accuracy.

See Also:

• Constant Field Values

Constructor Details

RiddersSolver

public RiddersSolver()

Construct a solver with default accuracy (1e-6).

RiddersSolver

public RiddersSolver(double absoluteAccuracy)

Construct a solver.

Parameters:

absoluteAccuracy - Absolute accuracy.

RiddersSolver

public RiddersSolver(double relativeAccuracy,
 double absoluteAccuracy)

Construct a solver.

Parameters:

relativeAccuracy - Relative accuracy.

absoluteAccuracy - Absolute accuracy.

Method Details

doSolve

protected double doSolve()
                  throws TooManyEvaluationsException,
NoBracketingException

Method for implementing actual optimization algorithms in derived classes.

Specified by:

doSolve in class BaseAbstractUnivariateSolver<UnivariateFunction>

Returns:

the root.

Throws:

TooManyEvaluationsException - if the maximal number of evaluations is exceeded.

NoBracketingException - if the initial search interval does not bracket a root and the solver requires it.