ThresholdStoppingConditionConstraint Class |
Namespace: AGI.Foundation.StoppingConditions
The ThresholdStoppingConditionConstraint type exposes the following members.
Name | Description | |
---|---|---|
ThresholdStoppingConditionConstraint | Initializes a new instance. | |
ThresholdStoppingConditionConstraint(ThresholdStoppingConditionConstraint, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
ThresholdStoppingConditionConstraint(Double, Double, WhenToCheckConstraint, InequalityCondition, Boolean) |
Initializes a new instance.
|
Name | Description | |
---|---|---|
InequalityCriteria |
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.
| |
IsFrozen |
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.) | |
Name |
Gets or sets the optional name of this constraint.
(Inherited from StoppingConditionConstraint.) | |
Threshold |
Gets or sets the threshold to compare with the value evaluated by the
ThresholdStoppingConditionConstraintEvaluator.
| |
Tolerance |
Gets or sets the tolerance to use when comparing the Threshold to the value evaluated
by the ThresholdStoppingConditionConstraintEvaluator.
| |
UseAbsoluteValue |
Gets or sets a value indicating whether the magnitude of the computed value should be used when
compared to the Threshold.
| |
WhenToCheck |
Gets or sets when to check this constraint (when a stop is detected or found).
(Inherited from StoppingConditionConstraint.) |
Name | Description | |
---|---|---|
CheckForSameDefinition(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.) | |
CheckForSameDefinition(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).
(Overrides StoppingConditionConstraintCheckForSameDefinition(StoppingConditionConstraint).) | |
CheckForSameDefinition(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).
| |
Clone |
Clones this object using the specified context.
(Inherited from DefinitionalObject.) | |
ComputeCurrentDefinitionHashCode |
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 StoppingConditionConstraintComputeCurrentDefinitionHashCode.) | |
EnumerateDependencies |
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.
(Inherited from DefinitionalObject.) | |
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.) | |
Freeze |
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.) | |
FreezeAggregatedObjects |
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.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetEvaluator |
Gets a StoppingConditionConstraintEvaluator for use in the
StoppingConditionEvaluator.
(Overrides StoppingConditionConstraintGetEvaluator(EvaluatorGroup).) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsSameDefinition |
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ThrowIfFrozen |
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
ValidateProperties |
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.
|