agi.foundation.numericalmethods.advanced

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

Class DurationFunctionThresholdCrossingIndicated

java.lang.Object

agi.foundation.numericalmethods.advanced.DurationFunctionFinding

agi.foundation.numericalmethods.advanced.DurationFunctionThresholdCrossingIndicated

public class DurationFunctionThresholdCrossingIndicated
extends DurationFunctionFinding

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

Constructor Summary

Constructors

Constructor and Description
DurationFunctionThresholdCrossingIndicated(DurationFunctionExplorer explorer, DurationFunctionDetails function, DurationFunctionThresholdDetails threshold, DurationFunctionExtremumFound extremum, Duration leftDuration, double leftValue, Duration rightDuration, double rightValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
DurationFunctionThresholdCrossingFound	findPreciseCrossing() Finds the precise date at which the function crosses the threshold.
DurationFunctionExplorer	getExplorer() Gets the DurationFunctionExplorer that found this indicated crossing.
DurationFunctionExtremumFound	getExtremum() Gets the extremum that caused this threshold crossing indication, or null if this indication was not caused by an extremum.
DurationFunctionDetails	getFunction() Gets the function that crossed the threshold.
Duration	getLeftDuration() Gets the date to the left of the threshold.
double	getLeftValue() Gets the function value to the left of the threshold.
Duration	getRightDuration() 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.
DurationFunctionThresholdDetails	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

DurationFunctionThresholdCrossingIndicated

public DurationFunctionThresholdCrossingIndicated(DurationFunctionExplorer explorer,
                                                  DurationFunctionDetails function,
                                                  DurationFunctionThresholdDetails threshold,
                                                  DurationFunctionExtremumFound extremum,
                                                  @Nonnull
                                                  Duration leftDuration,
                                                  double leftValue,
                                                  @Nonnull
                                                  Duration rightDuration,
                                                  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.

leftDuration - The duration to the left of the threshold.

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

rightDuration - The duration to the right of the threshold.

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

Method Detail

getExplorer

public final DurationFunctionExplorer getExplorer()

Gets the DurationFunctionExplorer that found this indicated crossing.

getFunction

public final DurationFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final DurationFunctionThresholdDetails getThreshold()

Gets the threshold being crossed.

getLeftDuration

@Nonnull
public final Duration getLeftDuration()

Gets the date to the left of the threshold.

getLeftValue

public final double getLeftValue()

Gets the function value to the left of the threshold.

getRightDuration

@Nonnull
public final Duration getRightDuration()

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 DurationFunctionThresholdCrossingFound findPreciseCrossing()

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

Returns:

Information about the precise threshold crossing.

getExtremum

public final DurationFunctionExtremumFound getExtremum()

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