Managed
Gets the AlgorithmStatus following
an execution of the algorithm.
Definition
Namespace: Extreme.Mathematics.Algorithms
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
C#
One of the AlgorithmStatus values.
Assembly: Extreme.Numerics (in Extreme.Numerics.dll) Version: 8.1.23
public AlgorithmStatus Status { get; }Property Value
AlgorithmStatusOne 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. |
| EvaluationLimitExceeded | The maximum number of function evaluations 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 Normal, 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.