Package org.hipparchus.analysis.solvers

Class NewtonRaphsonSolver

java.lang.Object

org.hipparchus.analysis.solvers.BaseAbstractUnivariateSolver<UnivariateDifferentiableFunction>

org.hipparchus.analysis.solvers.AbstractUnivariateDifferentiableSolver

org.hipparchus.analysis.solvers.NewtonRaphsonSolver

All Implemented Interfaces:

BaseUnivariateSolver<UnivariateDifferentiableFunction>, UnivariateDifferentiableSolver

public class NewtonRaphsonSolver
extends AbstractUnivariateDifferentiableSolver

Implements Newton's Method for finding zeros of real univariate differentiable functions.

Constructor Summary

Constructors

Constructor	Description
NewtonRaphsonSolver()	Construct a solver.
NewtonRaphsonSolver(double absoluteAccuracy)	Construct a solver.

Method Summary

Modifier and Type	Method	Description
protected double	doSolve()	Method for implementing actual optimization algorithms in derived classes.
double	solve(int maxEval, UnivariateDifferentiableFunction f, double min, double max)	Find a zero near the midpoint of min and max.

Methods inherited from class org.hipparchus.analysis.solvers.AbstractUnivariateDifferentiableSolver

computeObjectiveValueAndDerivative, setup

Methods inherited from class org.hipparchus.analysis.solvers.BaseAbstractUnivariateSolver

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

Methods inherited from interface org.hipparchus.analysis.solvers.BaseUnivariateSolver

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NewtonRaphsonSolver

public NewtonRaphsonSolver()

Construct a solver.

NewtonRaphsonSolver

public NewtonRaphsonSolver(double absoluteAccuracy)

Construct a solver.

Parameters:

absoluteAccuracy - Absolute accuracy.

Method Detail

solve

public double solve(int maxEval,
                    UnivariateDifferentiableFunction f,
                    double min,
                    double max)
             throws MathIllegalStateException

Find a zero near the midpoint of min and max.

Specified by:

solve in interface BaseUnivariateSolver<UnivariateDifferentiableFunction>

Overrides:

solve in class BaseAbstractUnivariateSolver<UnivariateDifferentiableFunction>

Parameters:

f - Function to solve.

min - Lower bound for the interval.

max - Upper bound for the interval.

maxEval - Maximum number of evaluations.

Returns:

the value where the function is zero.

Throws:

MathIllegalStateException - if the maximum evaluation count is exceeded.

MathIllegalArgumentException - if min >= max.

doSolve

protected double doSolve()
                  throws MathIllegalStateException

Method for implementing actual optimization algorithms in derived classes.

Specified by:

doSolve in class BaseAbstractUnivariateSolver<UnivariateDifferentiableFunction>

Returns:

the root.

Throws:

MathIllegalStateException - if the maximal number of evaluations is exceeded.