fr.cnes.sirius.patrius.math.parameter

Class IntervalsFunction

java.lang.Object

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

fr.cnes.sirius.patrius.math.parameter.IntervalsFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

Direct Known Subclasses:

PiecewiseFunction

public class IntervalsFunction
extends Parameterizable
implements IParamDiffFunction

This class is used to define parameterizable interval functions. It is defined by a map of AbsoluteDateInterval and IParamDiffFunction.

Note that this function is not defined on dates outside of its intervals.

Each function parameters descriptor is enriched with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Author:

bonitt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IntervalsFunction(List<IParamDiffFunction> functionsList, List<AbsoluteDateInterval> intervalsList) Simple constructor with a list of functions and a list of intervals.
IntervalsFunction(Map<AbsoluteDateInterval,IParamDiffFunction> mapOfFunctions) Simple constructor to initialize directly the map of intervals and functions.

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.
double	value(SpacecraftState s) Getting the value of the function.

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

addAllParameters, addAllParameters, addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

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

getParameters, supportsParameter

Constructor Detail

IntervalsFunction

public IntervalsFunction(List<IParamDiffFunction> functionsList,
                         List<AbsoluteDateInterval> intervalsList)

Simple constructor with a list of functions and a list of intervals. Both lists should be the same size. They define each sub-function to apply on each interval. The intervals must not overlap with each other.

Each function parameters descriptor is enriched with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Parameters:

functionsList - List of functions

intervalsList - List of intervals

Throws:

DimensionMismatchException - if functionsList.size() != intervalsList.size()

IllegalArgumentException - if some intervals from the specified list overlap with each other

IntervalsFunction

public IntervalsFunction(Map<AbsoluteDateInterval,IParamDiffFunction> mapOfFunctions)

Simple constructor to initialize directly the map of intervals and functions.

Each function parameters descriptor is enriched with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Note: the given map is stored with a shallow copy.

Parameters:

mapOfFunctions - Map of intervals and functions. Note that the map is not duplicated internally.

Throws:

IllegalArgumentException - if some intervals overlap with each other

Method Detail

value

public double value(SpacecraftState s)

Getting the value of the function.

Specified by:

value in interface IParameterizableFunction

Parameters:

s - the spacecraft state

Returns:

the value of the function.

Throws:

IllegalStateException - if the given date isn't contained by the intervals

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState s)

Compute the derivative value with respect to the input parameter.

Specified by:

derivativeValue in interface IParamDiffFunction

Parameters:

p - parameter

s - current state

Returns:

the derivative value

Throws:

IllegalStateException - if the given date isn't contained by the intervals

isDifferentiableBy

public boolean isDifferentiableBy(Parameter p)

Tell if the function is differentiable by the given parameter.

Specified by:

isDifferentiableBy in interface IParamDiffFunction

Parameters:

p - function parameter

Returns:

true if the function is differentiable by the given parameter.