ConvergenceTest<T>.TestConvergence Method

public AlgorithmStatus TestConvergence(
	bool beforeFirstIteration = false
)

Public Function TestConvergence ( 
	Optional beforeFirstIteration As Boolean = false
) As AlgorithmStatus

public:
AlgorithmStatus TestConvergence(
	bool beforeFirstIteration = false
)

member TestConvergence : 
        ?beforeFirstIteration : bool 
(* Defaults:
        let _beforeFirstIteration = defaultArg beforeFirstIteration false
*)
-> AlgorithmStatus 

Parameters

beforeFirstIteration  Boolean  (Optional)

 

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