EndCriteria Class

Defines criteria for ending an optimization.

Inheritance Hierarchy

SystemObject
Altaxo.Calc.OptimizationEndCriteria

Namespace: Altaxo.Calc.Optimization
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3448.0 (4.8.3448.0)

Syntax

public class EndCriteria : IFormattable

The EndCriteria type exposes the following members.

Constructors

	Name	Description
	EndCriteria	Initializes a new instance of the EndCriteria class with default values.
	EndCriteria(Int32, Double, Int32, Int32)	Initializes a new instance of the EndCriteria class.

Top

Properties

	Name	Description
	Criteria	Gets the criterion that was satisfied and thus ended optimization.

Top

Methods

	Name	Description
	CheckCriteria	Checks whether any ending criteria are met.
	CheckFunctionEpsilon	Checks whether the objective function value is less than the function epsilon.
	CheckFunctionEvaluations	Checks whether the maximum number of function evaluations has been reached.
	CheckGradientCriteria	Checks whether any gradient-related ending criteria are met.
	CheckGradientEpsilon	Checks whether the norm of the gradient is less than the gradient epsilon.
	CheckGradientEvaluations	Checks whether the maximum number of gradient evaluations has been reached.
	CheckHessianEpsilon	Checks whether the norm of the Hessian is less than the Hessian epsilon.
	CheckHessianEvaluations	Checks whether the maximum number of Hessian evaluations has been reached.
	CheckIterations	Checks whether the maximum iteration count has been reached.
	CheckStationaryGradient	Checks whether the gradient changed by less than the gradient epsilon.
	CheckStationaryHessian	Checks whether the Hessian changed by less than the Hessian epsilon.
	CheckStationaryPoint	Checks whether the 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	Resets all counters.
	ToString	Returns a string that represents the current object. (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.

Top

Fields

	Name	Description
	endCriteria	The criterion 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	Maximum number of iterations at a stationary gradient.
	maxStationaryHessianIterations	Maximum number of iterations at a stationary Hessian.
	maxStationaryPointIterations	Maximum number of iterations at a stationary point.
	minFunctionEpsilon	Minimum function epsilon.
	minGradientEpsilon	Minimum gradient epsilon.
	minHessianEpsilon	Minimum Hessian epsilon.
	stationaryCriteria	Indicates whether a stationary criterion is currently being evaluated.
	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.

Top

Remarks

Reference

Altaxo.Calc.Optimization Namespace