Click or drag to resize

FZero Class

FZero finds a zero of the function in the given interval. Repeated roots are not found, FZero can find only bracketed single roots.
Inheritance Hierarchy

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

The FZero type exposes the following members.

Constructors
  NameDescription
Public methodFZero
Constructs a FZero instance with default tolerance and default maximum iterations.
Public methodFZero(Double)
Constructs a FZero instance with the given error tolerance.
Public methodFZero(Int32)
Constructs a FZero instance with the given maximum number of iterations.
Public methodFZero(Double, Int32)
Constructs a FZero 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 one root of f within the given interval.
Public methodFind(OneVariableFunction, Double)
Finds one root of f near the starting guess, x0.
Public methodFind(OneVariableFunction, Double, Double)
Finds one root of f 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
Based on the
zeroin()
root finder published originally in Computer Methods for Mathematical Computations by Forsythe, Malcolm and Moler in 1977. This class is similar to MATLAB's FZero function.
See Also