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

Class DatePolynomialChebyshevFunction

java.lang.Object

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

All Implemented Interfaces:

DatePolynomialFunctionInterface, UnivariateDateFunction, Serializable

public class DatePolynomialChebyshevFunction
extends Object
implements DatePolynomialFunctionInterface

This class represents a Chebyshev polynomial function of date.

The real time (unreduced time) is used.

Since:

4.10

Author:

Alice Latourte

See Also:

Serialized Form

Concurrency :

thread-safe

Constructor Summary

Constructors

Constructor and Description
DatePolynomialChebyshevFunction(AbsoluteDate originDate, AbsoluteDate tStart, AbsoluteDate tEnd, double[] polynomialCoefs) Constructor.
DatePolynomialChebyshevFunction(AbsoluteDate originDate, PolynomialChebyshevFunction polyFunction) Constructor.

Method Summary

Modifier and Type	Method and Description
DatePolynomialChebyshevFunction	copy() Copies this function and returns a new one identical to this.
DatePolynomialChebyshevFunction	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).
double	dateToDouble(AbsoluteDate date) Getter for the time as double corresponding to the given AbsoluteDate.
DatePolynomialChebyshevFunction	derivative() Getter for the derivative date polynomial function.
AbsoluteDate	doubleToDate(double time) Getter for the AbsoluteDate corresponding to the given time as double.
AbsoluteDate[]	getChebyshevAbscissas(int n) Compute the N Chebyshev abscissas on the range [start ; end] in a chronological (increasing) order.
double[]	getCoefficients() Getter for the polynomial coefficients.
int	getDegree() Getter for the polynomial degree.
AbsoluteDate	getEnd() Getter for the Chebyshev polynomial range end date.
double	getEndAsDouble() Getter for the end range of the underlying polynomial Chebyshev function.
int	getOrder() Getter for polynomial order.
PolynomialType	getPolynomialType() Getter for the type of this polynomial function.
AbsoluteDateInterval	getRange() Getter for the Chebyshev polynomial range.
AbsoluteDate	getStart() Getter for the Chebyshev polynomial range start date.
double	getStartAsDouble() Getter for the start range of the underlying polynomial Chebyshev function.
AbsoluteDate	getT0() Getter for the Chebyshev polynomial origin date.
Double	getTimeFactor() Getter for the time factor.
DatePolynomialChebyshevFunction	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

Constructor Detail

DatePolynomialChebyshevFunction

public DatePolynomialChebyshevFunction(AbsoluteDate originDate,
                                       AbsoluteDate tStart,
                                       AbsoluteDate tEnd,
                                       double[] polynomialCoefs)

Constructor.

Parameters:

originDate - the polynomial origin date

tStart - the Chebyshev polynomial range start date

tEnd - the Chebyshev polynomial range end date

polynomialCoefs - the polynomial development coefficients

DatePolynomialChebyshevFunction

public DatePolynomialChebyshevFunction(AbsoluteDate originDate,
                                       PolynomialChebyshevFunction polyFunction)

Constructor.

Parameters:

originDate - the polynomial origin date

polyFunction - the polynomial function

Method Detail

copy

public DatePolynomialChebyshevFunction copy()

Copies this function and returns a new one identical to this.

Returns:

new DatePolynomialChebyshevFunction identical to this

getT0

public AbsoluteDate getT0()

Getter for the Chebyshev polynomial origin date.

Specified by:

getT0 in interface DatePolynomialFunctionInterface

Returns:

the Chebyshev polynomial origin date

getStart

public AbsoluteDate getStart()

Getter for the Chebyshev polynomial range start date.

Returns:

the Chebyshev polynomial range start date

getEnd

public AbsoluteDate getEnd()

Getter for the Chebyshev polynomial range end date.

Returns:

the Chebyshev polynomial range end date

getRange

public AbsoluteDateInterval getRange()

Getter for the Chebyshev polynomial range.

Returns:

the Chebyshev polynomial range

getOrder

public int getOrder()

Getter for polynomial order.

Returns:

the polynomial order

getChebyshevAbscissas

public AbsoluteDate[] getChebyshevAbscissas(int n)

Compute the N Chebyshev abscissas on the range [start ; end] in a chronological (increasing) order.

Parameters:

n - Number of points to evaluate

Returns:

the N Chebyshev abscissas

Throws:

NotStrictlyPositiveException - if n <= 0

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

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

derivative

public DatePolynomialChebyshevFunction derivative()

Getter for the derivative date polynomial function.

Specified by:

derivative in interface DatePolynomialFunctionInterface

Returns:

the derivative date polynomial function

primitive

public DatePolynomialChebyshevFunction 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

dateToDouble

public final double dateToDouble(AbsoluteDate date)

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

Specified by:

dateToDouble in interface DatePolynomialFunctionInterface

Parameters:

date - the given AbsoluteDate

Returns:

the corresponding time as double

doubleToDate

public final AbsoluteDate doubleToDate(double time)

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

Specified by:

doubleToDate in interface DatePolynomialFunctionInterface

Parameters:

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

Returns:

the corresponding AbsoluteDate

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)

copy

public DatePolynomialChebyshevFunction 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

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

getStartAsDouble

public double getStartAsDouble()

Getter for the start range of the underlying polynomial Chebyshev function.

Returns:

the start range of the underlying polynomial Chebyshev function

getEndAsDouble

public double getEndAsDouble()

Getter for the end range of the underlying polynomial Chebyshev function.

Returns:

the end range of the underlying polynomial Chebyshev function