Click or drag to resize

DoubleFunctionThresholdDetails Class

Details of a threshold of interest in DoubleFunctionExplorer.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.NumericalMethodsDoubleFunctionThresholdDetails

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class DoubleFunctionThresholdDetails

The DoubleFunctionThresholdDetails type exposes the following members.

Constructors
  NameDescription
Public methodDoubleFunctionThresholdDetails
Initializes a new instance. The threshold is initially enabled.
Top
Properties
  NameDescription
Public propertyBehaviorWhenOnThreshold
Gets or sets the behavior when a function value is found to exactly equal the threshold. A function value exactly equal to the threshold can be treated either as above or as below the threshold. By default, this property has the value TreatAsAbove.
Public propertyConvergenceCriteria
Gets or sets the criteria used for convergence when searching for a precise crossing of this threshold. When set to Variable, the CrossingVariableTolerance is used. When set to Function, the ValueTolerance is used. Convergence can also be allowed on Either criteria or Both criteria can be required. By default, this property has the value Variable.
Public propertySolutionType
Gets or sets the type of solution required when searching for a precise crossing of this threshold. This controls whether the value of the function at the identified crossing is slightly above or slightly below the threshold when it is not precisely on the threshold. By default, this property has the value OnOrAboveThreshold.
Public propertyValue
Gets or sets the threshold value of interest.
Public propertyValueTolerance
Gets or sets the tolerance with which to converge on value when finding a precise crossing of this threshold. By default, this property has the value 0.0, but it is ignored because ConvergenceCriteria is set to Variable.
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
See Also