agi.foundation.stoppingconditions

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

Class StoppingConditionConstraint

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.stoppingconditions.StoppingConditionConstraint

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

DelegateStoppingConditionConstraint, JulianDateStoppingConditionConstraint, ThresholdStoppingConditionConstraint

public abstract class StoppingConditionConstraint
extends DefinitionalObject

The definition for a StoppingConditionConstraintEvaluator. These constraints act as additional criteria for a StoppingCondition. The constraints will take the current state of propagation and return a boolean for if this state is allowed to potentially stop propagation.

Often there are times when a StoppingCondition needs additional criteria to truly stop on the desired event. Simply combining StoppingConditions usually wouldn't work; if you would AND two conditions together, they both must have their own relevant events at the exact same time. It is more reasonable to add constraints to a stopping condition that could, instead of stopping at some particular event, could instead signal that some other event has gone by, or has not happened yet.

See the Stopping Conditions topic for more detail on how to use stopping condition constraints.

Although you can create any constraint as long as it returns true or false, the common use case of computing some single value from the passed in state and comparing it to a threshold should usually be handled by the ThresholdStoppingConditionConstraint.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StoppingConditionConstraint() Initializes a new instance.
protected	StoppingConditionConstraint(StoppingConditionConstraint existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	StoppingConditionConstraint(WhenToCheckConstraint whenToCheck) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract boolean	checkForSameDefinition(StoppingConditionConstraint 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.
String	getName() Gets the optional name of this constraint.
WhenToCheckConstraint	getWhenToCheck() Gets when to check this constraint (when a stop is detected or found).
void	setName(String value) Sets the optional name of this constraint.
void	setWhenToCheck(WhenToCheckConstraint value) Sets when to check this constraint (when a stop is detected or found).

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

StoppingConditionConstraint

protected StoppingConditionConstraint()

Initializes a new instance.

StoppingConditionConstraint

protected StoppingConditionConstraint(@Nonnull
                                      WhenToCheckConstraint whenToCheck)

Initializes a new instance.

Parameters:

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

StoppingConditionConstraint

protected StoppingConditionConstraint(@Nonnull
                                      StoppingConditionConstraint 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(DefinitionalObject 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 DefinitionalObject

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(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).

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 StoppingConditionConstraint.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getName

public final String getName()

Gets the optional name of this constraint.

setName

public final void setName(String value)

Sets the optional name of this constraint.

getWhenToCheck

@Nonnull
public final WhenToCheckConstraint getWhenToCheck()

Gets when to check this constraint (when a stop is detected or found).

setWhenToCheck

public final void setWhenToCheck(@Nonnull
                                 WhenToCheckConstraint value)

Sets when to check this constraint (when a stop is detected or found).

getEvaluator

@Nonnull
public abstract StoppingConditionConstraintEvaluator getEvaluator(@Nonnull
                                                                            EvaluatorGroup group)

Gets a StoppingConditionConstraintEvaluator for use in the StoppingConditionEvaluator.

Parameters:

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

Returns:

The evaluator for this StoppingConditionConstraint.