agi.foundation.numericalmethods.advanced

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

Class InterpolationAlgorithm

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.numericalmethods.advanced.InterpolationAlgorithm

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

HermitePolynomialApproximation, LagrangeOrbitVariationOfParameters, LagrangePolynomialApproximation, LinearApproximation

public abstract class InterpolationAlgorithm
extends DefinitionalObject

An algorithm for computing the interpolated value of a function for a new independent variable value from a list of known values of the function at different independent variable values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InterpolationAlgorithm() Initializes a new instance.
protected	InterpolationAlgorithm(InterpolationAlgorithm existingInstance, CopyContext context) Initializes a new instance as a copy of an existing 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.
protected abstract boolean	checkForSameDefinition(InterpolationAlgorithm other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
abstract int	getDegreeRequired() Gets the minimum degree of approximation that this interpolator can perform.
Interpolator	getInterpolator() Gets an evaluator which can compute the interpolated value of a function.
abstract Interpolator	getInterpolator(EvaluatorGroup group) Gets an evaluator which can compute the interpolated value of a function.
abstract int	getOrderRequired() Gets the number of derivatives of the dependent variable that are required on input in order to interpolate using this interpolation algorithm.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterpolationAlgorithm

protected InterpolationAlgorithm()

Initializes a new instance.

InterpolationAlgorithm

protected InterpolationAlgorithm(@Nonnull
                                 InterpolationAlgorithm existingInstance,
                                 @Nonnull
                                 CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final 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.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(InterpolationAlgorithm 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).

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 InterpolationAlgorithm.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

getDegreeRequired

public abstract int getDegreeRequired()

Gets the minimum degree of approximation that this interpolator can perform.

getOrderRequired

public abstract int getOrderRequired()

Gets the number of derivatives of the dependent variable that are required on input in order to interpolate using this interpolation algorithm.

getInterpolator

@Nonnull
public final Interpolator getInterpolator()

Gets an evaluator which can compute the interpolated value of a function.

Returns:

An interpolator for this interpolation algorithm.

getInterpolator

@Nonnull
public abstract Interpolator getInterpolator(@Nonnull
                                                       EvaluatorGroup group)

Gets an evaluator which can compute the interpolated value of a function.

Parameters:

group - The group with which to associate the new evaluator. By grouping evaluators that are often evaluated at the same Julian dates, common computations can be performed only once for the entire group instead of multiple times for each evaluator.

Returns:

An interpolator for this interpolation algorithm.