fr.cnes.sirius.patrius.math.parameter

Interface IParamDiffFunction

All Superinterfaces:

IParameterizable, IParameterizableFunction, Serializable

All Known Subinterfaces:

AerodynamicCoefficient

All Known Implementing Classes:

AbstractAeroCoeff1D, AeroCoeffByAltitude, AeroCoeffByAoA, AeroCoeffByAoAAndMach, AeroCoeffByMach, AeroCoeffConstant, CnCookModel, ConstantFunction, CtCookModel, LinearFunction, ParamDiffFunction, PiecewiseFunction

public interface IParamDiffFunction
extends IParameterizableFunction

This class is used to define a derivative function parameterizable.

Since:

2.3

Version:

$Id: IParamDiffFunction.java 18069 2017-10-02 16:45:28Z bignon $

Author:

auguief

Concurrency :

not thread-safe, uses internal mutable attributes

Method Summary

Modifier and Type	Method and Description
double	derivativeValue(Parameter p, SpacecraftState s) Compute the derivative value with respect to the input parameter.
boolean	isDifferentiableBy(Parameter p) Tell if the function is differentiable by the given parameter.

Methods inherited from interface fr.cnes.sirius.patrius.math.parameter.IParameterizableFunction

value

Methods inherited from interface fr.cnes.sirius.patrius.math.parameter.IParameterizable

getParameters, supportsParameter

Method Detail

derivativeValue

double derivativeValue(Parameter p,
                       SpacecraftState s)

Compute the derivative value with respect to the input parameter.

Parameters:

p - parameter

s - current state

Returns:

the derivative value

isDifferentiableBy

boolean isDifferentiableBy(Parameter p)

Tell if the function is differentiable by the given parameter.

Parameters:

p - function parameter

Returns:

true if the function is differentiable by the given parameter.