ConvergenceTest..::..AbsoluteTolerance Property

ConvergenceTest Class See Also

Gets or sets the absolute tolerance used in the convergence test.

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 4.2.11333.0 (4.2.12253.0)

Syntax

C#
public double AbsoluteTolerance { get; set; }

Visual Basic (Declaration)
Public Property AbsoluteTolerance As Double Get Set

Visual C++
public: property double AbsoluteTolerance { double get (); void set (double value); }

F#
member AbsoluteTolerance : float with get, set

Field Value

A real number greater than or equal to zero.

Remarks

The absolute error is the absolute value of the difference between the computed and the actual result. The absolute tolerance specifies the largest value of the ratio that is allowed.

This property is ignored when ConvergenceCriterion is equal to WithinRelativeeTolerance.

Exceptions

Exception	Condition
System..::..ArgumentOutOfRangeException	The specified tolerance is less than zero or equal to NaN