org.orekit.utils

Class Differentiation

java.lang.Object

org.orekit.utils.Differentiation

public class Differentiation
extends Object

Utility class for differentiating various kinds of functions.

Since:

8.0

Author:

Luc Maisonobe

Method Summary

Modifier and Type	Method and Description
static ParameterFunction	differentiate(ParameterFunction function, int nbPoints, double step) Differentiate a scalar function using finite differences.
static StateJacobian	differentiate(StateFunction function, int dimension, AttitudeProvider provider, OrbitType orbitType, PositionAngle positionAngle, double dP, int nbPoints) Differentiate a vector function using finite differences.

Methods inherited from class java.lang.Object

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

Method Detail

differentiate

public static ParameterFunction differentiate(ParameterFunction function,
                                              int nbPoints,
                                              double step)

Differentiate a scalar function using finite differences.

Parameters:

function - function to differentiate

nbPoints - number of points used for finite differences

step - step for finite differences, in physical units

Returns:

scalar function evaluating to the derivative of the original function

Since:

9.3

differentiate

public static StateJacobian differentiate(StateFunction function,
                                          int dimension,
                                          AttitudeProvider provider,
                                          OrbitType orbitType,
                                          PositionAngle positionAngle,
                                          double dP,
                                          int nbPoints)

Differentiate a vector function using finite differences.

Parameters:

function - function to differentiate

provider - attitude provider to use for modified states

dimension - dimension of the vector value of the function

orbitType - type used to map the orbit to a one dimensional array

positionAngle - type of the position angle used for orbit mapping to array

dP - user specified position error, used for step size computation for finite differences

nbPoints - number of points used for finite differences

Returns:

matrix function evaluating to the Jacobian of the original function