ConvergenceTest<T>.RelativeTolerance Property

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

Definition

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
public T RelativeTolerance { get; set; }

Property Value

T
A real number greater than or equal to zero.

Remarks

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

This property is ignored when ConvergenceCriterion is equal to WithinAbsoluteTolerance.

Exceptions

ArgumentOutOfRangeExceptionThe specified tolerance is less than zero or equal to NaN

See Also