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

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:
ValueDescription
WithinAbsoluteToleranceThe 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.

See Also