Click or drag to resize

PartialDerivativesEvaluator Class

An interface for an evaluator that takes a JulianDate, order, and list of inputs and returns the partial derivatives of itself with respect to those inputs.
Inheritance Hierarchy
SystemObject
  AGI.FoundationFunctionJulianDate, Matrix
    AGI.FoundationMotionEvaluatorMatrix
      AGI.Foundation.GeometryDynamicMatrixEvaluator
        AGI.Foundation.NumericalMethods.AdvancedPartialDerivativesEvaluator

Namespace:  AGI.Foundation.NumericalMethods.Advanced
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public abstract class PartialDerivativesEvaluator : DynamicMatrixEvaluator

The PartialDerivativesEvaluator type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAvailabilityIntervals
Gets a TimeIntervalCollection over which data is available. If the availability interval is infinite, this returns Infinite.
(Inherited from MotionEvaluatorT.)
Public propertyColumnDimension
Gets the ColumnDimension of the Matrix object produced by the evaluation calls.
(Inherited from DynamicMatrixEvaluator.)
Public propertyDependentVariable
Gets the IPartialDifferentiable identifying the object that the partial derivatives calculated during evaluation are of.
Public propertyGroup
Gets the group that contains this evaluator.
(Inherited from MotionEvaluatorT.)
Public propertyIndependentVariables

Gets the list of IPartialDifferentiables identifying the objects that the partial derivatives calculated during evaluation are with respect to.

As an optimization this is typically only the subset of the independentVariables provided to GetPartialDerivativesEvaluator(IListIPartialDifferentiable, EvaluatorGroup) for which the DependentVariable has non-zero partials, however a user-implemented PartialDerivativesEvaluator does not have to follow that pattern.

This list of variables corresponds to the columns of the Matrix produced by Evaluate(JulianDate). Each IPartialDifferentiable in this list has a number of columns equal to its Dimension, and those column groupings follow the same order as this list. In addition, this list, while possible a subset of the independent variables specified by the user, will always be in the same order as that original list.

Public propertyIsThreadSafe
Gets a value indicating if the methods on this instance are safe to call from multiple threads simultaneously.
(Inherited from FunctionTIndependent, TDependent.)
Public propertyIsTimeVarying
Gets a value indicating whether or not the value of this evaluator changes with time. If , the evaluator is assumed to return the same value for any input JulianDate.
(Inherited from MotionEvaluatorT.)
Public propertyRowDimension
Gets the RowDimension of the Matrix object produced by the evaluation calls.
(Inherited from DynamicMatrixEvaluator.)
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
(Inherited from FunctionTIndependent, TDependent.)
Public methodDispose
Releases any resources associated with this instance.
(Inherited from FunctionTIndependent, TDependent.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Inherited from FunctionTIndependent, TDependent.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate(JulianDate)
Calls EvaluatePartialsOfChildren(JulianDate) to calculate the partials derivatives of DependentVariable with respect to all variables in IndependentVariables except for DependentVariable, and then adds on the terms for the partial derivatives of DependentVariable with respect to itself, if necessary.
(Overrides MotionEvaluatorTEvaluate(JulianDate).)
Public methodEvaluate(JulianDate, Int32)
PartialDerivativeEvaluators only calculate zeroth order values, this method returns a MotionT of order zero regardless of the requested order.
(Overrides MotionEvaluatorTEvaluate(JulianDate, Int32).)
Public methodEvaluate(TimeInterval, Duration, Int32)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from MotionEvaluatorT.)
Public methodEvaluate(JulianDate, JulianDate, Duration, Int32)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from MotionEvaluatorT.)
Public methodEvaluate(TimeInterval, Duration, Int32, ITrackCalculationProgress)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from MotionEvaluatorT.)
Public methodEvaluate(JulianDate, JulianDate, Duration, Int32, ITrackCalculationProgress)
Evaluates this evaluator at a specified fixed step over the specified interval.
(Inherited from MotionEvaluatorT.)
Protected methodEvaluateMotionWithoutOrder
Evaluates the function using a default order.
(Inherited from MotionEvaluatorT.)
Public methodEvaluatePartialsOfChildren
Evaluates the partials derivatives of DependentVariable with respect to all variables in IndependentVariables except for DependentVariable, as that is taken care of by Evaluate(JulianDate).
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAvailabilityIntervals
Gets the intervals over which data is available. If the availability interval is infinite, this returns Infinite.
(Inherited from MotionEvaluatorT.)
Public methodGetCachingWrapper
Gets a version of this evaluator that caches the previously computed value so that if it is evaluated twice at the same date the computation is done only once.
(Overrides DynamicMatrixEvaluatorGetCachingWrapper.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextSampleSuggestion
Gets a suggestion for the next independent variable value at which to sample this function.
(Inherited from FunctionTIndependent, TDependent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsAvailable
Returns if valid data is available for this Julian date, otherwise returns .
(Inherited from MotionEvaluatorT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateEvaluatorReferences
Updates the evaluator references held by this object using the reference-to-reference mapping in the specified CopyContext.
(Inherited from MotionEvaluatorT.)
Top
See Also