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

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Public Shared Function IsIntervalWithinTolerance ( _
	algorithm As IterativeAlgorithm, _
	lowerBound As Double, _
	upperBound As Double _
) As Boolean
C#
public static bool IsIntervalWithinTolerance (
	IterativeAlgorithm algorithm,
	double lowerBound,
	double upperBound
)
C++
public:
static bool IsIntervalWithinTolerance (
	IterativeAlgorithm^ algorithm, 
	double lowerBound, 
	double upperBound
)

Parameters

algorithm (Extreme.Mathematics.IterativeAlgorithm)
A class that implements the IterativeAlgorithm interface.
lowerBound (System.Double)
The lower bound of the interval.
upperBound (System.Double)
The upper bound of the interval.

Return Value

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

ExceptionCondition
ArgumentNullExceptionalgorithm is nullNothingnullptr.

See Also