fr.cnes.sirius.patrius.math.parameter

Class NthOrderPolynomialFunction

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.LinearCombinationFunction

fr.cnes.sirius.patrius.math.parameter.NthOrderPolynomialFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class NthOrderPolynomialFunction
extends LinearCombinationFunction

This class is used to define parameterizable Nth order polynomial function: f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ....

This function is serializable.

Author:

veuillezh, bonitt

See Also:

Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.math.parameter.LinearCombinationFunction

functions, PARAMETER_PREFIX_NAME

Constructor Summary

Constructors

Constructor and Description
NthOrderPolynomialFunction(AbsoluteDate t0, double... values) Constructor of a linear polynomial function of order N, defined such as: f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ...
NthOrderPolynomialFunction(AbsoluteDate t0, int n) Constructor of a linear polynomial function of order N, defined such as: f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ...
NthOrderPolynomialFunction(AbsoluteDate t0, Parameter... params) Constructor of a linear polynomial function of order N, defined such as: f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ...

Method Summary

Modifier and Type	Method and Description
ArrayList<Parameter>	getParameters() Return the function N parameters in this following order : a0, a1, a2, ...
String	toString() Getter for a String representation of this function.

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.LinearCombinationFunction

derivativeValue, isDifferentiableBy, supportsParameter, value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NthOrderPolynomialFunction

public NthOrderPolynomialFunction(AbsoluteDate t0,
                                  int n)

Constructor of a linear polynomial function of order N, defined such as:
f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ... with all its coefficients/parameters initialized at 0.

Note: For instance, a linear polynomial function of order 3 (N = 3) will have 4 coefficients/parameters: a0, a1, a2, a3.

Parameters:

t0 - Initial date

n - Expected polynomial function order

NthOrderPolynomialFunction

public NthOrderPolynomialFunction(AbsoluteDate t0,
                                  double... values)

Constructor of a linear polynomial function of order N, defined such as:
f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ..., with the first specified value represents a0, the second represents a1, etc.

The linear polynomial function order depends of how many coefficients are given to the constructor (N coefficients = polynomial of order N).

Parameters:

t0 - Initial date

values - N order coefficients values

Throws:

NullArgumentException - if t0 is null

NthOrderPolynomialFunction

public NthOrderPolynomialFunction(AbsoluteDate t0,
                                  Parameter... params)

Constructor of a linear polynomial function of order N, defined such as:
f = a0 + a1 * (t - t0) + a2 * (t - t0)^2 + ..., with the first specified parameter represents a0, the second represents a1, etc.

The linear polynomial function order depends of how many parameters are given to the constructor (N parameters = polynomial of order N).

Parameters:

t0 - Initial date

params - N order coefficients parameters

Throws:

NullArgumentException - if t0 or any params is null

Method Detail

getParameters

public ArrayList<Parameter> getParameters()

Return the function N parameters in this following order : a0, a1, a2, ...

The list is returned in a shallow copy.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class LinearCombinationFunction

Returns:

the function N parameters list

toString

public String toString()

Getter for a String representation of this function.

Overrides:

toString in class Object

Returns:

a String representation of this function