SimpleConvergenceTest<T>.TestConvergenceCore Method

protected override AlgorithmStatus TestConvergenceCore(
	bool beforeFirstIteration
)

Protected Overrides Function TestConvergenceCore ( 
	beforeFirstIteration As Boolean
) As AlgorithmStatus

protected:
virtual AlgorithmStatus TestConvergenceCore(
	bool beforeFirstIteration
) override

abstract TestConvergenceCore : 
        beforeFirstIteration : bool -> AlgorithmStatus 
override TestConvergenceCore : 
        beforeFirstIteration : bool -> AlgorithmStatus 

Parameters

beforeFirstIteration  Boolean

 

Return 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.

Reference