VectorConvergenceTest<T>.TestConvergenceCore Method

Returns whether the convergence conditions have been met.

Definition

Namespace: Numerics.NET.Algorithms
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3
C#
protected override AlgorithmStatus TestConvergenceCore(
	bool beforeFirstIteration
)

Parameters

beforeFirstIteration  Boolean
 

Return Value

AlgorithmStatus
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 Enabled is false, then Busy is returned.

See Also