agi.foundation.numericalmethods.advanced

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

Class DoubleFunctionExtremumFound

java.lang.Object

agi.foundation.numericalmethods.advanced.DoubleFunctionFinding

agi.foundation.numericalmethods.advanced.DoubleFunctionExtremumFound

public class DoubleFunctionExtremumFound
extends DoubleFunctionFinding

A finding by DoubleFunctionExplorer that a function has a local extremum at a specific Variable.

Constructor Summary

Constructors

Constructor and Description
DoubleFunctionExtremumFound(DoubleFunctionExtremumIndicated indication, double extremumVariable, double extremumValue) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
DoubleFunctionExplorer	getExplorer() Gets the DoubleFunctionExplorer that found this 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.
double	getExtremumVariable() Gets the Variable of the extremum.
DoubleFunctionDetails	getFunction() Gets the function for which the extremum was found.
DoubleFunctionExtremumIndicated	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 DoubleFunctionExplorer.explore(double,double).

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleFunctionExtremumFound

public DoubleFunctionExtremumFound(DoubleFunctionExtremumIndicated indication,
                                   double extremumVariable,
                                   double extremumValue)

Initializes a new instance.

Parameters:

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

extremumVariable - The Variable of the extremum.

extremumValue - The function value of the extremum.

Method Detail

getExplorer

public final DoubleFunctionExplorer getExplorer()

Gets the DoubleFunctionExplorer that found this extremum.

getFunction

public final DoubleFunctionDetails getFunction()

Gets the function for which the extremum was found.

getIndication

public final DoubleFunctionExtremumIndicated getIndication()

Gets the finding that indicated the existence of this extremum.

getExtremumVariable

public final double getExtremumVariable()

Gets the Variable 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 DoubleFunctionExplorer.explore(double,double). 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.