DurationFunctionThresholdDetails Class |
Namespace: AGI.Foundation.NumericalMethods
The DurationFunctionThresholdDetails type exposes the following members.
Name | Description | |
---|---|---|
DurationFunctionThresholdDetails |
Initializes a new instance. The threshold is initially enabled.
|
Name | Description | |
---|---|---|
BehaviorWhenOnThreshold |
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.
| |
ConvergenceCriteria |
Gets or sets the criteria used for convergence when searching for a precise crossing
of this threshold. When set to Variable, the
CrossingDurationTolerance 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.
| |
SolutionType |
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.
| |
Value |
Gets or sets the threshold value of interest.
| |
ValueTolerance |
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.
|
Name | Description | |
---|---|---|
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.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |