agi.foundation.numericalmethods

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

Class DoubleMotionInterpolator

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.numericalmethods.DoubleMotionInterpolator

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class DoubleMotionInterpolator
extends DefinitionalObject

Interpolates and extrapolates over Motions of double values.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DoubleMotionInterpolator() Initializes a new instance.
protected	DoubleMotionInterpolator(DoubleMotionInterpolator existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	DoubleMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm, int degree, DateMotionCollection1<Double> data) Initializes a new instance.
	DoubleMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm, int degree, DateMotionCollection1<Double> data, List<JulianDate> segmentBoundaryTimes) Initializes a new instance.
	DoubleMotionInterpolator(InterpolationAlgorithmType algorithmType, int degree, DateMotionCollection1<Double> data) Initializes a new instance.
	DoubleMotionInterpolator(InterpolationAlgorithmType algorithmType, int degree, DateMotionCollection1<Double> data, List<JulianDate> segmentBoundaryTimes) 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.
protected boolean	checkForSameDefinition(DoubleMotionInterpolator 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
DateMotionCollection1<Double>	getData() Gets the data over which to interpolate.
int	getDegree() Gets the degree of interpolation to perform.
MotionEvaluator1<Double>	getEvaluator() Gets an evaluator that interpolates and extrapolates over Motions of double values.
MotionEvaluator1<Double>	getEvaluator(EvaluatorGroup group) Gets an evaluator that interpolates and extrapolates over Motions of double values.
InterpolationAlgorithm	getInterpolationAlgorithm() Gets the interpolation algorithm used to interpolate.
List<JulianDate>	getSegmentBoundaryTimes() Gets the boundary times between segments that the interpolator should not interpolate over.
void	setData(DateMotionCollection1<Double> value) Sets the data over which to interpolate.
void	setDegree(int value) Sets the degree of interpolation to perform.
void	setInterpolationAlgorithm(InterpolationAlgorithm value) Sets the interpolation algorithm used to interpolate.
void	setSegmentBoundaryTimes(List<JulianDate> value) Sets the boundary times between segments that the interpolator should not interpolate over.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, 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

DoubleMotionInterpolator

public DoubleMotionInterpolator()

Initializes a new instance. The user must set the InterpolationAlgorithm (get / set) and Data (get / set) properties. The Degree (get / set) property is initialized to 5 by default.

DoubleMotionInterpolator

public DoubleMotionInterpolator(@Nonnull
                                InterpolationAlgorithmType algorithmType,
                                int degree,
                                DateMotionCollection1<Double> data)

Initializes a new instance.

Parameters:

algorithmType - The type of interpolation algorithm to use to interpolate the motion.

degree - The degree of interpolation to perform.

data - The data over which to interpolate.

DoubleMotionInterpolator

public DoubleMotionInterpolator(@Nonnull
                                InterpolationAlgorithmType algorithmType,
                                int degree,
                                DateMotionCollection1<Double> data,
                                List<JulianDate> segmentBoundaryTimes)

Initializes a new instance.

Parameters:

algorithmType - The type of interpolation algorithm to use to interpolate the motion.

degree - The degree of interpolation to perform.

data - The data over which to interpolate.

segmentBoundaryTimes - The boundary times between segments that the interpolator should not interpolate over.

DoubleMotionInterpolator

public DoubleMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm,
                                int degree,
                                DateMotionCollection1<Double> data)

Initializes a new instance.

Parameters:

interpolationAlgorithm - The interpolation algorithm to use to interpolate the motion.

degree - The degree of interpolation to perform.

data - The data over which to interpolate.

DoubleMotionInterpolator

public DoubleMotionInterpolator(InterpolationAlgorithm interpolationAlgorithm,
                                int degree,
                                DateMotionCollection1<Double> data,
                                List<JulianDate> segmentBoundaryTimes)

Initializes a new instance.

Parameters:

interpolationAlgorithm - The interpolation algorithm to use to interpolate the motion.

degree - The degree of interpolation to perform.

data - The data over which to interpolate.

segmentBoundaryTimes - The boundary times between segments that the interpolator should not interpolate over.

DoubleMotionInterpolator

protected DoubleMotionInterpolator(@Nonnull
                                   DoubleMotionInterpolator 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

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getSegmentBoundaryTimes

public final List<JulianDate> getSegmentBoundaryTimes()

Gets the boundary times between segments that the interpolator should not interpolate over.

setSegmentBoundaryTimes

public final void setSegmentBoundaryTimes(List<JulianDate> value)

Sets the boundary times between segments that the interpolator should not interpolate over.

getDegree

public final int getDegree()

Gets the degree of interpolation to perform.

setDegree

public final void setDegree(int value)

Sets the degree of interpolation to perform.

getInterpolationAlgorithm

public final InterpolationAlgorithm getInterpolationAlgorithm()

Gets the interpolation algorithm used to interpolate.

setInterpolationAlgorithm

public final void setInterpolationAlgorithm(InterpolationAlgorithm value)

Sets the interpolation algorithm used to interpolate.

getData

public final DateMotionCollection1<Double> getData()

Gets the data over which to interpolate.

setData

public final void setData(DateMotionCollection1<Double> value)

Sets the data over which to interpolate.

getEvaluator

@Nonnull
public final MotionEvaluator1<Double> getEvaluator()

Gets an evaluator that interpolates and extrapolates over Motions of double values.

Returns:

The Evaluator.

getEvaluator

@Nonnull
public final MotionEvaluator1<Double> getEvaluator(@Nonnull
                                                             EvaluatorGroup group)

Gets an evaluator that interpolates and extrapolates over Motions of double values.

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:

The evaluator.

Throws:

ArgumentNullException - Thrown when group is null.

PropertyInvalidException - Thrown when Data (get / set) or InterpolationAlgorithm (get / set) is null, or when InterpolationAlgorithm (get / set) does not have derivative information up to the required order.

IllegalStateException - Thrown when the InterpolationAlgorithm (get / set) requires more derivatives than were provided.