agi.foundation.numericalmethods.advanced

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

Class DoubleFunctionThresholdCrossingFound

java.lang.Object

agi.foundation.numericalmethods.advanced.DoubleFunctionFinding

agi.foundation.numericalmethods.advanced.DoubleFunctionThresholdCrossingFound

public class DoubleFunctionThresholdCrossingFound
extends DoubleFunctionFinding

A finding by DoubleFunctionExplorer that a function crossed a threshold at a specific Variable.

Constructor Summary

Constructors

Constructor and Description
DoubleFunctionThresholdCrossingFound(DoubleFunctionThresholdCrossingIndicated indication, double crossingVariable, double crossingValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
double	getCrossingValue() Gets the function value at the crossing.
double	getCrossingVariable() Gets the Variable at which the crossing occurs.
DoubleFunctionExplorer	getExplorer() Gets the DoubleFunctionExplorer that found this crossing.
DoubleFunctionDetails	getFunction() Gets the function that crossed the threshold.
DoubleFunctionThresholdCrossingIndicated	getIndication() Gets the finding that originally indicated the existence of this threshold crossing.
FunctionSegmentSlope	getSlope() Gets the slope of the function at the crossing.
DoubleFunctionThresholdDetails	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

DoubleFunctionThresholdCrossingFound

public DoubleFunctionThresholdCrossingFound(DoubleFunctionThresholdCrossingIndicated indication,
                                            double crossingVariable,
                                            double crossingValue)

Initializes a new instance.

Parameters:

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

crossingVariable - The Variable at which the crossing occurs.

crossingValue - The function value at the crossing.

Method Detail

getExplorer

public final DoubleFunctionExplorer getExplorer()

Gets the DoubleFunctionExplorer that found this crossing.

getFunction

public final DoubleFunctionDetails getFunction()

Gets the function that crossed the threshold.

getThreshold

public final DoubleFunctionThresholdDetails getThreshold()

Gets the threshold crossed by the function.

getCrossingVariable

public final double getCrossingVariable()

Gets the Variable 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 DoubleFunctionThresholdCrossingIndicated getIndication()

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