End |
Class to define criteria to end optimization
Inheritance HierarchyNamespace: Altaxo.Calc.Optimization
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class EndCriteria : IFormattable
The EndCriteria type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EndCriteria | Default constructor |
| EndCriteria(Int32, Double, Int32, Int32) | Initializes a new instance of the EndCriteria class |
Properties
Methods| Name | Description | |
|---|---|---|
| CheckCriteria | Check if ending criteria are met |
| CheckFunctionEpsilon | Check if objective function value is less than the function epsilon |
| CheckFunctionEvaluations | Check if the number of function evaluations is less than the maximum |
| CheckGradientCriteria | Check if gradient criteria are met |
| CheckGradientEpsilon | Check if the norm of the gradient is less than the gradient epsilon |
| CheckGradientEvaluations | Check if the number of gradient evaluations is less than the maximum |
| CheckHessianEpsilon | Check if the norm of the hessian is less than the hessian epsilon |
| CheckHessianEvaluations | Check if the number of hessian evaluations is less than the maximum |
| CheckIterations | Check if the iteration number is less than the maximum iteration |
| CheckStationaryGradient | Check if gradient function changed by less than the gradient epsilon |
| CheckStationaryHessian | Check if hessian function changed by less than the hessian epsilon |
| CheckStationaryPoint | Check if objective function changed by less than the function epsilon |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Reset | Reset all Counters |
| ToString | A string representation of this EndCriteria. (Overrides ObjectToString) |
| ToString(IFormatProvider) | A string representation of this EndCriteria. |
| ToString(String) | A string representation of this EndCriteria. |
| ToString(String, IFormatProvider) | A string representation of this EndCriteria. |
Fields| Name | Description | |
|---|---|---|
 | endCriteria | The criteria that ended optimization |
 | functionEvaluationCounter | Current number of function evaluations |
| gradientEvaluationCounter | Current number of gradient evaluations |
| hessianEvaluationCounter | Current number of hessian evaluations |
| iterationCounter | Current number of iterations |
| maxFunctionEvaluation | Maximum number of function evaluations |
| maxGradientEvaluation | Maximum number of gradient evaluations |
| maxHessianEvaluation | Maximum number of hessian evaluations |
| maxIteration | Maximum number of iterations |
| maxStationaryGradientIterations | Maximun number of iterations at a stationary gradient |
| maxStationaryHessianIterations | Maximun number of iterations at a stationary hessian |
| maxStationaryPointIterations | Maximun number of iterations at a stationary point |
| minFunctionEpsilon | Minimum Function Epsilon |
| minGradientEpsilon | Minimum Gradient Epsilon |
| minHessianEpsilon | Gradient Epsilon |
| stationaryCriteria | |
| stationaryGradientIterationsCounter | Current number of iterations at a stationary gradient |
| stationaryHessianIterationsCounter | Current number of iterations at a stationary hessian |
| stationaryPointIterationsCounter | Current number of iterations at a stationary point |
RemarksCopyright (c) 2003-2004, dnAnalytics Project. All rights reserved. See http://www.dnAnalytics.net for details.
Adopted to Altaxo (c) 2005 Dr. Dirk Lellinger.
See Also