agi.foundation.numericalmethods

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

Class JulianDateFunctionDetails

java.lang.Object

agi.foundation.numericalmethods.JulianDateFunctionDetails

public class JulianDateFunctionDetails
extends Object

Holds details of a function to be explored with JulianDateFunctionExplorer.

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionDetails() Initializes a new instance.
JulianDateFunctionDetails(JulianDateSimpleFunction function) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
double	getCurrentValue() Gets the value of the function at the CurrentDate (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.
JulianDateFunctionExplorer	getExplorer() Gets the JulianDateFunctionExplorer 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.
JulianDateSimpleFunction	getFunction() Gets the function to explore.
double	getPreviousPreviousValue() Gets the value of the function at the PreviousPreviousDate (get).
boolean	getPreviousPreviousValueIsValid() Gets a value indicating whether PreviousPreviousValue (get) is valid.
double	getPreviousValue() Gets the value of the function at the PreviousDate (get).
boolean	getPreviousValueIsValid() Gets a value indicating whether PreviousValue (get) is valid.
JulianDateFunctionThresholdCollection	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(JulianDateSimpleFunction 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

JulianDateFunctionDetails

public JulianDateFunctionDetails()

Initializes a new instance.

JulianDateFunctionDetails

public JulianDateFunctionDetails(JulianDateSimpleFunction function)

Initializes a new instance.

Parameters:

function - The function to explore.

Method Detail

getExplorer

public final JulianDateFunctionExplorer getExplorer()

Gets the JulianDateFunctionExplorer that is exploring this function.

getFunction

public final JulianDateSimpleFunction getFunction()

Gets the function to explore.

setFunction

public final void setFunction(JulianDateSimpleFunction value)

Sets the function to explore.

getThresholds

@Nonnull
public final JulianDateFunctionThresholdCollection 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 ExtremumDateTolerance (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 ExtremumDateTolerance (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 CurrentDate (get).

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the CurrentDate (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 CurrentDate (get).

getPreviousValue

public final double getPreviousValue()

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

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the PreviousDate (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 PreviousDate (get).

getPreviousPreviousValue

public final double getPreviousPreviousValue()

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

Throws:

IllegalStateException - The current value is not available because the function was not sampled for the PreviousPreviousDate (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 PreviousPreviousDate (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.