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(Collection<IParamDiffFunction> functionsCollection, Collection<AbsoluteDateInterval> intervalsCollection) Simple constructor with a collection of functions and a collection of intervals.
IntervalsFunction(Collection<IParamDiffFunction> functionsCollection, Collection<AbsoluteDateInterval> intervalsCollection, boolean updateParamDescriptors) Simple constructor with a collection of functions and a collection of intervals.
IntervalsFunction(Map<AbsoluteDateInterval,IParamDiffFunction> mapOfFunctions) Simple constructor to initialize directly the map of intervals and functions.
IntervalsFunction(Map<AbsoluteDateInterval,IParamDiffFunction> mapOfFunctions, boolean updateParamDescriptors) 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.
CacheEntry<AbsoluteDateInterval,IParamDiffFunction>	getEntry(AbsoluteDate date) Getter for the entry <interval, function> associated to the provided date.
CacheEntry<AbsoluteDateInterval,IParamDiffFunction>	getEntry(AbsoluteDate date, boolean throwException) Getter for the entry <interval, function> associated to the provided date.
List<IParamDiffFunction>	getFunctions() Getter for the functions associated to the intervals.
Map<AbsoluteDateInterval,IParamDiffFunction>	getIntervalFunctionAssociation() Getter for the association between intervals and functions.
AbsoluteDateIntervalsList	getIntervals() Getter for the available intervals.
boolean	isDifferentiableBy(Parameter p) Tell if the function is differentiable by the given parameter.
String	toString() Getter for a String representation of this function.
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, wait, wait, wait

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

getParameters, supportsParameter

Constructor Detail

IntervalsFunction

public IntervalsFunction(Collection<IParamDiffFunction> functionsCollection,
                         Collection<AbsoluteDateInterval> intervalsCollection)

Simple constructor with a collection of functions and a collection of intervals. Both collections 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 updated with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Parameters:

functionsCollection - Collection of functions

intervalsCollection - Collection of intervals

Throws:

DimensionMismatchException - if intervalsCollection.size() != functionsCollection.size()

IllegalArgumentException - if some intervals from the specified collection overlap with each other
if one of the functions of the functions collection is null

IntervalsFunction

public IntervalsFunction(Collection<IParamDiffFunction> functionsCollection,
                         Collection<AbsoluteDateInterval> intervalsCollection,
                         boolean updateParamDescriptors)

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

Parameters:

functionsCollection - Collection of functions

intervalsCollection - Collection of intervals

updateParamDescriptors - Indicate if parameters descriptor should be updated with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Throws:

DimensionMismatchException - if intervalsCollection.size() != functionsCollection.size()

IllegalArgumentException - if some intervals from the specified collection overlap with each other
if one of the functions of the functions collection is null

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 from the specified map overlap with each other
if one of the objects of the map is null

NullArgumentException - if mapOfFunctions is null

IntervalsFunction

public IntervalsFunction(Map<AbsoluteDateInterval,IParamDiffFunction> mapOfFunctions,
                         boolean updateParamDescriptors)

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

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.

updateParamDescriptors - Indicate if parameters descriptor should be updated with a StandardFieldDescriptors.DATE_INTERVAL corresponding to the interval where the parameter is defined.

Throws:

IllegalArgumentException - if some intervals from the specified map overlap with each other
if one of the objects of the map is null

NullArgumentException - if mapOfFunctions is null

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 provided date does not belong to any of 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 provided date does not belong to any of 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.

getIntervals

public AbsoluteDateIntervalsList getIntervals()

Getter for the available intervals.

Returns:

the available intervals

getFunctions

public List<IParamDiffFunction> getFunctions()

Getter for the functions associated to the intervals.

Returns:

the functions

getIntervalFunctionAssociation

public Map<AbsoluteDateInterval,IParamDiffFunction> getIntervalFunctionAssociation()

Getter for the association between intervals and functions.

Returns:

the interval/functions association

getEntry

public CacheEntry<AbsoluteDateInterval,IParamDiffFunction> getEntry(AbsoluteDate date)

Getter for the entry <interval, function> associated to the provided date.
An exception is raised if there is no match

Parameters:

date - date for which we want the corresponding association interval/function

Returns:

the association corresponding to the interval in which the given date is included

Throws:

IllegalStateException - if the provided date does not belong to any of the intervals

getEntry

public CacheEntry<AbsoluteDateInterval,IParamDiffFunction> getEntry(AbsoluteDate date,
                                                                    boolean throwException)

Getter for the entry <interval, function> associated to the provided date.

Parameters:

date - date for which we want the corresponding association interval/function

throwException - if true an exception is raised if there is no match; if false a null is returned if there is no match

Returns:

the association corresponding to the interval in which the given date is included

Throws:

IllegalStateException - if throwException == true and the provided date does not belong to any of the intervals

toString

public String toString()

Getter for a String representation of this function.

Overrides:

toString in class Object

Returns:

a String representation of this function