Click or drag to resize

NewtonRaphsonRootFinder Class

Class NewtonRaphsonRootFinder finds roots of univariate functions using the Newton-Raphson algorithm.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreRootFinderBase
    CenterSpace.NMath.CoreNewtonRaphsonRootFinder

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.4
Syntax
[SerializableAttribute]
public class NewtonRaphsonRootFinder : RootFinderBase, 
	IOneVariableDRootFinder, ICloneable

The NewtonRaphsonRootFinder type exposes the following members.

Constructors
  NameDescription
Public methodNewtonRaphsonRootFinder
Constructs a NewtonRaphsonRootFinder instance with default tolerance and default maximum iterations.
Public methodNewtonRaphsonRootFinder(Double)
Constructs a NewtonRaphsonRootFinder instance with the given error tolerance.
Public methodNewtonRaphsonRootFinder(Int32)
Constructs a NewtonRaphsonRootFinder instance with the given maximum number of iterations.
Public methodNewtonRaphsonRootFinder(Double, Int32)
Constructs a NewtonRaphsonRootFinder instance with the given error tolerance and maximum number of iterations.
Top
Properties
  NameDescription
Public propertyError
Gets the error associated with the root just computed.
(Inherited from RootFinderBase.)
Public propertyIterations
Gets the number of iterations used computing the last root.
(Inherited from RootFinderBase.)
Public propertyMaxIterations
Gets and sets the maximum number of iterations used in finding roots.
(Inherited from RootFinderBase.)
Public propertyMaxIterationsMet
Returns true if the root just computed stopped because the maximum number of iterations was reached; otherwise, false.
(Inherited from RootFinderBase.)
Public propertyTolerance
Gets and sets the error tolerance used in finding roots.
(Inherited from RootFinderBase.)
Public propertyToleranceMet
Returns true if the root just computed stopped because the error tolerance was reached; otherwise, false.
(Inherited from RootFinderBase.)
Top
Methods
  NameDescription
Public methodBracketRoot
Attempts to bracket a root given the function and an initial guess near a suspected root.
(Inherited from RootFinderBase.)
Public methodClone
Creates a deep copy of this root finder.
(Overrides RootFinderBaseClone.)
Public methodFind(OneVariableFunction, Interval)
Finds a root within the interval.
Public methodFind(OneVariableFunction, OneVariableFunction, Interval)
Finds a root within the interval.
Public methodFind(OneVariableFunction, Double, Double)
Finds a root within the interval.
Public methodFind(OneVariableFunction, OneVariableFunction, Double, Double)
Finds a root within the interval.
Top
Fields
  NameDescription
Protected fielderror_
The current error.
(Inherited from RootFinderBase.)
Protected fielditer_
The current number of iterations performed.
(Inherited from RootFinderBase.)
Protected fieldmax_
The maximum number of iterations.
(Inherited from RootFinderBase.)
Protected fieldtolerance_
The error tolerance.
(Inherited from RootFinderBase.)
Top
Remarks
The Newton-Raphson method finds the slope of the function at the current point and uses the zero of the tangent line as an estimate of the root.
See Also