Click or drag to resize

SolverVariableSettings Class

The settings of a variable to use in a SolvableMultivariableFunction.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethodsSolverVariableSettings

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.4.401.0 (19.4.401.0)
Syntax
public class SolverVariableSettings : IThreadAware, 
	ICloneWithContext

The SolverVariableSettings type exposes the following members.

Constructors
  NameDescription
Public methodSolverVariableSettings(Double)
Initializes a new instance. The InitialValue will default to zero, as will the tolerance. The scaling will default to NoScalingOnVariable.
Public methodSolverVariableSettings(Double, Double)
Initializes a new instance with the tolerance set to 0 and no scaling.
Protected methodSolverVariableSettings(SolverVariableSettings, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodSolverVariableSettings(Double, Double, Double)
Initializes a new instance with no scaling.
Public methodSolverVariableSettings(Double, Double, Double, SolverVariableScaling)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyInitialValue
Gets or sets the initial value of the variable. By default this is set to zero.
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyMaximumStep
Gets or sets the maximum step to take. This is to prevent a MultivariableFunctionSolver from taking too large of a step which might cause the solver to jump over relevant changes and events.
Public propertyName
Gets or sets an optional name for this variable.
Public propertyScaling
Gets or sets the type of scaling applied to the variable.
Public propertyVariableTolerance
Gets or sets the minimum step that the variable is aloud to take. If a MultivariableFunctionSolver asks the function to step by a value less than this, it means that the function results will not change by any relevant amount. If all the variables are asked to step by a value less than their VariableTolerance, then the solver must abort.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
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
See Also