agi.foundation.stoppingconditions

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

Class ThresholdStoppingConditionConstraintEvaluator

java.lang.Object

agi.foundation.stoppingconditions.StoppingConditionConstraintEvaluator

agi.foundation.stoppingconditions.ThresholdStoppingConditionConstraintEvaluator

All Implemented Interfaces:

IDisposable, IEvaluator, ICloneWithContext, IThreadAware, IAvailability, AutoCloseable

public abstract class ThresholdStoppingConditionConstraintEvaluator
extends StoppingConditionConstraintEvaluator

The StoppingConditionConstraintEvaluator for a ThresholdStoppingConditionConstraint.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThresholdStoppingConditionConstraintEvaluator(EvaluatorGroup group, ThresholdStoppingConditionConstraint definition) Initializes a new instance.
protected	ThresholdStoppingConditionConstraintEvaluator(ThresholdStoppingConditionConstraintEvaluator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
void	checkCurrentState(ITimeBasedState currentState) This method gets called every time a new ITimeBasedState is checked by the parent StoppingConditionEvaluator.
protected abstract double	evaluateSingleValue(ITimeBasedState state) This method will return the value that will be compared to the Threshold (get / set).
boolean	getIsThreadSafe() Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
boolean	isConstraintSatisfied(ITimeBasedState state) This method will examine from the state and return true if this constraint is satisfied, and false if not.
static boolean	simpleCheck(double currentValue, double threshold, double tolerance, boolean useAbsoluteValue, InequalityCondition inequalityCriteria, double smallestValue, double largestValue) Performs a simple check of the currentValue against a threshold and tolerance, using the useAbsoluteValue and inequalityCriteria to determine if this constraint is satisfied by the currentValue.

Methods inherited from class agi.foundation.stoppingconditions.StoppingConditionConstraintEvaluator

areConstraintsSatisfied, clone, dispose, dispose, getAvailabilityIntervals, getCachingWrapper, getGroup, getName, getWhenToCheck, initialize, isAvailable, updateEvaluatorReferences

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close

Constructor Detail

ThresholdStoppingConditionConstraintEvaluator

protected ThresholdStoppingConditionConstraintEvaluator(@Nonnull
                                                        EvaluatorGroup group,
                                                        @Nonnull
                                                        ThresholdStoppingConditionConstraint definition)

Initializes a new instance.

Parameters:

group - The group that contains this evaluator.

definition - The ThresholdStoppingConditionConstraint that is creating this evaluator.

Throws:

ArgumentNullException - Thrown when group or definition is null.

ThresholdStoppingConditionConstraintEvaluator

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

getIsThreadSafe

public boolean getIsThreadSafe()

Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

If this property is true, all methods and properties are guaranteed to be thread safe. Conceptually, an object that returns true for this method acts as if there is a lock protecting each method and property such that only one thread at a time can be inside any method or property in the class. In reality, such locks are generally not used and are in fact discouraged. However, the user must not experience any exceptions or inconsistent behavior that would not be experienced if such locks were used.

If this property is false, the behavior when using this class from multiple threads simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the object for each thread.

Specified by:

getIsThreadSafe in interface IThreadAware

Specified by:

getIsThreadSafe in class StoppingConditionConstraintEvaluator

simpleCheck

public static boolean simpleCheck(double currentValue,
                                  double threshold,
                                  double tolerance,
                                  boolean useAbsoluteValue,
                                  @Nonnull
                                  InequalityCondition inequalityCriteria,
                                  double smallestValue,
                                  double largestValue)

Performs a simple check of the currentValue against a threshold and tolerance, using the useAbsoluteValue and inequalityCriteria to determine if this constraint is satisfied by the currentValue. This method can be called by ThresholdStoppingConditionConstraintEvaluator.isConstraintSatisfied(agi.foundation.coordinates.ITimeBasedState) if your constraint is simply computing a value to be compared to a threshold.

Parameters:

currentValue - The current computed value.

threshold - The threshold.

tolerance - The tolerance.

smallestValue - The smallest value that has been computed up to this point.

largestValue - The largest value that has been computed up to this point.

inequalityCriteria - The InequalityCondition that should be used to compare the currentValue to the threshold.

useAbsoluteValue - Whether or not the absolute value of the currentValue should be used when determining if the constraint is satisfied.

Returns:

true if the currentValue satisfies the constraint; otherwise false.

checkCurrentState

public void checkCurrentState(ITimeBasedState currentState)

This method gets called every time a new ITimeBasedState is checked by the parent StoppingConditionEvaluator. This method should be used when the criteria of your StoppingConditionConstraintEvaluator needs to check every computed state. For example, ThresholdStoppingConditionConstraintEvaluator needs to keep track of extrema if its InequalityCriteria (get / set) is set to InequalityCondition.GREATER_THAN_MINIMUM or InequalityCondition.LESS_THAN_MAXIMUM.

Overrides:

checkCurrentState in class StoppingConditionConstraintEvaluator

Parameters:

currentState - The state to check at every step of propagation.

isConstraintSatisfied

public boolean isConstraintSatisfied(ITimeBasedState state)

This method will examine from the state and return true if this constraint is satisfied, and false if not.

Specified by:

isConstraintSatisfied in class StoppingConditionConstraintEvaluator

Parameters:

state - The state to check.

Returns:

true if this constraint is satisfied; otherwise false. When all constraints return true, then the stopping condition may stop propagation if it too is satisfied.

evaluateSingleValue

protected abstract double evaluateSingleValue(ITimeBasedState state)

This method will return the value that will be compared to the Threshold (get / set). This method does not need to deal with UseAbsoluteValue (get / set).

Parameters:

state - The current state of propagation.

Returns:

The value of the constraint.