Gets or sets a value specifying the criterion that is
to be used in the convergence test for the algorithm.
Namespace:
Extreme.Mathematics.Algorithms
Assembly:
Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.1
public ConvergenceCriterion ConvergenceCriterion { get; set; }Public Property ConvergenceCriterion As ConvergenceCriterion
Get
Set
public:
property ConvergenceCriterion ConvergenceCriterion {
ConvergenceCriterion get ();
void set (ConvergenceCriterion value);
}member ConvergenceCriterion : ConvergenceCriterion with get, set
Property Value
Type:
ConvergenceCriterionOne of the
ConvergenceCriterion
values.
Root finding algorithms return
an approximation to the actual value of a root.
The desired accuracy of the approximation is specified
by the ConvergenceCriterion property and
either or both of AbsoluteTolerance
and RelativeTolerance.
The possible values for this property
are as follows:
| Value | Description |
|---|
| WithinAbsoluteTolerance | The result should be within the
tolerance specified by the AbsoluteTolerance
property. |
| WithinRelativeTolerance |
The result should be within the tolerance specified by
the RelativeTolerance
property. |
| WithinAnyTolerance |
The result should be within either of the tolerances
specified by the AbsoluteTolerance and
RelativeTolerance
properties. |
| NumberOfIterations |
Convergence should be expected at the specified number of
iterations. The estimated error is ignored.
|
Reference