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 list of IParamDiffFunction, each sub function applying to a certain interval defined by the first date of the interval.

First interval from –infinity to the first date. Last interval from the last date to + infinity. The interval structure is defined as [k, k+1[ (first bracket close, second open)

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(List<IParamDiffFunction> flist, List<AbsoluteDate> xlist) Simple constructor with 2 lists (IParamDiffFunction and AbsoluteDate) where the dates list 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, isDifferentiableBy, 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, toString, wait, wait, wait

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

getParameters, supportsParameter

Constructor Detail

PiecewiseFunction

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

Simple constructor with 2 lists (IParamDiffFunction and AbsoluteDate) where the dates list represents the connection points between functions, with an interval form [closed; opened[.

So dates list size must equals to functions list size - 1 else 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:

flist - list of functions

xlist - list of dates ordered chronologically

Throws:

PatriusException - if the dates list contains AbsoluteDate.PAST_INFINITY or AbsoluteDate.FUTURE_INFINITY
if the dates aren't ordered chronologically in the list
if the list contains the same date twice

DimensionMismatchException - if xlist.size() != flist.size() - 1