agi.foundation.numericalmethods.advanced

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

Class JulianDateFunctionThresholdCrossingIndicated

java.lang.Object

agi.foundation.numericalmethods.advanced.JulianDateFunctionFinding

agi.foundation.numericalmethods.advanced.JulianDateFunctionThresholdCrossingIndicated

public class JulianDateFunctionThresholdCrossingIndicated
extends JulianDateFunctionFinding

A finding by JulianDateFunctionExplorer that a threshold crossing is indicated somewhere between two dates, because the function values are on opposite sides of the threshold at the two dates. The precise date at which the function crosses the threshold may not yet be known.

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionThresholdCrossingIndicated(JulianDateFunctionExplorer explorer, JulianDateFunctionDetails function, JulianDateFunctionThresholdDetails threshold, JulianDateFunctionExtremumFound extremum, JulianDate leftDate, double leftValue, JulianDate rightDate, double rightValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDateFunctionThresholdCrossingFound	findPreciseCrossing() Finds the precise date at which the function crosses the threshold.
JulianDateFunctionExplorer	getExplorer() Gets the JulianDateFunctionExplorer that found this indicated crossing.
JulianDateFunctionExtremumFound	getExtremum() Gets the extremum that caused this threshold crossing indication, or null if this indication was not caused by an extremum.
JulianDateFunctionDetails	getFunction() Gets the function that crossed the threshold.
JulianDate	getLeftDate() Gets the date to the left of the threshold.
double	getLeftValue() Gets the function value to the left of the threshold.
JulianDate	getRightDate() Gets the date to the right of the threshold.
double	getRightValue() Gets the function value to the right of the threshold.
FunctionSegmentSlope	getSlope() Gets the slope of the segment that crosses the threshold.
JulianDateFunctionThresholdDetails	getThreshold() Gets the threshold being crossed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JulianDateFunctionThresholdCrossingIndicated

public JulianDateFunctionThresholdCrossingIndicated(JulianDateFunctionExplorer explorer,
                                                    JulianDateFunctionDetails function,
                                                    JulianDateFunctionThresholdDetails threshold,
                                                    JulianDateFunctionExtremumFound extremum,
                                                    @Nonnull
                                                    JulianDate leftDate,
                                                    double leftValue,
                                                    @Nonnull
                                                    JulianDate rightDate,
                                                    double rightValue)

Initializes a new instance.

Parameters:

explorer - The instance that identified this threshold crossing.

function - The function that crossed the threshold.

threshold - The threshold that was crossed.

extremum - The extremum that led to the discovery of this crossing, or null if and extremum was not involved in the discovery of this crossing.

leftDate - The date to the left of the threshold.

leftValue - The function value to the left of the threshold.

rightDate - The date to the right of the threshold.

rightValue - The function value to the right of the threshold.

Method Detail

getExplorer

public final JulianDateFunctionExplorer getExplorer()

Gets the JulianDateFunctionExplorer that found this indicated crossing.

getFunction

public final JulianDateFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final JulianDateFunctionThresholdDetails getThreshold()

Gets the threshold being crossed.

getLeftDate

@Nonnull
public final JulianDate getLeftDate()

Gets the date to the left of the threshold.

getLeftValue

public final double getLeftValue()

Gets the function value to the left of the threshold.

getRightDate

@Nonnull
public final JulianDate getRightDate()

Gets the date to the right of the threshold.

getRightValue

public final double getRightValue()

Gets the function value to the right of the threshold.

getSlope

@Nonnull
public final FunctionSegmentSlope getSlope()

Gets the slope of the segment that crosses the threshold.

findPreciseCrossing

public final JulianDateFunctionThresholdCrossingFound findPreciseCrossing()

Finds the precise date at which the function crosses the threshold.

Returns:

Information about the precise threshold crossing.

getExtremum

public final JulianDateFunctionExtremumFound getExtremum()

Gets the extremum that caused this threshold crossing indication, or null if this indication was not caused by an extremum.