AlgorithmHelper.IsIntervalWithinTolerance Method

Determines whether an interval is within an algorithm's requested tolerance.

Definition

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
public static bool IsIntervalWithinTolerance(
	IterativeAlgorithm algorithm,
	double lowerBound,
	double upperBound
)

Parameters

algorithm  IterativeAlgorithm
A class that implements the IterativeAlgorithm interface.
lowerBound  Double
The lower bound of the interval.
upperBound  Double
The upper bound of the interval.

Return Value

Boolean
true if the interval is within the requested tolerance; otherwise false.

Remarks

This method uses the properties of the provided IterativeAlgorithm object. In particular, the ConvergenceCriterion, and either or both of AbsoluteTolerance and RelativeTolerance.

If lowerBound is greater than upperBound, this method always returns false.

Exceptions

ArgumentNullExceptionalgorithm is null.

See Also