Returns the error status of a root.

Namespace: Imsl.Math
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.0.0

Syntax

C#
public bool GetStatus(
	int index
)
Visual Basic (Declaration)
Public Function GetStatus ( _
	index As Integer _
) As Boolean
Visual C++
public:
bool GetStatus(
	int index
)

Parameters

index
Type: System..::.Int32
An int representing the (0-based) index of the root whose error status is to be returned.

Return Value

A bool representing the error status on the index-th root.

Remarks

It is false if the approximation of the index-th root has been carried out successfully, for example, the computed approximation can be viewed as the exact root of a slightly perturbed polynomial. It is true if more iterations are needed for the index-th root.

See Also