agi.foundation.numericalmethods.advanced

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

Class DurationFunctionThresholdCrossingFound

java.lang.Object

agi.foundation.numericalmethods.advanced.DurationFunctionFinding

agi.foundation.numericalmethods.advanced.DurationFunctionThresholdCrossingFound

public class DurationFunctionThresholdCrossingFound
extends DurationFunctionFinding

A finding by DurationFunctionExplorer that a function crossed a threshold at a specific duration.

Constructor Summary

Constructors

Constructor and Description
DurationFunctionThresholdCrossingFound(DurationFunctionThresholdCrossingIndicated indication, Duration crossingDuration, double crossingValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Duration	getCrossingDuration() Gets the duration at which the crossing occurs.
double	getCrossingValue() Gets the function value at the crossing.
DurationFunctionExplorer	getExplorer() Gets the DurationFunctionExplorer that found this crossing.
DurationFunctionDetails	getFunction() Gets the function that crossed the threshold.
DurationFunctionThresholdCrossingIndicated	getIndication() Gets the finding that originally indicated the existence of this threshold crossing.
FunctionSegmentSlope	getSlope() Gets the slope of the function at the crossing.
DurationFunctionThresholdDetails	getThreshold() Gets the threshold crossed by the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

DurationFunctionThresholdCrossingFound

public DurationFunctionThresholdCrossingFound(DurationFunctionThresholdCrossingIndicated indication,
                                              @Nonnull
                                              Duration crossingDuration,
                                              double crossingValue)

Initializes a new instance.

Parameters:

indication - The finding that originally indicated the existence of this threshold crossing.

crossingDuration - The duration at which the crossing occurs.

crossingValue - The function value at the crossing.

Method Detail

getExplorer

public final DurationFunctionExplorer getExplorer()

Gets the DurationFunctionExplorer that found this crossing.

getFunction

public final DurationFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final DurationFunctionThresholdDetails getThreshold()

Gets the threshold crossed by the function.

getCrossingDuration

@Nonnull
public final Duration getCrossingDuration()

Gets the duration at which the crossing occurs.

getCrossingValue

public final double getCrossingValue()

Gets the function value at the crossing.

getSlope

@Nonnull
public final FunctionSegmentSlope getSlope()

Gets the slope of the function at the crossing.

getIndication

public final DurationFunctionThresholdCrossingIndicated getIndication()

Gets the finding that originally indicated the existence of this threshold crossing.