org.apache.commons.math.analysis
Class NewtonSolver

java.lang.Object
  extended by org.apache.commons.math.analysis.UnivariateRealSolverImpl
      extended by org.apache.commons.math.analysis.NewtonSolver
All Implemented Interfaces:
java.io.Serializable, UnivariateRealSolver

public class NewtonSolver
extends UnivariateRealSolverImpl

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

The function should be continuous but not necessarily smooth.

Version:
$Revision: 348791 $ $Date: 2005-11-24 12:50:36 -0700 (Thu, 24 Nov 2005) $
See Also:
Serialized Form

Field Summary
private  UnivariateRealFunction derivative
          The first derivative of the target function.
private static long serialVersionUID
          Serializable version identifier
 
Fields inherited from class org.apache.commons.math.analysis.UnivariateRealSolverImpl
absoluteAccuracy, defaultAbsoluteAccuracy, defaultFunctionValueAccuracy, defaultMaximalIterationCount, defaultRelativeAccuracy, f, functionValueAccuracy, iterationCount, maximalIterationCount, relativeAccuracy, result, resultComputed
 
Constructor Summary
NewtonSolver(DifferentiableUnivariateRealFunction f)
          Construct a solver for the given function.
 
Method Summary
private  void readObject(java.io.ObjectInputStream in)
          Custom deserialization to initialize transient deriviate field.
 double solve(double min, double max)
          Find a zero near the midpoint of min and max.
 double solve(double min, double max, double startValue)
          Find a zero near the value startValue.
 
Methods inherited from class org.apache.commons.math.analysis.UnivariateRealSolverImpl
clearResult, getAbsoluteAccuracy, getFunctionValueAccuracy, getIterationCount, getMaximalIterationCount, getRelativeAccuracy, getResult, isBracketing, isSequence, resetAbsoluteAccuracy, resetFunctionValueAccuracy, resetMaximalIterationCount, resetRelativeAccuracy, setAbsoluteAccuracy, setFunctionValueAccuracy, setMaximalIterationCount, setRelativeAccuracy, setResult, verifyBracketing, verifyInterval, verifySequence
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serializable version identifier

See Also:
Constant Field Values

derivative

private transient UnivariateRealFunction derivative
The first derivative of the target function.

Constructor Detail

NewtonSolver

public NewtonSolver(DifferentiableUnivariateRealFunction f)
Construct a solver for the given function.

Parameters:
f - function to solve.
Method Detail

solve

public double solve(double min,
                    double max)
             throws ConvergenceException,
                    FunctionEvaluationException
Find a zero near the midpoint of min and max.

Parameters:
min - the lower bound for the interval
max - the upper bound for the interval
Returns:
the value where the function is zero
Throws:
ConvergenceException - if the maximum iteration count is exceeded
FunctionEvaluationException - if an error occurs evaluating the function or derivative
java.lang.IllegalArgumentException - if min is not less than max

solve

public double solve(double min,
                    double max,
                    double startValue)
             throws ConvergenceException,
                    FunctionEvaluationException
Find a zero near the value startValue.

Parameters:
min - the lower bound for the interval (ignored).
max - the upper bound for the interval (ignored).
startValue - the start value to use.
Returns:
the value where the function is zero
Throws:
ConvergenceException - if the maximum iteration count is exceeded
FunctionEvaluationException - if an error occurs evaluating the function or derivative
java.lang.IllegalArgumentException - if startValue is not between min and max

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
Custom deserialization to initialize transient deriviate field.

Parameters:
in - serialized object input stream
Throws:
java.io.IOException - if IO error occurs
java.lang.ClassNotFoundException - if instantiation error occurs