fr.cnes.sirius.patrius.math.parameter

Class ConstantFunction

java.lang.Object

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

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

All Implemented Interfaces:

IParamDiffFunction, IParameterizable, IParameterizableFunction, Serializable

public class ConstantFunction
extends LinearCombinationFunction

This class is used to define a constant parameterizable function.

This function is serializable.

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

Field Summary

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

functions, PARAMETER_PREFIX_NAME

Constructor Summary

Constructors

Constructor and Description
ConstantFunction(double value) Constructor of a constant function f = a0 using the input value.
ConstantFunction(Parameter param) Constructor of a constant function f = a0 using the input parameter.
ConstantFunction(String name, double value) Constructor of a constant function f = a0 using the input value.

Method Summary

Modifier and Type	Method and Description
Parameter	getParameter() Getter for the parameter associated to this constant function.
ArrayList<Parameter>	getParameters() Return the function parameter [a0] stored in a list.
String	toString() Getter for a String representation of this function.
double	value() Value of the parameter.

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

ConstantFunction

public ConstantFunction(double value)

Constructor of a constant function f = a0 using the input value.

Parameters:

value - the a0 parameter value

ConstantFunction

public ConstantFunction(String name,
                        double value)

Constructor of a constant function f = a0 using the input value.

Parameters:

name - the a0 parameter name

value - the a0 parameter value

ConstantFunction

public ConstantFunction(Parameter param)

Constructor of a constant function f = a0 using the input parameter.

Parameters:

param - the a0 parameter

Throws:

NullArgumentException - if param is null

Method Detail

value

public double value()

Value of the parameter.

Returns:

the value of the parameter parameter as double

getParameter

public Parameter getParameter()

Getter for the parameter associated to this constant function.

Returns:

the parameter

getParameters

public ArrayList<Parameter> getParameters()

Return the function parameter [a0] stored in a list.

The list is returned in a shallow copy.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class LinearCombinationFunction

Returns:

the function parameter stored in a 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