fr.cnes.sirius.patrius.math.parameter

Class PiecewiseFunction

java.lang.Object

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

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

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

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class PiecewiseFunction
extends IntervalsFunction

This class is used to define parameterizable piecewize function.

It is defined by a collection of functions, each sub function applying to a certain interval defined by the first date of the interval.

First interval from PAST_INFINITY to the first date.
Last interval from the last date to FUTURE_INFINITY.
The interval structure is defined as [k, k+1[ (first bracket closed, second opened).

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

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(Collection<IParamDiffFunction> functionsCollection, Collection<AbsoluteDate> datesCollection) Simple constructor with a collection of functions and a collection of dates where the dates represents the connection points between functions, with an interval form [closed; opened[.

Method Summary

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

derivativeValue, getEntry, getEntry, getFunctions, getIntervalFunctionAssociation, getIntervals, isDifferentiableBy, toString, value

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

PiecewiseFunction

public PiecewiseFunction(Collection<IParamDiffFunction> functionsCollection,
                         Collection<AbsoluteDate> datesCollection)
                  throws PatriusException

Simple constructor with a collection of functions and a collection of dates where the dates represents the connection points between functions, with an interval form [closed; opened[.

So, the collection of dates size must be equal to the collection of functions size - 1, else an exception is thrown.

The function is defined between AbsoluteDate.PAST_INFINITY and AbsoluteDate.FUTURE_INFINITY, such as the N intervals [PAST_INFINITY; date1[, [date1, date2[, [...[, [dateN, FUTURE_INFINITY[ are defined from the N-1 dates for the N piecewise functions.

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

Parameters:

functionsCollection - Collection of functions

datesCollection - Collection of dates, chronologically ordered

Throws:

PatriusException - if the collection of dates contains AbsoluteDate.PAST_INFINITY or AbsoluteDate.FUTURE_INFINITY
if the collection of dates isn't chronologically ordered
if the collection of dates contains the same date twice

DimensionMismatchException - if datesCollection.size() != functionsCollection.size() - 1