agi.foundation.numericalmethods.advanced

(agi.foundation.core-2023r1.jar)

Interface IPartialDifferentiable

All Superinterfaces:

IEquatableDefinition

All Known Implementing Classes:

AtmosphericDragForce, ContinuousThrustForceModel, PartialDerivativesFixed, PartialDerivativesSum, PointInReferenceFrame, PointPropagationParameter, PropagationNewtonianPoint, ScalarAbsoluteValue, ScalarCosine, ScalarDensityJacchia1970, ScalarDensityJacchiaRoberts, ScalarDensityMsis2000, ScalarDensityMsis86, ScalarDensityMsis90, ScalarExponent, ScalarFixed, ScalarOccultationCylindrical, ScalarOccultationDualCone, ScalarOccultationNoShadow, ScalarOccultationRegulatedDualCone, ScalarProduct, ScalarSine, ScalarSum, SimpleSolarRadiationForce, SphericalHarmonicGravity, ThirdBodyGravity, TwoBodyGravity, VectorPropagationParameter

public interface IPartialDifferentiable
extends IEquatableDefinition

Classes that implement this interface represent values which have partial derivatives associated with them, and contain the method IPartialDifferentiable.getPartialDerivativesEvaluator(java.util.List<agi.foundation.numericalmethods.advanced.IPartialDifferentiable>, agi.foundation.EvaluatorGroup) to produce an evaluator to calculate those partial derivatives.

Method Summary

Modifier and Type	Method and Description
int	getDimension() Gets the dimension of the values produced by the object.
PartialDerivativesEvaluator	getPartialDerivativesEvaluator(List<IPartialDifferentiable> independentVariables, EvaluatorGroup group) Constructs the PartialDerivativesEvaluator that will calculate the partial derivatives of this IPartialDifferentiable object with respect to any of the parameters in the independentVariables that apply.

Methods inherited from interface agi.foundation.infrastructure.IEquatableDefinition

getDefinitionHashCode, isSameDefinition

Method Detail

getDimension

int getDimension()

Gets the dimension of the values produced by the object. For example, Vectors would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator created by this type will have a RowDimension (get) equal to this property, and a ColumnDimension (get) equal to the summation of the dimensions of the independent variables that this object is dependent on.

getPartialDerivativesEvaluator

@Nonnull
PartialDerivativesEvaluator getPartialDerivativesEvaluator(@Nonnull
                                                                     List<IPartialDifferentiable> independentVariables,
                                                                     @Nonnull
                                                                     EvaluatorGroup group)

Constructs the PartialDerivativesEvaluator that will calculate the partial derivatives of this IPartialDifferentiable object with respect to any of the parameters in the independentVariables that apply.

Parameters:

independentVariables - The list of IPartialDifferentiable representing the independent variables that the created partial derivative evaluator calculates partials with respect to.

group - The EvaluatorGroup that will contain the created evaluator.

Returns:

The PartialDerivativesEvaluator.