NonlinLeastSquaresGradientTolerance Property |
The scaled gradient tolerance.
Namespace: Imsl.MathAssembly: ImslCS (in ImslCS.dll) Version: 6.5.2.0
Syntax public double GradientTolerance { get; set; }
Public Property GradientTolerance As Double
Get
Set
public:
property double GradientTolerance {
double get ();
void set (double value);
}
member GradientTolerance : float with get, set
Property Value
Type:
Double
A
double specifying the scaled gradient tolerance used in stopping
criteria. The
i-th component of the scaled gradient at
x is
calculated as
where
,
s =
xscale, and
where
f =
fscale.
Exceptions Exception | Condition |
---|
ArgumentException |
is thrown if GradientTolerance is less than or equal to 0
|
Remarks
When the norm of the function is less than
GradientTolerance
the procedure stops.
By default, GradientTolerance =
where is machine precision.
See Also