agi.foundation.numericalmethods.advanced

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

Class DoubleFunctionThresholdCrossingIndicated

java.lang.Object

agi.foundation.numericalmethods.advanced.DoubleFunctionFinding

agi.foundation.numericalmethods.advanced.DoubleFunctionThresholdCrossingIndicated

public class DoubleFunctionThresholdCrossingIndicated
extends DoubleFunctionFinding

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

Constructor Summary

Constructors

Constructor and Description
DoubleFunctionThresholdCrossingIndicated(DoubleFunctionExplorer explorer, DoubleFunctionDetails function, DoubleFunctionThresholdDetails threshold, DoubleFunctionExtremumFound extremum, double leftVariable, double leftValue, double rightVariable, double rightValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
DoubleFunctionThresholdCrossingFound	findPreciseCrossing() Finds the precise date at which the function crosses the threshold.
DoubleFunctionExplorer	getExplorer() Gets the DoubleFunctionExplorer that found this indicated crossing.
DoubleFunctionExtremumFound	getExtremum() Gets the extremum that caused this threshold crossing indication, or null if this indication was not caused by an extremum.
DoubleFunctionDetails	getFunction() Gets the function that crossed the threshold.
double	getLeftValue() Gets the function value to the left of the threshold.
double	getLeftVariable() Gets the date to the left of the threshold.
double	getRightValue() Gets the function value to the right of the threshold.
double	getRightVariable() Gets the date to the right of the threshold.
FunctionSegmentSlope	getSlope() Gets the slope of the segment that crosses the threshold.
DoubleFunctionThresholdDetails	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

DoubleFunctionThresholdCrossingIndicated

public DoubleFunctionThresholdCrossingIndicated(DoubleFunctionExplorer explorer,
                                                DoubleFunctionDetails function,
                                                DoubleFunctionThresholdDetails threshold,
                                                DoubleFunctionExtremumFound extremum,
                                                double leftVariable,
                                                double leftValue,
                                                double rightVariable,
                                                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.

leftVariable - The Variable to the left of the threshold.

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

rightVariable - The Variable to the right of the threshold.

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

Method Detail

getExplorer

public final DoubleFunctionExplorer getExplorer()

Gets the DoubleFunctionExplorer that found this indicated crossing.

getFunction

public final DoubleFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final DoubleFunctionThresholdDetails getThreshold()

Gets the threshold being crossed.

getLeftVariable

public final double getLeftVariable()

Gets the date to the left of the threshold.

getLeftValue

public final double getLeftValue()

Gets the function value to the left of the threshold.

getRightVariable

public final double getRightVariable()

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

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

Returns:

Information about the precise threshold crossing.

getExtremum

public final DoubleFunctionExtremumFound getExtremum()

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