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: 25.1.421.0 (25.1.421.0)
Syntax
Copy
public BrentFindRoot(
	RealValuedScalarFunction function,
	double variableTolerance,
	double functionTolerance,
	BrentSolutionType solutionType,
	ConvergenceCriteria criteria
)

Parameters

function
Type: AGI.Foundation.NumericalMethods.RealValuedScalarFunction
The function to be called in order to evaluate intermediate variable values.
variableTolerance
Type: System.Double
The convergence tolerance in the variable value.
functionTolerance
Type: System.Double
The convergence tolerance in the function value.
solutionType
Type: AGI.Foundation.NumericalMethods.Advanced.BrentSolutionType
Indicates on which side of zero a solution must be found.
criteria
Type: AGI.Foundation.NumericalMethods.Advanced.ConvergenceCriteria
Specifies the criteria to be used in determining convergence.
Exceptions
ExceptionCondition
ArgumentNullException Thrown when the parameter function is null.
ArgumentOutOfRangeException Thrown when the variableTolerance or functionTolerance is less than or equal to zero.
See Also