Gets or sets a value specifying the criterion that is
to be used in the convergence test for the algorithm.
Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Property ConvergenceCriterion As ConvergenceCriterion |
| C# |
|---|
public ConvergenceCriterion ConvergenceCriterion { get; set; } |
| C++ |
|---|
public: ConvergenceCriterion ConvergenceCriterion { ConvergenceCriterion get (); void set (ConvergenceCriterion value); } |
Value
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:
| Value | Description |
|---|---|
| WithinAbsoluteTolerance | The absolute error of the result should be within the specified tolerance. |
| WithinRelativeTolerance | The relative error should be within the specified tolerance. |
| WithinAnyTolerance | Either 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. |