ScalarStoppingConditionConstraint Constructor (Scalar, Double, Double, WhenToCheckConstraint, InequalityCondition, Boolean)

Initializes a new instance.

Namespace: AGI.Foundation.StoppingConditions
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public ScalarStoppingConditionConstraint(
	Scalar scalar,
	double threshold,
	double tolerance,
	WhenToCheckConstraint whenToCheck,
	InequalityCondition inequality,
	bool useAbsoluteValue
)

Public Sub New ( 
	scalar As Scalar,
	threshold As Double,
	tolerance As Double,
	whenToCheck As WhenToCheckConstraint,
	inequality As InequalityCondition,
	useAbsoluteValue As Boolean
)

public:
ScalarStoppingConditionConstraint(
	Scalar^ scalar, 
	double threshold, 
	double tolerance, 
	WhenToCheckConstraint whenToCheck, 
	InequalityCondition inequality, 
	bool useAbsoluteValue
)

new : 
        scalar : Scalar * 
        threshold : float * 
        tolerance : float * 
        whenToCheck : WhenToCheckConstraint * 
        inequality : InequalityCondition * 
        useAbsoluteValue : bool -> ScalarStoppingConditionConstraint

Parameters

scalar: Type: AGI.Foundation.GeometryScalar
The Scalar that will compute a value to compare with the threshold.
threshold: Type: SystemDouble
The threshold to compare with the value of the scalar.
tolerance: Type: SystemDouble
The tolerance to use when comparing the threshold with the value of the scalar.
whenToCheck: Type: AGI.Foundation.StoppingConditionsWhenToCheckConstraint
Should this StoppingConditionConstraint should be checked,.
inequality: Type: AGI.Foundation.StoppingConditionsInequalityCondition
How to compare the computed value with the threshold.
useAbsoluteValue: Type: SystemBoolean
Should the absolute value of the value of the scalar be used.

Reference

ScalarStoppingConditionConstraint Class

ScalarStoppingConditionConstraint Overload

AGI.Foundation.StoppingConditions Namespace