AlgorithmHelper.IsValueWithinTolerance Method

public static bool IsValueWithinTolerance(
	IterativeAlgorithm algorithm,
	double estimatedError,
	double x
)

Public Shared Function IsValueWithinTolerance ( 
	algorithm As IterativeAlgorithm,
	estimatedError As Double,
	x As Double
) As Boolean

public:
static bool IsValueWithinTolerance(
	IterativeAlgorithm^ algorithm, 
	double estimatedError, 
	double x
)

static member IsValueWithinTolerance : 
        algorithm : IterativeAlgorithm * 
        estimatedError : float * 
        x : float -> bool 

Parameters

algorithm  IterativeAlgorithm

A class that implements the IterativeAlgorithm interface.

estimatedError  Double

The error to verify.

x  Double

A value that is representative of the size of the result.

Return Value

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

Reference