fr.cnes.sirius.patrius.math.parameter

Class LinearFunction

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.math.parameter.ParamDiffFunction

fr.cnes.sirius.patrius.math.parameter.LinearFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class LinearFunction
extends ParamDiffFunction

This class is used to define parameterizable linear function a(t -t0) + b.

Since:

2.3

Version:

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

Author:

auguief

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Field Summary

Fields

Modifier and Type	Field and Description
static String	A Default function slope name.
static String	B Default ordinate origin name.

Constructor Summary

Constructors

Constructor and Description
LinearFunction(AbsoluteDate t0, double slope, double zeroValue) Simple constructor of a linear function a * (t - t0) + b using input constant a, b and initial date.
LinearFunction(AbsoluteDate t0, Parameter slope, Parameter zeroValue) Simple constructor of a linear function a * (t - t0) + b using input Parameter and initial date.

Method Summary

Modifier and Type	Method and Description
double	derivativeValue(Parameter p, SpacecraftState state) Compute the derivative value with respect to the input parameter.
ArrayList<Parameter>	getParameters() Get the supported parameters.
double	value(SpacecraftState s) Getting the value of the function.

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.ParamDiffFunction

isDifferentiableBy, supportsParameter

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.Parameterizable

addParameter

Methods inherited from class java.lang.Object

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

Field Detail

A

public static final String A

Default function slope name.

See Also:

Constant Field Values

B

public static final String B

Default ordinate origin name.

See Also:

Constant Field Values

Constructor Detail

LinearFunction

public LinearFunction(AbsoluteDate t0,
                      Parameter slope,
                      Parameter zeroValue)

Simple constructor of a linear function a * (t - t0) + b using input Parameter and initial date.

Parameters:

t0 - initial date

slope - Function's slope : a

zeroValue - Function's value when t=0 : b

LinearFunction

public LinearFunction(AbsoluteDate t0,
                      double slope,
                      double zeroValue)

Simple constructor of a linear function a * (t - t0) + b using input constant a, b and initial date.

Parameters:

t0 - initial date

slope - Function's slope : a

zeroValue - Function's value when t=0 : b

Method Detail

value

public double value(SpacecraftState s)

Getting the value of the function.

Parameters:

s - the spacecraft state

Returns:

the value of the function.

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState state)

Compute the derivative value with respect to the input parameter.

Parameters:

p - parameter

state - current state

Returns:

the derivative value

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class Parameterizable

Returns:

list of supported parameters