Interprets the AlgorithmStatus and throws the appropriate exception.

Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)

Syntax

Visual Basic (Declaration)
Protected Overridable Sub ThrowException
C#
protected virtual void ThrowException ()
C++
protected:
virtual void ThrowException ()

Remarks

This method is called by SetResultProperties(Object, Double, 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 SetResultProperties(Object, Double, AlgorithmStatus, Int32) method with the appropriate parameters.

Exceptions

ExceptionCondition
ConvergenceException Always thrown.