fr.cnes.sirius.patrius.math.parameter

Class Parameter

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameter

All Implemented Interfaces:

Serializable

public class Parameter
extends Object
implements Serializable

This class is used to define parameters for finite differences and derivatives of analytic functions computing. It defines a parameter with is value and its associated name.

Since:

2.3

Version:

$Id: Parameter.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
Parameter(String name2set, double value2set) Constructor with name and value.

Method Summary

Modifier and Type	Method and Description
String	getName() Getting parameter name.
double	getValue() Getting parameter value.
void	setValue(double val) Setting parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String name2set,
                 double value2set)

Constructor with name and value.

Parameters:

name2set - name of the Parameter

value2set - value of the parameter

Since:

2.3

Method Detail

getValue

public double getValue()

Getting parameter value.

Returns:

the parameter value

setValue

public void setValue(double val)

Setting parameter value.

Parameters:

val - parameter value

getName

public String getName()

Getting parameter name.

Returns:

the parameter name