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

Interface DatePolynomialFunctionInterface

All Superinterfaces:

Serializable, UnivariateDateFunction

All Known Implementing Classes:

DatePolynomialChebyshevFunction, DatePolynomialFunction

public interface DatePolynomialFunctionInterface
extends UnivariateDateFunction

Represents an interface for polynomial functions of date.

Since:

4.11

Version:

$Id$

Author:

Alice Latourte

Method Summary

Modifier and Type	Method and Description
DatePolynomialFunctionInterface	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).
default double	dateToDouble(AbsoluteDate date) Getter for the time as double corresponding to the given AbsoluteDate.
DatePolynomialFunctionInterface	derivative() Getter for the derivative date polynomial function.
default AbsoluteDate	doubleToDate(double time) Getter for the AbsoluteDate corresponding to the given time as double.
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() Getter for the origin date.
Double	getTimeFactor() Getter for the time factor.
DatePolynomialFunctionInterface	primitive(AbsoluteDate date0, double ordinate0) Getter for the primitive date polynomial function at the given date and for the given function value at abscissa0.

Methods inherited from interface fr.cnes.sirius.patrius.math.analysis.polynomials.UnivariateDateFunction

value

Method Detail

getT0

AbsoluteDate getT0()

Getter for the origin date.

Returns:

the origin date

dateToDouble

default double dateToDouble(AbsoluteDate date)

Getter for the time as double corresponding to the given AbsoluteDate.

Parameters:

date - the given AbsoluteDate

Returns:

the corresponding time as double

doubleToDate

default AbsoluteDate doubleToDate(double time)

Getter for the AbsoluteDate corresponding to the given time as double.

Parameters:

time - the given time as double with respect to time origin

Returns:

the corresponding AbsoluteDate

getTimeFactor

Double getTimeFactor()

Getter for the time factor.

Returns:

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

getDegree

int getDegree()

Getter for the polynomial degree.

Returns:

the polynomial degree

getCoefficients

double[] getCoefficients()

Getter for the polynomial coefficients.

Returns:

the polynomial coefficients

derivative

DatePolynomialFunctionInterface derivative()

Getter for the derivative date polynomial function.

Returns:

the derivative date polynomial function

primitive

DatePolynomialFunctionInterface primitive(AbsoluteDate date0,
                                          double ordinate0)

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

Parameters:

date0 - the date of interest

ordinate0 - the function value at abscissa0

Returns:

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

copy

DatePolynomialFunctionInterface 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).

Parameters:

newOriginDate - The new origin date

Returns:

a new date polynomial function

getPolynomialType

PolynomialType getPolynomialType()

Getter for the type of this polynomial function.

Returns:

the type of this polynomial function