Gets the AlgorithmStatus following
an execution of the algorithm.
Namespace: Extreme.Mathematics
Assembly: Extreme.Numerics (Extreme.Numerics)
Syntax
| Visual Basic (Declaration) |
|---|
Public ReadOnly Property IterationResultCode As IterationResultCode |
| C# |
|---|
public IterationResultCode IterationResultCode { get; } |
| C++ |
|---|
public: IterationResultCode IterationResultCode { IterationResultCode get (); } |
Value
One of the AlgorithmStatus values.Remarks
This property indicates the outcome of approximating
the zero of the function. The root finding process
can fail for a number of reasons. The possible values
are as follows:
| Result code | Description |
|---|---|
| NoResult | The algorithm has not been executed. |
| Normal | The algorithm ended normally. |
| IterationLimitExceeded | The maximum number of iterations was exceeded. |
| RoundOffError | Round-off prevented the algorithm from achieving a result within the desired tolerance. |
| BadFunction | A badly behaved function prevented the algorithm from achieving a result within the desired tolerance. |
| Divergent | The algorithm diverges. |
Even if the result is not Converged, an approximate value of the root is still available. However, it cannot be guaranteed that this value will even be close to the actual result.
When finding roots, it is recommended to set the ThrowExceptionOnFailure property to false and inspect the value of this property after the algorithm has run.
