fr.cnes.sirius.patrius.propagation.analytical.twod

Class DatePolynomialFunction

java.lang.Object

fr.cnes.sirius.patrius.propagation.analytical.twod.DatePolynomialFunction

All Implemented Interfaces:

UnivariateDateFunction

public class DatePolynomialFunction
extends Object
implements UnivariateDateFunction

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

Concurrency :

thread-safe

Constructor Summary

Constructors

Constructor and Description
DatePolynomialFunction(AbsoluteDate origin, double[] polynomialCoefs) Constructor.
DatePolynomialFunction(DatePolynomialFunction function) Clone constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getCoefPoly() Returns a copy of polynomial development coefficients.
int	getPolyOrder() Returns polynomial order.
AbsoluteDate	getT0() Returns the model origin date.
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

Constructor Detail

DatePolynomialFunction

public DatePolynomialFunction(AbsoluteDate origin,
                      double[] polynomialCoefs)

Constructor.

Parameters:

origin - origin date for the polynomial development

polynomialCoefs - polynomial development coefficients

DatePolynomialFunction

public DatePolynomialFunction(DatePolynomialFunction function)

Clone constructor.

Parameters:

function - function to copy

Method Detail

getT0

public AbsoluteDate getT0()

Returns the model origin date.

Returns:

the model origin date

getCoefPoly

public double[] getCoefPoly()

Returns a copy of polynomial development coefficients.

Returns:

the polynomial development coefficients

getPolyOrder

public int getPolyOrder()

Returns polynomial order.

Returns:

polynomial order

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