fr.cnes.sirius.patrius.math.parameter

Class LinearFunction

java.lang.Object

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

fr.cnes.sirius.patrius.math.parameter.LinearFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class LinearFunction
extends LinearCombinationFunction

This class is used to define parameterizable linear function: f = a0 + a1 * (t - t0).

This function is serializable.

Since:

2.3

Version:

$Id: LinearFunction.java 18069 2017-10-02 16:45:28Z bignon $

Author:

auguief, bonitt, veuillezh

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Field Summary

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

functions, PARAMETER_PREFIX_NAME

Constructor Summary

Constructors

Constructor and Description
LinearFunction(AbsoluteDate t0, double a0, double a1) Constructor of a linear function f = a0 + a1 * (t - t0) using the input a1 (slope) and a0 (zero value) values and the initial date.
LinearFunction(AbsoluteDate t0, Parameter a0, Parameter a1) Constructor of a linear function: f = a0 + a1 * (t - t0) using the input a1 (slope) and a0 (zeroValue) parameters and initial date.

Method Summary

Modifier and Type	Method and Description
ArrayList<Parameter>	getParameters() Return the function parameters in this following order: [a0, a1].
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

LinearFunction

public LinearFunction(AbsoluteDate t0,
                      double a0,
                      double a1)

Constructor of a linear function f = a0 + a1 * (t - t0) using the input a1 (slope) and a0 (zero value) values and the initial date.

Note: the parameters are stored in the following order: [a0, a1].

Parameters:

t0 - initial date

a0 - the a0 parameter value (function's value when t=0)

a1 - the a1 parameter value (slope)

Throws:

NullArgumentException - if t0 is null

LinearFunction

public LinearFunction(AbsoluteDate t0,
                      Parameter a0,
                      Parameter a1)

Constructor of a linear function: f = a0 + a1 * (t - t0) using the input a1 (slope) and a0 (zeroValue) parameters and initial date.

Note: the parameters are stored in the following order: [a0, a1] (also called [zeroValue, slope]).

Parameters:

t0 - initial date

a0 - the a0 parameter (function's value when t=0)

a1 - the a1 parameter (slope)

Throws:

NullArgumentException - if t0, a0 or a1 is null

Method Detail

getParameters

public ArrayList<Parameter> getParameters()

Return the function parameters in this following order: [a0, a1].

The list is returned in a shallow copy.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class LinearCombinationFunction

Returns:

the function 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