Click or drag to resize

RootFinderBase Class

Abstract base class for classes that perform root finding on univariate functions.
Inheritance Hierarchy

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

The RootFinderBase type exposes the following members.

Constructors
  NameDescription
Protected methodRootFinderBase
For internal use only.
Protected methodRootFinderBase(Double, Int32)
Constructs a RootFinderBase instance with the given error tolerance and maximum number of iterations.
Top
Properties
  NameDescription
Public propertyStatic memberDefaultMaxIterations
Gets and sets the default maximum number of iterations.
Public propertyStatic memberDefaultTolerance
Gets and sets the default error tolerance.
Public propertyError
Gets the error associated with the root just computed.
Public propertyIterations
Gets the number of iterations used computing the last root.
Public propertyMaxIterations
Gets and sets the maximum number of iterations used in finding roots.
Public propertyMaxIterationsMet
Returns true if the root just computed stopped because the maximum number of iterations was reached; otherwise, false.
Public propertyTolerance
Gets and sets the error tolerance used in finding roots.
Public propertyToleranceMet
Returns true if the root just computed stopped because the error tolerance was reached; otherwise, false.
Top
Methods
  NameDescription
Public methodBracketRoot
Attempts to bracket a root given the function and an initial guess near a suspected root.
Public methodClone
Returns a deep copy of this root finder.
Top
Fields
  NameDescription
Protected fieldStatic memberDEFAULT_MAX_ITER
The default maximum number of iterations.
Protected fieldStatic memberDEFAULT_TOLERANCE
The default error tolerance.
Protected fielderror_
The current error.
Protected fielditer_
The current number of iterations performed.
Protected fieldmax_
The maximum number of iterations.
Protected fieldtolerance_
The error tolerance.
Top
See Also