agi.foundation.numericalmethods

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

Class JulianDateFunctionSampling

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.numericalmethods.JulianDateFunctionSampling

All Implemented Interfaces:

IEquatable<JulianDateFunctionSampling>, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class JulianDateFunctionSampling
extends DefinitionalObject
implements IEquatable<JulianDateFunctionSampling>

Species how sampling of a function of JulianDate should be performed.

Constructor Summary

Constructors

Constructor and Description
JulianDateFunctionSampling() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(JulianDateFunctionSampling other) Indicates whether another instance of this type is exactly equal to this instance.
Duration	getDefaultStep() Gets the default step that will be taken when sampling a function.
double	getExtremaCrossingUncertaintyFactor() Gets a value determining how finely to explore an extremum with the potential to cross a threshold.
IJulianDateFunctionSampler	getFunctionSampler() Creates a sampler that takes the DefaultStep (get / set).
IJulianDateFunctionSampler	getFunctionSampler(Function2<JulianDate,Double> function) Creates a sampler that takes a step suggested by a given function, or the DefaultStep (get / set) if not step is suggested.
Duration	getMaximumStep() Gets the largest step that will be taken when sampling a function.
Duration	getMinimumStep() Gets the smallest step that will be taken when sampling a function.
Duration	getTolerance() Gets the tolerance used for convergence in the independent variable.
Duration	getTrendingStep() Gets the size of a trending step that will be taken at the beginning and end of each interval of consideration.
boolean	getUseFunctionSamplingSuggestion() Gets a value indicating whether the sampling suggestion from the constraint should be used.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
void	setDefaultStep(Duration value) Sets the default step that will be taken when sampling a function.
void	setExtremaCrossingUncertaintyFactor(double value) Sets a value determining how finely to explore an extremum with the potential to cross a threshold.
void	setMaximumStep(Duration value) Sets the largest step that will be taken when sampling a function.
void	setMinimumStep(Duration value) Sets the smallest step that will be taken when sampling a function.
void	setTolerance(Duration value) Sets the tolerance used for convergence in the independent variable.
void	setTrendingStep(Duration value) Sets the size of a trending step that will be taken at the beginning and end of each interval of consideration.
void	setUseFunctionSamplingSuggestion(boolean value) Sets a value indicating whether the sampling suggestion from the constraint should be used.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

JulianDateFunctionSampling

public JulianDateFunctionSampling()

Initializes a new instance.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the JulianDateFunctionSampling.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getMinimumStep

@Nonnull
public final Duration getMinimumStep()

Gets the smallest step that will be taken when sampling a function.

setMinimumStep

public final void setMinimumStep(@Nonnull
                                 Duration value)

Sets the smallest step that will be taken when sampling a function.

getMaximumStep

@Nonnull
public final Duration getMaximumStep()

Gets the largest step that will be taken when sampling a function.

setMaximumStep

public final void setMaximumStep(@Nonnull
                                 Duration value)

Sets the largest step that will be taken when sampling a function.

getDefaultStep

@Nonnull
public final Duration getDefaultStep()

Gets the default step that will be taken when sampling a function.

setDefaultStep

public final void setDefaultStep(@Nonnull
                                 Duration value)

Sets the default step that will be taken when sampling a function.

getTrendingStep

@Nonnull
public final Duration getTrendingStep()

Gets the size of a trending step that will be taken at the beginning and end of each interval of consideration.

setTrendingStep

public final void setTrendingStep(@Nonnull
                                  Duration value)

Sets the size of a trending step that will be taken at the beginning and end of each interval of consideration.

getTolerance

@Nonnull
public final Duration getTolerance()

Gets the tolerance used for convergence in the independent variable. The default value is 0.005 seconds.

Throws:

ArgumentOutOfRangeException - Thrown if the user attempts to set a Duration whose TotalSeconds (get) is less than or equal to zero.

setTolerance

public final void setTolerance(@Nonnull
                               Duration value)

Sets the tolerance used for convergence in the independent variable. The default value is 0.005 seconds.

Throws:

ArgumentOutOfRangeException - Thrown if the user attempts to set a Duration whose TotalSeconds (get) is less than or equal to zero.

getUseFunctionSamplingSuggestion

public final boolean getUseFunctionSamplingSuggestion()

Gets a value indicating whether the sampling suggestion from the constraint should be used. If false, the constraint's suggestion is ignored and the DefaultStep (get / set) is used.

setUseFunctionSamplingSuggestion

public final void setUseFunctionSamplingSuggestion(boolean value)

Sets a value indicating whether the sampling suggestion from the constraint should be used. If false, the constraint's suggestion is ignored and the DefaultStep (get / set) is used.

getExtremaCrossingUncertaintyFactor

public final double getExtremaCrossingUncertaintyFactor()

Gets a value determining how finely to explore an extremum with the potential to cross a threshold. This value is passed along to the ExtremaCrossingUncertaintyFactor (get / set) on the JulianDateFunctionExplorer used to determine the satisfaction intervals of an AccessConstraint sampled by this sampler.

setExtremaCrossingUncertaintyFactor

public final void setExtremaCrossingUncertaintyFactor(double value)

Sets a value determining how finely to explore an extremum with the potential to cross a threshold. This value is passed along to the ExtremaCrossingUncertaintyFactor (get / set) on the JulianDateFunctionExplorer used to determine the satisfaction intervals of an AccessConstraint sampled by this sampler.

equalsType

public final boolean equalsType(JulianDateFunctionSampling other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<JulianDateFunctionSampling>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getFunctionSampler

@Nonnull
public final IJulianDateFunctionSampler getFunctionSampler()

Creates a sampler that takes the DefaultStep (get / set).

Returns:

A sampler.

getFunctionSampler

@Nonnull
public final IJulianDateFunctionSampler getFunctionSampler(Function2<JulianDate,Double> function)

Creates a sampler that takes a step suggested by a given function, or the DefaultStep (get / set) if not step is suggested.

Parameters:

function - The function that suggests the next sample.

Returns:

A sampler.