Click or drag to resize

ScalarStoppingConditionConstraint Class

A StoppingConditionConstraintEvaluator that compares the value of a Scalar at the time of a state with a threshold.
Inheritance Hierarchy

Namespace:  AGI.Foundation.StoppingConditions
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 20.3.405.0 (20.3.405.0)
Syntax
public class ScalarStoppingConditionConstraint : ThresholdStoppingConditionConstraint

The ScalarStoppingConditionConstraint type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyInequalityCriteria
Gets or sets how the calculated value should be checked to the threshold in the concrete type. This works by checking the relation between the computed value and the threshold defined on the derived type. So for example, if the computed value is 7000, the Threshold is 6000 and this property set to GreaterThan, this constraint will be satisfied.
(Inherited from ThresholdStoppingConditionConstraint.)
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyName
Gets or sets the optional name of this StoppingConditionConstraint.
(Inherited from StoppingConditionConstraint.)
Public propertyScalar
Gets or sets the Scalar whose evaluator will compute the value to compare with the Threshold.
Public propertyThreshold
Gets or sets the threshold to compare with the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
(Inherited from ThresholdStoppingConditionConstraint.)
Public propertyTolerance
Gets or sets the tolerance to use when comparing the Threshold to the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
(Inherited from ThresholdStoppingConditionConstraint.)
Public propertyUseAbsoluteValue
Gets or sets a value indicating whether the magnitude of the computed value should be used when compared to the Threshold.
(Inherited from ThresholdStoppingConditionConstraint.)
Public propertyWhenToCheck
Gets or sets when to check the StoppingConditionConstraint (when a stop is detected or found).
(Inherited from StoppingConditionConstraint.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from StoppingConditionConstraint.)
Protected methodCheckForSameDefinition(ScalarStoppingConditionConstraint)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(StoppingConditionConstraint)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from ThresholdStoppingConditionConstraint.)
Protected methodCheckForSameDefinition(ThresholdStoppingConditionConstraint)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides ThresholdStoppingConditionConstraintCheckForSameDefinition(ThresholdStoppingConditionConstraint).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides ThresholdStoppingConditionConstraintComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
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 methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator (Overrides ThresholdStoppingConditionConstraintGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
Validates that required properties are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup), as well as validate their own properties.
(Inherited from ThresholdStoppingConditionConstraint.)
Top
See Also