fr.cnes.sirius.patrius.math.analysis.polynomials

Class DatePolynomialFunction

java.lang.Object

fr.cnes.sirius.patrius.math.analysis.polynomials.DatePolynomialFunction

All Implemented Interfaces:

DatePolynomialFunctionInterface, UnivariateDateFunction, Serializable

public class DatePolynomialFunction
extends Object
implements DatePolynomialFunctionInterface

This class represents a polynomial function of date.

Since:

3.0

Version:

$Id: DatePolynomialFunction.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

thread-safe

Constructor Summary

Constructors

Constructor and Description
DatePolynomialFunction(AbsoluteDate origin, Double timeFactorIn, PolynomialFunction polyFunction) Main constructor.
DatePolynomialFunction(AbsoluteDate origin, PolynomialFunction polyFunction) Constructor using real time (unreduced time).

Method Summary

Modifier and Type	Method and Description
DatePolynomialFunction	copy(AbsoluteDate newOriginDate) Build a new date polynomial function whose value over time is the same as this (same degree), only the origin date is different what may modify the time factor and/or the polynomial coefficients (pending the polynomial type).
DatePolynomialFunction	derivative() Getter for the derivative date polynomial function.
double[]	getCoefficients() Getter for the polynomial coefficients.
int	getDegree() Getter for the polynomial degree.
PolynomialType	getPolynomialType() Getter for the type of this polynomial function.
AbsoluteDate	getT0() Returns the model origin date.
Double	getTimeFactor() Getter for the time factor.
DatePolynomialFunction	primitive(AbsoluteDate date0, double value0) Getter for the primitive date polynomial function at the given date and for the given function value at abscissa0.
double	value(AbsoluteDate date) Returns value of function at provided date.

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.analysis.polynomials.DatePolynomialFunctionInterface

dateToDouble, doubleToDate

Constructor Detail

DatePolynomialFunction

public DatePolynomialFunction(AbsoluteDate origin,
                              PolynomialFunction polyFunction)

Constructor using real time (unreduced time).

Parameters:

origin - the origin date for the polynomial development

polyFunction - the polynomial function

DatePolynomialFunction

public DatePolynomialFunction(AbsoluteDate origin,
                              Double timeFactorIn,
                              PolynomialFunction polyFunction)

Main constructor.

Parameters:

origin - the origin date for the polynomial development

timeFactorIn - the time Factor used to transform a time as double into an absoluteDate and vice-versa:

• The absolute date corresponding to a given time as double is equal to the origin date shifted by the time multiplied by this time factor.
• The time as double corresponding to a given absolute date is equal to the duration between originDate and the date, divided by this time factor.

If null, a unit time factor (value 1.0) is used.

polyFunction - the polynomial function

Method Detail

getT0

public AbsoluteDate getT0()

Returns the model origin date.

Specified by:

getT0 in interface DatePolynomialFunctionInterface

Returns:

the model origin date

value

public double value(AbsoluteDate date)

Returns value of function at provided date.

Specified by:

value in interface UnivariateDateFunction

Parameters:

date - a date

Returns:

value of function at provided date

derivative

public DatePolynomialFunction derivative()

Getter for the derivative date polynomial function.

Specified by:

derivative in interface DatePolynomialFunctionInterface

Returns:

the derivative date polynomial function

getDegree

public int getDegree()

Getter for the polynomial degree.

Specified by:

getDegree in interface DatePolynomialFunctionInterface

Returns:

the polynomial degree

getCoefficients

public double[] getCoefficients()

Getter for the polynomial coefficients.

Specified by:

getCoefficients in interface DatePolynomialFunctionInterface

Returns:

the polynomial coefficients

getTimeFactor

public Double getTimeFactor()

Getter for the time factor.

Specified by:

getTimeFactor in interface DatePolynomialFunctionInterface

Returns:

the time factor (a null value corresponds to a unit time factor)

primitive

public DatePolynomialFunction primitive(AbsoluteDate date0,
                                        double value0)

Getter for the primitive date polynomial function at the given date and for the given function value at abscissa0.

Specified by:

primitive in interface DatePolynomialFunctionInterface

Parameters:

date0 - the date of interest

value0 - the function value at abscissa0

Returns:

the primitive date polynomial function at the given date and for the given function value at abscissa0

copy

public DatePolynomialFunction copy(AbsoluteDate newOriginDate)

Build a new date polynomial function whose value over time is the same as this (same degree), only the origin date is different what may modify the time factor and/or the polynomial coefficients (pending the polynomial type).

Specified by:

copy in interface DatePolynomialFunctionInterface

Parameters:

newOriginDate - The new origin date

Returns:

a new date polynomial function

Throws:

IllegalArgumentException - if the time factor is enabled and the new origin date is not strictly anterior to the current origin date shifted by the timeFactor

getPolynomialType

public PolynomialType getPolynomialType()

Getter for the type of this polynomial function.

Specified by:

getPolynomialType in interface DatePolynomialFunctionInterface

Returns:

the type of this polynomial function