Performs the convergence test.
Namespace: Extreme.Mathematics.AlgorithmsAssembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 6.0.16073.0 (6.0.16312.0)
public AlgorithmStatus TestConvergence()
Public Function TestConvergence As AlgorithmStatus
public:
AlgorithmStatus TestConvergence()
member TestConvergence : unit -> AlgorithmStatus
Return Value
Type:
AlgorithmStatusAn
AlgorithmStatus value.
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 Enabled is false, then Busy
is returned.
Numerical Libraries
Supported in: 6.0
Reference