Click or drag to resize

TerminationWatcher Class

Termination condition watcher class.
Inheritance Hierarchy
SystemObject
  FinMath.MachineLearningTerminationWatcher

Namespace:  FinMath.MachineLearning
Assembly:  FinMath (in FinMath.dll) Version: 2.4.7-0a995bd0ea1854c2c868ec3f8dae606c5777e170
Syntax
C#
[SerializableAttribute]
public class TerminationWatcher

The TerminationWatcher type exposes the following members.

Constructors
  NameDescription
Public methodTerminationWatcher
The termination watcher constructor.
Top
Properties
  NameDescription
Public propertyBestObjectiveIndex
The best observed objective value index.
Public propertyBestObjectiveModel
The optional model, associated with the best observed objective value.
Public propertyBestObjectiveValue
The best observed objective value.
Public propertyElapsedTime
The total elapsed time from this object creation.
Public propertyEpsilon
Minimal fluctuation of the best objective value for next point evaluation.
Public propertyEpsilonInterval
Best objective value fluctuation analysis interval.
Public propertyEvaluationsCount
The total number of evaluation performed.
Public propertyEvaluationsLimit
Maximum number of objective function evaluations till termination.
Public propertyIsTerminalState
The terminal conditions have met flag.
Public propertyTimeout
The algorithm execution timeout till termination flag.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate
Updates the termination watcher state. The NaN values are ignored without errors but the EvaluationsLimit and Timeout are checked.
Top
See Also