agi.foundation.numericalmethods.advanced

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

Class JulianDateFunctionThresholdCrossingFound

java.lang.Object

agi.foundation.numericalmethods.advanced.JulianDateFunctionFinding

agi.foundation.numericalmethods.advanced.JulianDateFunctionThresholdCrossingFound

public class JulianDateFunctionThresholdCrossingFound
extends JulianDateFunctionFinding

A finding by JulianDateFunctionExplorer that a function crossed a threshold at a specific date.

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionThresholdCrossingFound(JulianDateFunctionThresholdCrossingIndicated indication, JulianDate crossingDate, double crossingValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDate	getCrossingDate() Gets the date at which the crossing occurs.
double	getCrossingValue() Gets the function value at the crossing.
JulianDateFunctionExplorer	getExplorer() Gets the JulianDateFunctionExplorer that found this crossing.
JulianDateFunctionDetails	getFunction() Gets the function that crossed the threshold.
JulianDateFunctionThresholdCrossingIndicated	getIndication() Gets the finding that originally indicated the existence of this threshold crossing.
FunctionSegmentSlope	getSlope() Gets the slope of the function at the crossing.
JulianDateFunctionThresholdDetails	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

JulianDateFunctionThresholdCrossingFound

public JulianDateFunctionThresholdCrossingFound(JulianDateFunctionThresholdCrossingIndicated indication,
                                                @Nonnull
                                                JulianDate crossingDate,
                                                double crossingValue)

Initializes a new instance.

Parameters:

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

crossingDate - The date at which the crossing occurs.

crossingValue - The function value at the crossing.

Method Detail

getExplorer

public final JulianDateFunctionExplorer getExplorer()

Gets the JulianDateFunctionExplorer that found this crossing.

getFunction

public final JulianDateFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final JulianDateFunctionThresholdDetails getThreshold()

Gets the threshold crossed by the function.

getCrossingDate

@Nonnull
public final JulianDate getCrossingDate()

Gets the date 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 JulianDateFunctionThresholdCrossingIndicated getIndication()

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