ManagedIterativeAlgorithm<T, TError, TReport>.ThrowConvergenceException Method

Interprets the AlgorithmStatus and throws the appropriate exception.

Definition

Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C# 
protected virtual void ThrowConvergenceException()

Remarks

This method is called by SetResult(T, TError, AlgorithmStatus, Int32) when the algorithm failed and the ThrowExceptionOnFailure property is set to true. It interprets the AlgorithmStatus and throws a ConvergenceException with an appropriate message text.

Inheritors may override this method and substitute more specific exception messages. The base implementation should always be called for codes that are not handled by the overriding method.

You should avoid calling this method directly. Instead, call the SetResult(T, TError, AlgorithmStatus, Int32) method with the appropriate parameters.

Exceptions

ConvergenceException Always thrown.

See Also