agi.foundation.numericalmethods.advanced

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

Class DurationFunctionExtremumFound

java.lang.Object

agi.foundation.numericalmethods.advanced.DurationFunctionFinding

agi.foundation.numericalmethods.advanced.DurationFunctionExtremumFound

public class DurationFunctionExtremumFound
extends DurationFunctionFinding

A finding by DurationFunctionExplorer that a function has a local extremum at a specific duration.

Constructor Summary

Constructors

Constructor and Description
DurationFunctionExtremumFound(DurationFunctionExtremumIndicated indication, Duration extremumDuration, double extremumValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
DurationFunctionExplorer	getExplorer() Gets the DurationFunctionExplorer that found this extremum.
Duration	getExtremumDuration() Gets the duration 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.
DurationFunctionDetails	getFunction() Gets the function for which the extremum was found.
DurationFunctionExtremumIndicated	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 DurationFunctionExplorer.explore(Duration,Duration).

Methods inherited from class java.lang.Object

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

Constructor Detail

DurationFunctionExtremumFound

public DurationFunctionExtremumFound(DurationFunctionExtremumIndicated indication,
                                     @Nonnull
                                     Duration extremumDuration,
                                     double extremumValue)

Initializes a new instance.

Parameters:

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

extremumDuration - The duration of the extremum.

extremumValue - The function value of the extremum.

Method Detail

getExplorer

public final DurationFunctionExplorer getExplorer()

Gets the DurationFunctionExplorer that found this extremum.

getFunction

public final DurationFunctionDetails getFunction()

Gets the function for which the extremum was found.

getIndication

public final DurationFunctionExtremumIndicated getIndication()

Gets the finding that indicated the existence of this extremum.

getExtremumDuration

@Nonnull
public final Duration getExtremumDuration()

Gets the duration 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 DurationFunctionExplorer.explore(Duration,Duration). 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.