Click or drag to resize

EndCriteriaCheckStationaryGradient Method

Check if gradient function changed by less than the gradient epsilon

Namespace: Altaxo.Calc.Optimization
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
public bool CheckStationaryGradient(
	double gold,
	double gnew
)

Parameters

gold  Double

[Missing <param name="gold"/> documentation for "M:Altaxo.Calc.Optimization.EndCriteria.CheckStationaryGradient(System.Double,System.Double)"]

gnew  Double

[Missing <param name="gnew"/> documentation for "M:Altaxo.Calc.Optimization.EndCriteria.CheckStationaryGradient(System.Double,System.Double)"]

Return Value

Boolean

[Missing <returns> documentation for "M:Altaxo.Calc.Optimization.EndCriteria.CheckStationaryGradient(System.Double,System.Double)"]

Remarks
If the change in gradient function is less than the gradient epsilon then a possible stationary point has been found. If the number of repeated iterations at this possible stationary point is greater than the maximum iterations at a station point then the ending criteria is set to CriteriaType.StationaryPoint and the function returns true;
See Also