Performs the convergence test.
Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public Overrides Function TestConvergence As AlgorithmStatus |
| C# |
|---|
public override AlgorithmStatus TestConvergence () |
| C++ |
|---|
public: virtual AlgorithmStatus TestConvergence () override |
Return Value
An AlgorithmStatus value.Remarks
A value of Converged indicates that the test was successful.
Unless there are other tests that must succeed, this indicates that the algorithm can terminate successfully.
A value of Busy indicates that the test failed and the algorithm should continue.
Any other value indicates some kind of error condition, and the algorithm should terminate.
If the Active is false, then Busy is returned.
The behavior of this method depends on the value of the Quantifier property. If Quantifier equals All, then the method returns the result of the first test that did not succeed. If all tests succeeded, or if none of the tests were active, Converged is returned.
If Quantifier equals Any, then the method returns Converged if any of the tests succeeds. Otherwise, it returns the status of the first test that did not return Busy. If all tests returned Busy, or if no tests are active, Busy is returned.
