Click or drag to resize

BrentFindRoot Class

Locates the root of a function using the Van Wijngaarden, Dekker, Brent algorithm.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethods.AdvancedBrentFindRoot

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public class BrentFindRoot

The BrentFindRoot type exposes the following members.

Constructors
  NameDescription
Public methodBrentFindRoot(RealValuedScalarFunction, Double, Double, BrentSolutionType, ConvergenceCriteria)
Initializes a new instance that can be used to find roots of a specified function. The BracketToward property is set based on the value of the solutionType parameter as follows:
Public methodBrentFindRoot(RealValuedScalarFunction, Double, Double, BrentSolutionType, ConvergenceCriteria, BracketToward)
Initializes a new instance that can be used to find roots of a specified function.
Top
Properties
  NameDescription
Public propertyBracketToward
Gets the behavior of the root finder when a sampled function value exactly equals zero and ConvergenceCriteria requires convergence on the independent variable.
Public propertyConvergenceCriteria
Gets the criteria used in determining convergence.
Public propertyFunction
Gets the evaluation function.
Public propertyFunctionTolerance
Gets the convergence tolerance on the value of the function.
Public propertyHasConverged
Gets a value indicating whether the algorithm is in the converged state.
Public propertyIterations
Gets the number of iterations taken.
Public propertyRoot
Gets the current best estimate of independent variable value at which the root occurs. If HasConverged is , this is the actual root according to the convergence criteria defined when this instance was constructed.
Public propertyValue
Gets the function value at the current best estimate of the Root. If HasConverged is , this is the actual root according to the convergence criteria defined when this instance was constructed.
Public propertyVariableTolerance
Gets the convergence tolerance on the value of the independent variable.
Top
Methods
  NameDescription
Public methodCheckInitialBracketingPoints(Double, Double)
Checks whether the given variable values will produce a valid initial bracketing interval.
Public methodCheckInitialBracketingPoints(Double, Double, Double, Double)
Checks whether the given variable and function values will produce a valid initial bracketing interval.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindRoot
Attempts the indicated number of iterations to locate the root of the function to within the required convergence criteria.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsFunctionValueWithinTolerance
Indicates whether the function value has converged to within the specified tolerance.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSetInitialBracketingPoints(Double, Double)
Defines the initial bracketing interval using the provided variable values.
Public methodSetInitialBracketingPoints(Double, Double, Double, Double)
Defines the initial bracketing interval using the provided variable values and corresponding function values.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also