agi.foundation.stoppingconditions

(agi.foundation.models-2024r3.jar)

Class ThresholdStoppingConditionConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.stoppingconditions.StoppingConditionConstraint

agi.foundation.stoppingconditions.ThresholdStoppingConditionConstraint

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DurationStoppingConditionConstraint, ScalarStoppingConditionConstraint, ValueInStateStoppingConditionConstraint

public abstract class ThresholdStoppingConditionConstraint
extends StoppingConditionConstraint

A StoppingConditionConstraint that will compute a single value and compare it to a Threshold (get / set) to determine if this constraint is satisfied.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThresholdStoppingConditionConstraint() Initializes a new instance.
protected	ThresholdStoppingConditionConstraint(double threshold, double tolerance, WhenToCheckConstraint whenToCheck, InequalityCondition inequality, boolean useAbsoluteValue) Initializes a new instance.
protected	ThresholdStoppingConditionConstraint(ThresholdStoppingConditionConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(StoppingConditionConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(ThresholdStoppingConditionConstraint other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract StoppingConditionConstraintEvaluator	getEvaluator(EvaluatorGroup group) Gets a StoppingConditionConstraintEvaluator for use in the StoppingConditionEvaluator.
InequalityCondition	getInequalityCriteria() Gets how the calculated value should be checked to the threshold in the concrete type.
double	getThreshold() Gets the threshold to compare with the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
double	getTolerance() Gets the tolerance to use when comparing the Threshold (get / set) to the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
boolean	getUseAbsoluteValue() Gets a value indicating whether the magnitude of the computed value should be used when compared to the Threshold (get / set).
void	setInequalityCriteria(InequalityCondition value) Sets how the calculated value should be checked to the threshold in the concrete type.
void	setThreshold(double value) Sets the threshold to compare with the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
void	setTolerance(double value) Sets the tolerance to use when comparing the Threshold (get / set) to the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.
void	setUseAbsoluteValue(boolean value) Sets a value indicating whether the magnitude of the computed value should be used when compared to the Threshold (get / set).
protected void	validateProperties() Validates that required properties are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.stoppingconditions.StoppingConditionConstraint

checkForSameDefinition, getName, getWhenToCheck, setName, setWhenToCheck

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThresholdStoppingConditionConstraint

protected ThresholdStoppingConditionConstraint()

Initializes a new instance.

ThresholdStoppingConditionConstraint

protected ThresholdStoppingConditionConstraint(double threshold,
                                               double tolerance,
                                               @Nonnull
                                               WhenToCheckConstraint whenToCheck,
                                               @Nonnull
                                               InequalityCondition inequality,
                                               boolean useAbsoluteValue)

Initializes a new instance.

Parameters:

threshold - The threshold to compare with the value that gets evaluated.

tolerance - The tolerance to use when comparing the threshold with the evaluated value.

whenToCheck - Specifies whether this condition should be checked when a stop is detected or found.

inequality - Specifies how the value gets evaluated by this constraint gets compared to the threshold.

useAbsoluteValue - Specifies if the absolute value of the computed value should be used when compared to the threshold or not.

ThresholdStoppingConditionConstraint

protected ThresholdStoppingConditionConstraint(@Nonnull
                                               ThresholdStoppingConditionConstraint existingInstance,
                                               @Nonnull
                                               CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(StoppingConditionConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class StoppingConditionConstraint

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(ThresholdStoppingConditionConstraint other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int 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 ThresholdStoppingConditionConstraint.checkForSameDefinition(agi.foundation.stoppingconditions.StoppingConditionConstraint) method.

Overrides:

computeCurrentDefinitionHashCode in class StoppingConditionConstraint

Returns:

The computed hash code.

getInequalityCriteria

@Nonnull
public final InequalityCondition getInequalityCriteria()

Gets 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 (get / set) is 6000 and this property set to InequalityCondition.GREATER_THAN, this constraint will be satisfied.

setInequalityCriteria

public final void setInequalityCriteria(@Nonnull
                                        InequalityCondition value)

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 (get / set) is 6000 and this property set to InequalityCondition.GREATER_THAN, this constraint will be satisfied.

getUseAbsoluteValue

public final boolean getUseAbsoluteValue()

Gets a value indicating whether the magnitude of the computed value should be used when compared to the Threshold (get / set).

setUseAbsoluteValue

public final void setUseAbsoluteValue(boolean value)

Sets a value indicating whether the magnitude of the computed value should be used when compared to the Threshold (get / set).

getThreshold

public double getThreshold()

Gets the threshold to compare with the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.

setThreshold

public void setThreshold(double value)

Sets the threshold to compare with the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.

getTolerance

public double getTolerance()

Gets the tolerance to use when comparing the Threshold (get / set) to the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.

setTolerance

public void setTolerance(double value)

Sets the tolerance to use when comparing the Threshold (get / set) to the value evaluated by the ThresholdStoppingConditionConstraintEvaluator.

getEvaluator

public abstract StoppingConditionConstraintEvaluator getEvaluator(EvaluatorGroup group)

Gets a StoppingConditionConstraintEvaluator for use in the StoppingConditionEvaluator.

Derived classes should call ThresholdStoppingConditionConstraint.validateProperties() to check properties owned by this base class, as well as validate their own properties.

Specified by:

getEvaluator in class StoppingConditionConstraint

Parameters:

group - The group to use to initialize any evaluators that will be used by actual constraint.

Returns:

The evaluator for this StoppingConditionConstraint.

validateProperties

protected void 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 ThresholdStoppingConditionConstraint.getEvaluator(agi.foundation.EvaluatorGroup), as well as validate their own properties.

Throws:

PropertyInvalidException - Thrown when Tolerance (get / set) is negative and InequalityCriteria (get / set) is InequalityCondition.EQUALS or InequalityCondition.NOT_EQUALS.