ConvergenceTest<T>.ConvergenceCriterion Property

Gets or sets a value specifying the criterion that is to be used in the convergence test for the algorithm.

Definition

Namespace: Numerics.NET.Algorithms
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
public ConvergenceCriterion ConvergenceCriterion { get; set; }

Property Value

ConvergenceCriterion
One of the ConvergenceCriterion values.

Remarks

The desired accuracy of an iterative algorithm is specified by the ConvergenceCriterion property and Tolerance. The convergence criterion specifies how the accuracy should be measured.

The possible values for this property are as follows:

ValueDescription
WithinAbsoluteToleranceThe absolute error of the result should be within the specified tolerance.
WithinRelativeToleranceThe relative error should be within the specified tolerance.
WithinAnyToleranceEither the absolute or the relative error should be within the specified tolerance.
NumberOfIterations Convergence should be expected at the specified number of iterations. The estimated error is ignored.

See Also