agi.foundation.numericalmethods

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

Class DoubleFunctionDetails

java.lang.Object

agi.foundation.numericalmethods.DoubleFunctionDetails

public class DoubleFunctionDetails
extends Object

Holds details of a function to be explored with DoubleFunctionExplorer.

Constructor Summary

Constructors

Constructor and Description
DoubleFunctionDetails() Initializes a new instance.
DoubleFunctionDetails(DoubleSimpleFunction function) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
double	getCurrentValue() Gets the value of the function at the CurrentVariable (get).
boolean	getCurrentValueIsValid() Gets a value indicating whether CurrentValue (get) is valid.
HierarchicalLogger	getDebuggingLogger() Gets the HierarchicalLogger, used to provide debugging output for the findings analysis.
DoubleFunctionExplorer	getExplorer() Gets the DoubleFunctionExplorer that is exploring this function.
ConvergenceCriteria	getExtremumConvergenceCriteria() Gets the criteria used for convergence when searching for a precise local extremum of this function.
double	getExtremumValueTolerance() Gets the tolerance with which to converge on function value when finding a local extremum of this function.
DoubleSimpleFunction	getFunction() Gets the function to explore.
double	getPreviousPreviousValue() Gets the value of the function at the PreviousPreviousVariable (get).
boolean	getPreviousPreviousValueIsValid() Gets a value indicating whether PreviousPreviousValue (get) is valid.
double	getPreviousValue() Gets the value of the function at the PreviousVariable (get).
boolean	getPreviousValueIsValid() Gets a value indicating whether PreviousValue (get) is valid.
DoubleFunctionThresholdCollection	getThresholds() Gets the collection of thresholds of interest.
void	setDebuggingLogger(HierarchicalLogger value) Sets the HierarchicalLogger, used to provide debugging output for the findings analysis.
void	setExtremumConvergenceCriteria(ConvergenceCriteria value) Sets the criteria used for convergence when searching for a precise local extremum of this function.
void	setExtremumValueTolerance(double value) Sets the tolerance with which to converge on function value when finding a local extremum of this function.
void	setFunction(DoubleSimpleFunction value) Sets the function to explore.

Methods inherited from class java.lang.Object

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

Constructor Detail

DoubleFunctionDetails

public DoubleFunctionDetails()

Initializes a new instance.

DoubleFunctionDetails

public DoubleFunctionDetails(DoubleSimpleFunction function)

Initializes a new instance.

Parameters:

function - The function to explore.

Method Detail

getExplorer

public final DoubleFunctionExplorer getExplorer()

Gets the DoubleFunctionExplorer that is exploring this function.

getFunction

public final DoubleSimpleFunction getFunction()

Gets the function to explore.

setFunction

public final void setFunction(DoubleSimpleFunction value)

Sets the function to explore.

getThresholds

@Nonnull
public final DoubleFunctionThresholdCollection getThresholds()

Gets the collection of thresholds of interest.

getExtremumValueTolerance

public final double getExtremumValueTolerance()

Gets the tolerance with which to converge on function value when finding a local extremum of this function. By default, this property has the value 0.0, but it is ignored because ExtremumConvergenceCriteria (get / set) is set to ConvergenceCriteria.VARIABLE.

setExtremumValueTolerance

public final void setExtremumValueTolerance(double value)

Sets the tolerance with which to converge on function value when finding a local extremum of this function. By default, this property has the value 0.0, but it is ignored because ExtremumConvergenceCriteria (get / set) is set to ConvergenceCriteria.VARIABLE.

getExtremumConvergenceCriteria

@Nonnull
public final ConvergenceCriteria getExtremumConvergenceCriteria()

Gets the criteria used for convergence when searching for a precise local extremum of this function. When set to ConvergenceCriteria.VARIABLE, the ExtremumVariableTolerance (get / set) is used. When set to ConvergenceCriteria.FUNCTION, the ExtremumValueTolerance (get / set) is used. Convergence can also be allowed on ConvergenceCriteria.EITHER criteria or ConvergenceCriteria.BOTH criteria can be required. By default, this property has the value ConvergenceCriteria.VARIABLE.

setExtremumConvergenceCriteria

public final void setExtremumConvergenceCriteria(@Nonnull
                                                 ConvergenceCriteria value)

Sets the criteria used for convergence when searching for a precise local extremum of this function. When set to ConvergenceCriteria.VARIABLE, the ExtremumVariableTolerance (get / set) is used. When set to ConvergenceCriteria.FUNCTION, the ExtremumValueTolerance (get / set) is used. Convergence can also be allowed on ConvergenceCriteria.EITHER criteria or ConvergenceCriteria.BOTH criteria can be required. By default, this property has the value ConvergenceCriteria.VARIABLE.

getCurrentValue

public final double getCurrentValue()

Gets the value of the function at the CurrentVariable (get).

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the CurrentVariable (get).

getCurrentValueIsValid

public final boolean getCurrentValueIsValid()

Gets a value indicating whether CurrentValue (get) is valid. CurrentValue (get) is invalid if the function was not sampled for the CurrentVariable (get).

getPreviousValue

public final double getPreviousValue()

Gets the value of the function at the PreviousVariable (get).

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the PreviousVariable (get).

getPreviousValueIsValid

public final boolean getPreviousValueIsValid()

Gets a value indicating whether PreviousValue (get) is valid. PreviousValue (get) is invalid if the function was not sampled for the PreviousVariable (get).

getPreviousPreviousValue

public final double getPreviousPreviousValue()

Gets the value of the function at the PreviousPreviousVariable (get).

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the PreviousPreviousVariable (get).

getPreviousPreviousValueIsValid

public final boolean getPreviousPreviousValueIsValid()

Gets a value indicating whether PreviousPreviousValue (get) is valid. PreviousPreviousValue (get) is invalid if the function was not sampled for the PreviousPreviousVariable (get).

getDebuggingLogger

public final HierarchicalLogger getDebuggingLogger()

Gets the HierarchicalLogger, used to provide debugging output for the findings analysis.

setDebuggingLogger

public final void setDebuggingLogger(HierarchicalLogger value)

Sets the HierarchicalLogger, used to provide debugging output for the findings analysis.