ScalarStoppingCondition Constructor (Scalar, Double, Double, StopType)

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

public ScalarStoppingCondition(
	Scalar scalar,
	double threshold,
	double valueTolerance,
	StopType type
)

Public Sub New ( 
	scalar As Scalar,
	threshold As Double,
	valueTolerance As Double,
	type As StopType
)

public:
ScalarStoppingCondition(
	Scalar^ scalar, 
	double threshold, 
	double valueTolerance, 
	StopType type
)

new : 
        scalar : Scalar * 
        threshold : float * 
        valueTolerance : float * 
        type : StopType -> ScalarStoppingCondition

scalar: Type: AGI.Foundation.GeometryScalar
The Scalar that will provide values to sample.
threshold: Type: SystemDouble
The threshold to stop the function on. This value is ignored if the TypeOfStoppingCondition is not a threshold.
valueTolerance: Type: SystemDouble
The tolerance between the value returned by scalar and the threshold.
type: Type: AGI.Foundation.StoppingConditionsStopType
Specifies what type of threshold or extrema this StoppingCondition is attempting to stop on.