Returns a value that indicates whether the convergence conditions have been met.
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.
