Click or drag to resize

AbstractRootFinder Class

Base class for one-dimensional root-finding algorithms.
Inheritance Hierarchy
SystemObject
  Altaxo.Calc.RootFindingAbstractRootFinder
    More

Namespace: Altaxo.Calc.RootFinding
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)
Syntax
C#
public abstract class AbstractRootFinder

The AbstractRootFinder type exposes the following members.

Constructors
 NameDescription
Public methodAbstractRootFinder(FuncDouble, Double) Initializes a new instance of the AbstractRootFinder class.
Public methodAbstractRootFinder(FuncDouble, Double, Int32, Double) Initializes a new instance of the AbstractRootFinder class.
Top
Properties
 NameDescription
Public propertyAccuracy Gets or sets the desired accuracy for the computed root.
Public propertyBracketingFactor Gets or sets the factor used for outward bracketing when searching for an interval that contains a root.
Public propertyMaximumNumberOfIterations Sets the maximum number of iterations.
Protected propertyStatic memberMessageAccuracyNotReached Gets the localized error message used when the requested accuracy cannot be reached within the maximum number of iterations.
Protected propertyStatic memberMessageInadequateAlgorithm Gets the localized error message used when the chosen algorithm cannot solve the equation.
Protected propertyStatic memberMessageInvalidRange Gets the localized error message used when an invalid range is encountered while finding a root.
Protected propertyStatic memberMessageRangeArgumentInvalid Gets the localized error message used when the provided range argument is not valid.
Protected propertyStatic memberMessageRootNotBracketed Gets the localized error message used when the algorithm cannot start because the root does not seem to be bracketed.
Protected propertyStatic memberMessageRootNotFound Gets the localized error message used when the algorithm ends without finding a root in the range.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Protected methodFind Performs the algorithm-specific root search on the currently configured interval.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodSearchBracketsOutward Detects a range containing at least one root.
Protected methodSign Helper method useful for preventing rounding errors.
Public methodSolve(Double, Double, Boolean) Solves the equation f(x) == 0.
Public methodSolve(Double, Double, Double, Boolean) Solves the equation f(x) == y.
Protected methodSwap Swaps the values of two Double variables.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Protected field_accuracy Desired accuracy for the computed root.
Protected field_function Function for which a root should be found.
Protected field_maximumNumberOfIterations Maximum number of iterations used by the algorithm.
Protected field_originalFunction Stores the original function when the solver is temporarily configured to solve f(x) == y.
Protected field_xMax Upper bound of the current search interval.
Protected field_xMin Lower bound of the current search interval.
Protected fieldStatic memberdouble_Accuracy Machine epsilon-like accuracy threshold, used as an internal constant.
Top
See Also
Inheritance Hierarchy