agi.foundation.numericalmethods.advanced

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

Class JulianDateFunctionExtremumFound

java.lang.Object

agi.foundation.numericalmethods.advanced.JulianDateFunctionFinding

agi.foundation.numericalmethods.advanced.JulianDateFunctionExtremumFound

public class JulianDateFunctionExtremumFound
extends JulianDateFunctionFinding

A finding by JulianDateFunctionExplorer that a function has a local extremum at a specific date.

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionExtremumFound(JulianDateFunctionExtremumIndicated indication, JulianDate extremumDate, double extremumValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
JulianDateFunctionExplorer	getExplorer() Gets the JulianDateFunctionExplorer that found this extremum.
JulianDate	getExtremumDate() Gets the date of the extremum.
ExtremumType	getExtremumType() Gets a function value indicating whether the extremum is a minimum or maximum.
double	getExtremumValue() Gets the function value of the extremum.
JulianDateFunctionDetails	getFunction() Gets the function for which the extremum was found.
JulianDateFunctionExtremumIndicated	getIndication() Gets the finding that indicated the existence of this extremum.
boolean	getIsEndpointExtremum() Gets a value indicating whether or not this extremum occurred at one of the endpoints of an interval explored with JulianDateFunctionExplorer.explore(JulianDate,JulianDate).

Methods inherited from class java.lang.Object

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

Constructor Detail

JulianDateFunctionExtremumFound

public JulianDateFunctionExtremumFound(JulianDateFunctionExtremumIndicated indication,
                                       @Nonnull
                                       JulianDate extremumDate,
                                       double extremumValue)

Initializes a new instance.

Parameters:

indication - The finding that indicated the existence of this extremum.

extremumDate - The date of the extremum.

extremumValue - The function value of the extremum.

Method Detail

getExplorer

public final JulianDateFunctionExplorer getExplorer()

Gets the JulianDateFunctionExplorer that found this extremum.

getFunction

public final JulianDateFunctionDetails getFunction()

Gets the function for which the extremum was found.

getIndication

public final JulianDateFunctionExtremumIndicated getIndication()

Gets the finding that indicated the existence of this extremum.

getExtremumDate

@Nonnull
public final JulianDate getExtremumDate()

Gets the date of the extremum.

getExtremumValue

public final double getExtremumValue()

Gets the function value of the extremum.

getExtremumType

@Nonnull
public final ExtremumType getExtremumType()

Gets a function value indicating whether the extremum is a minimum or maximum.

getIsEndpointExtremum

public final boolean getIsEndpointExtremum()

Gets a value indicating whether or not this extremum occurred at one of the endpoints of an interval explored with JulianDateFunctionExplorer.explore(JulianDate,JulianDate). Endpoint extrema do not necessarily indicate places in the function have a derivative of zero, but they can still be global minima or maxima over the evaluation interval.