BrentFindRoot Class |
Locates the root of a function using the Van Wijngaarden, Dekker, Brent algorithm.
Inheritance HierarchyNamespace: AGI.Foundation.NumericalMethods.Advanced
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe BrentFindRoot type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BrentFindRoot(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: |
| BrentFindRoot(RealValuedScalarFunction, Double, Double, BrentSolutionType, ConvergenceCriteria, BracketToward) |
Initializes a new instance that can be used to find roots of a specified function.
|
Properties| Name | Description | |
|---|---|---|
 | BracketToward |
Gets the behavior of the root finder when a sampled
function value exactly equals zero and ConvergenceCriteria
requires convergence on the independent variable.
|
| ConvergenceCriteria |
Gets the criteria used in determining convergence.
|
| Function |
Gets the evaluation function.
|
| FunctionTolerance |
Gets the convergence tolerance on the value of the function.
|
| HasConverged |
Gets a value indicating whether the algorithm is in the converged state.
|
| Iterations |
Gets the number of iterations taken.
|
| Root |
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.
|
| Value |
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.
|
| VariableTolerance |
Gets the convergence tolerance on the value of the independent variable.
|
Methods| Name | Description | |
|---|---|---|
| CheckInitialBracketingPoints(Double, Double) |
Checks whether the given variable values will produce a valid initial bracketing interval.
|
| CheckInitialBracketingPoints(Double, Double, Double, Double) |
Checks whether the given variable and function values will produce a valid initial bracketing interval.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindRoot |
Attempts the indicated number of iterations to locate the root of the function
to within the required convergence criteria.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsFunctionValueWithinTolerance |
Indicates whether the function value has converged to within the specified tolerance.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetInitialBracketingPoints(Double, Double) |
Defines the initial bracketing interval using the provided variable values.
|
| SetInitialBracketingPoints(Double, Double, Double, Double) |
Defines the initial bracketing interval using the provided variable values
and corresponding function values.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also