Click or drag to resize
Accord.NET (logo)

GeneralConvergence Class

General convergence options.
Inheritance Hierarchy
SystemObject
  Accord.Math.ConvergenceGeneralConvergence

Namespace:  Accord.Math.Convergence
Assembly:  Accord.Math (in Accord.Math.dll) Version: 3.8.0
Syntax
public class GeneralConvergence
Request Example View Source

The GeneralConvergence type exposes the following members.

Constructors
  NameDescription
Public methodGeneralConvergence
Creates a new GeneralConvergence object.
Top
Properties
  NameDescription
Public propertyAbsoluteFunctionTolerance
Gets or sets the absolute function tolerance that should be used as convergence criteria. This tracks the absolute amount that the function output changes after two consecutive iterations. Setting this value to zero disables those checks. Default is 0.
Public propertyAbsoluteParameterTolerance
Gets or sets the absolute parameter tolerance that should be used as convergence criteria. This tracks the absolute amount that the model parameters changes after two consecutive iterations. Setting this value to zero disables those checks. Default is 0.
Public propertyCancel
Gets or sets whether the algorithm should be forced to terminate. Default is false.
Public propertyEvaluations
Gets or sets the number of function evaluations performed by the optimization algorithm.
Public propertyMaximumEvaluations
Gets or sets the maximum number of function evaluations to be used as convergence criteria. This tracks how many times the function to be optimized has been called, and stops the algorithm when the number of times specified in this property has been reached. Setting this value to zero disables this check. Default is 0.
Public propertyMaximumTime
Gets or sets the maximum amount of time that an optimization algorithm is allowed to run. This property must be set together with StartTime in order to function correctly. Setting this value to Zero disables this check. Default is Zero.
Public propertyNumberOfVariables
Gets or sets the number of variables in the problem.
Public propertyRelativeFunctionTolerance
Gets or sets the relative function tolerance that should be used as convergence criteria. This tracks the relative amount that the function output changes after two consecutive iterations. Setting this value to zero disables those checks. Default is 0.
Public propertyRelativeParameterTolerance
Gets or sets the relative parameter tolerance that should be used as convergence criteria. This tracks the relative amount that the model parameters changes after two consecutive iterations. Setting this value to zero disables those checks. Default is 0.
Public propertyStartTime
Gets or sets the time when the algorithm started running. When time will be tracked with the MaximumTime property, this property must also be set to a correct value.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodHasMethod
Checks whether an object implements a method with the given name.
(Defined by ExtensionMethods.)
Public Extension MethodIsEqual
Compares two objects for equality, performing an elementwise comparison if the elements are vectors or matrices.
(Defined by Matrix.)
Public Extension MethodTo(Type)Overloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Public Extension MethodToTOverloaded.
Converts an object into another type, irrespective of whether the conversion can be done at compile time or not. This can be used to convert generic types to numeric types during runtime.
(Defined by ExtensionMethods.)
Top
See Also