ThresholdStoppingConditionConstraintEvaluatorSimpleCheck Method |
Performs a simple check of the
currentValue against a
threshold and
tolerance,
using the
useAbsoluteValue and
inequalityCriteria to determine if this
constraint is satisfied by the
currentValue.
This method can be called by
IsConstraintSatisfied(ITimeBasedState)
if your constraint is simply computing a value to be compared to a threshold.
Namespace:
AGI.Foundation.StoppingConditions
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public static bool SimpleCheck(
double currentValue,
double threshold,
double tolerance,
bool useAbsoluteValue,
InequalityCondition inequalityCriteria,
double smallestValue,
double largestValue
)
Public Shared Function SimpleCheck (
currentValue As Double,
threshold As Double,
tolerance As Double,
useAbsoluteValue As Boolean,
inequalityCriteria As InequalityCondition,
smallestValue As Double,
largestValue As Double
) As Boolean
public:
static bool SimpleCheck(
double currentValue,
double threshold,
double tolerance,
bool useAbsoluteValue,
InequalityCondition inequalityCriteria,
double smallestValue,
double largestValue
)
static member SimpleCheck :
currentValue : float *
threshold : float *
tolerance : float *
useAbsoluteValue : bool *
inequalityCriteria : InequalityCondition *
smallestValue : float *
largestValue : float -> bool
Parameters
- currentValue
- Type: SystemDouble
The current computed value. - threshold
- Type: SystemDouble
The threshold. - tolerance
- Type: SystemDouble
The tolerance. - useAbsoluteValue
- Type: SystemBoolean
Whether or not the absolute value of the currentValue
should be used when determining if the constraint is satisfied.
- inequalityCriteria
- Type: AGI.Foundation.StoppingConditionsInequalityCondition
The InequalityCondition that should be used to compare the
currentValue to the threshold.
- smallestValue
- Type: SystemDouble
The smallest value that has been computed up to this point. - largestValue
- Type: SystemDouble
The largest value that has been computed up to this point.
Return Value
Type:
Boolean if the
currentValue
satisfies the constraint; otherwise
.
See Also