fr.cnes.sirius.patrius.math.parameter

Class ConstantFunction

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.math.parameter.ParamDiffFunction

fr.cnes.sirius.patrius.math.parameter.ConstantFunction

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class ConstantFunction
extends ParamDiffFunction

This class is used to define a constant parameterizable function.

Since:

2.3

Version:

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

Author:

auguief

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Constructor Summary

Constructors

Constructor and Description
ConstantFunction(double value) Simple constructor with a given name and value.
ConstantFunction(Parameter param) Simple constructor with a given Parameter.
ConstantFunction(String name, double value) Simple constructor with a given name and value.

Method Summary

Modifier and Type	Method and Description
double	derivativeValue(Parameter p, SpacecraftState state) Compute the derivative value with respect to the input parameter.
ArrayList<Parameter>	getParameters() Get the supported parameters.
double	value() Value of the parameter.
double	value(SpacecraftState s) Getting the value of the function.

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

isDifferentiableBy, supportsParameter

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

addParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantFunction

public ConstantFunction(Parameter param)

Simple constructor with a given Parameter.

Parameters:

param - a parameter

ConstantFunction

public ConstantFunction(String name,
                        double value)

Simple constructor with a given name and value.

Parameters:

name - a parameter name

value - a parameter value

ConstantFunction

public ConstantFunction(double value)

Simple constructor with a given name and value.

Parameters:

value - a parameter value

Method Detail

value

public double value(SpacecraftState s)

Getting the value of the function.

Parameters:

s - the spacecraft state

Returns:

the value of the function.

value

public double value()

Value of the parameter.

Returns:

the value of the parameter parameter as double

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState state)

Compute the derivative value with respect to the input parameter.

Parameters:

p - parameter

state - current state

Returns:

the derivative value

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class Parameterizable

Returns:

list of supported parameters