fr.cnes.sirius.patrius.math.parameter

Class PiecewiseFunction

java.lang.Object

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

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

fr.cnes.sirius.patrius.math.parameter.PiecewiseFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class PiecewiseFunction
extends ParamDiffFunction

This class is used to define parameterizable piecewize function. It is defined by a list of IParamDiffFunction, each sub function applying to a certain interval defined by the first date of the interval.

Since:

2.3

Version:

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

Author:

auguief

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Constructor Summary

Constructors

Constructor and Description
PiecewiseFunction(ArrayList<IParamDiffFunction> flist, ArrayList<AbsoluteDate> xlist) Simple constructor with 2 lists (IParamDiffFunction and AbsoluteDate) where dates list represent the connection points between functions.

Method Summary

Methods

Modifier and Type	Method and Description
double	derivativeValue(Parameter p, SpacecraftState s) 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

Constructor Detail

PiecewiseFunction

public PiecewiseFunction(ArrayList<IParamDiffFunction> flist,
                 ArrayList<AbsoluteDate> xlist)
                  throws PatriusException

Simple constructor with 2 lists (IParamDiffFunction and AbsoluteDate) where dates list represent the connection points between functions. So dates list size must equals to functions list size - 1 else exception is thrown

Parameters:

flist - list of IParamDiffFunction

xlist - list of AbsoluteDate ordered chronologically

Throws:

PatriusException - if xlist.size() != flist.size() - 1 or xlist is not ordered chronologically

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 s)

Compute the derivative value with respect to the input parameter.

Parameters:

p - parameter

s - 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