Click or drag to resize

RiddersRootFinder Class

Class RiddersRootFinder finds roots of univariate functions using Ridders' Method.
Inheritance Hierarchy
SystemObject
  CenterSpace.NMath.CoreRootFinderBase
    CenterSpace.NMath.CoreRiddersRootFinder

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

The RiddersRootFinder type exposes the following members.

Constructors
 NameDescription
Public methodRiddersRootFinder Constructs a RiddersRootFinder instance with default tolerance and default maximum iterations.
Public methodRiddersRootFinder(Double) Constructs a RiddersRootFinder instance with the given error tolerance.
Public methodRiddersRootFinder(Int32) Constructs a RiddersRootFinder instance with the given maximum number of iterations.
Public methodRiddersRootFinder(Double, Int32) Constructs a RiddersRootFinder 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 of the given function within the given interval.
Public methodFind(OneVariableFunction, Double, Double) Finds a root of the given function within the given 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
Ridders' Method first evaluates the function at the midpoint of the interval, then factors out the unique exponential function which turns the residual function into a straight line.
See Also