agi.foundation.numericalmethods

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

Class DurationFunctionThresholdDetails

java.lang.Object

agi.foundation.numericalmethods.DurationFunctionThresholdDetails

public class DurationFunctionThresholdDetails
extends Object

Details of a threshold of interest in DurationFunctionExplorer.

Constructor Summary

Constructors

Constructor and Description
DurationFunctionThresholdDetails(double value) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
BehaviorWhenOnThreshold	getBehaviorWhenOnThreshold() Gets the behavior when a function value is found to exactly equal the threshold.
ConvergenceCriteria	getConvergenceCriteria() Gets the criteria used for convergence when searching for a precise crossing of this threshold.
ThresholdCrossingSolutionType	getSolutionType() Gets the type of solution required when searching for a precise crossing of this threshold.
double	getValue() Gets the threshold value of interest.
double	getValueTolerance() Gets the tolerance with which to converge on value when finding a precise crossing of this threshold.
void	setBehaviorWhenOnThreshold(BehaviorWhenOnThreshold value) Sets the behavior when a function value is found to exactly equal the threshold.
void	setConvergenceCriteria(ConvergenceCriteria value) Sets the criteria used for convergence when searching for a precise crossing of this threshold.
void	setSolutionType(ThresholdCrossingSolutionType value) Sets the type of solution required when searching for a precise crossing of this threshold.
void	setValue(double value) Sets the threshold value of interest.
void	setValueTolerance(double value) Sets the tolerance with which to converge on value when finding a precise crossing of this threshold.

Methods inherited from class java.lang.Object

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

Constructor Detail

DurationFunctionThresholdDetails

public DurationFunctionThresholdDetails(double value)

Initializes a new instance. The threshold is initially enabled.

Parameters:

value - The threshold value of interest.

Method Detail

getValue

public final double getValue()

Gets the threshold value of interest.

setValue

public final void setValue(double value)

Sets the threshold value of interest.

getValueTolerance

public final double getValueTolerance()

Gets the tolerance with which to converge on value when finding a precise crossing of this threshold. By default, this property has the value 0.0, but it is ignored because ConvergenceCriteria (get / set) is set to ConvergenceCriteria.VARIABLE.

setValueTolerance

public final void setValueTolerance(double value)

Sets the tolerance with which to converge on value when finding a precise crossing of this threshold. By default, this property has the value 0.0, but it is ignored because ConvergenceCriteria (get / set) is set to ConvergenceCriteria.VARIABLE.

getConvergenceCriteria

@Nonnull
public final ConvergenceCriteria getConvergenceCriteria()

Gets the criteria used for convergence when searching for a precise crossing of this threshold. When set to ConvergenceCriteria.VARIABLE, the CrossingDurationTolerance (get / set) is used. When set to ConvergenceCriteria.FUNCTION, the ValueTolerance (get / set) is used. Convergence can also be allowed on ConvergenceCriteria.EITHER criteria or ConvergenceCriteria.BOTH criteria can be required. By default, this property has the value ConvergenceCriteria.VARIABLE.

setConvergenceCriteria

public final void setConvergenceCriteria(@Nonnull
                                         ConvergenceCriteria value)

Sets the criteria used for convergence when searching for a precise crossing of this threshold. When set to ConvergenceCriteria.VARIABLE, the CrossingDurationTolerance (get / set) is used. When set to ConvergenceCriteria.FUNCTION, the ValueTolerance (get / set) is used. Convergence can also be allowed on ConvergenceCriteria.EITHER criteria or ConvergenceCriteria.BOTH criteria can be required. By default, this property has the value ConvergenceCriteria.VARIABLE.

getSolutionType

@Nonnull
public final ThresholdCrossingSolutionType getSolutionType()

Gets the type of solution required when searching for a precise crossing of this threshold. This controls whether the value of the function at the identified crossing is slightly above or slightly below the threshold when it is not precisely on the threshold. By default, this property has the value ThresholdCrossingSolutionType.ON_OR_ABOVE_THRESHOLD.

setSolutionType

public final void setSolutionType(@Nonnull
                                  ThresholdCrossingSolutionType value)

Sets the type of solution required when searching for a precise crossing of this threshold. This controls whether the value of the function at the identified crossing is slightly above or slightly below the threshold when it is not precisely on the threshold. By default, this property has the value ThresholdCrossingSolutionType.ON_OR_ABOVE_THRESHOLD.

getBehaviorWhenOnThreshold

@Nonnull
public final BehaviorWhenOnThreshold getBehaviorWhenOnThreshold()

Gets the behavior when a function value is found to exactly equal the threshold. A function value exactly equal to the threshold can be treated either as above or as below the threshold. By default, this property has the value BehaviorWhenOnThreshold.TREAT_AS_ABOVE.

setBehaviorWhenOnThreshold

public final void setBehaviorWhenOnThreshold(@Nonnull
                                             BehaviorWhenOnThreshold value)

Sets the behavior when a function value is found to exactly equal the threshold. A function value exactly equal to the threshold can be treated either as above or as below the threshold. By default, this property has the value BehaviorWhenOnThreshold.TREAT_AS_ABOVE.