Namespace: Extreme.Mathematics.AlgorithmsAssembly: Extreme.Numerics.Net40 (in Extreme.Numerics.Net40.dll) Version: 6.0.16073.0 (6.0.16241.0)
public AlgorithmStatus Status { get; }Public ReadOnly Property Status As AlgorithmStatus
Get
public:
property AlgorithmStatus Status {
AlgorithmStatus get ();
}member Status : AlgorithmStatus with get
Property Value
Type:
AlgorithmStatusOne of the
AlgorithmStatus
values.
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 and inspect the value of
this property after the algorithm has run.
Numerical Libraries
Supported in: 6.0
Reference