Click or drag to resize

BrentFindRoot Constructor (RealValuedScalarFunction, Double, Double, BrentSolutionType, ConvergenceCriteria, BracketToward)

Initializes a new instance that can be used to find roots of a specified function.

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
Copy
public BrentFindRoot(
	RealValuedScalarFunction function,
	double variableTolerance,
	double functionTolerance,
	BrentSolutionType solutionType,
	ConvergenceCriteria criteria,
	BracketToward bracketToward
)

Parameters

function
Type: AGI.Foundation.NumericalMethodsRealValuedScalarFunction
The function to be called in order to evaluate intermediate variable values.
variableTolerance
Type: SystemDouble
The convergence tolerance in the variable value.
functionTolerance
Type: SystemDouble
The convergence tolerance in the function value.
solutionType
Type: AGI.Foundation.NumericalMethods.AdvancedBrentSolutionType
Indicates on which side of zero a solution must be found.
criteria
Type: AGI.Foundation.NumericalMethods.AdvancedConvergenceCriteria
Specifies the criteria to be used in determining convergence.
bracketToward
Type: AGI.Foundation.NumericalMethods.AdvancedBracketToward
Specifies the bracketing behavior when a sampled function value exactly equals zero. This parameter only has an effect when the criteria is ConvergenceCriteria.Variable or ConvergenceCriteria.Both. See BracketToward for more information.
Exceptions
ExceptionCondition
ArgumentNullException Thrown when function is .
ArgumentOutOfRangeException Thrown when the variableTolerance or functionTolerance is less than or equal to zero.
See Also