Click or drag to resize

BrentFindRoot Constructor (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:

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

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.
Exceptions
ExceptionCondition
ArgumentNullException Thrown when the parameter function is .
ArgumentOutOfRangeException Thrown when the variableTolerance or functionTolerance is less than or equal to zero.
See Also