Top Description Fields Constructors Methods
org.apache.commons.math3.ode

pack-priv Class ParameterConfiguration

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable

Simple container pairing a parameter name with a step in order to compute the associated Jacobian matrix by finite difference.
Since
3.0

Field Summary

Modifier and TypeField and Description
private double
hP

Parameter step for finite difference computation.

private String
parameterName

Parameter name.

private static final long
serialVersionUID

Serializable UID.

Constructor Summary

AccessConstructor and Description
pack-priv
ParameterConfiguration(final String
parameter name
parameterName
,
final double
parameter step
hP
)

Parameter name and step pair constructor.

Method Summary

Modifier and TypeMethod and Description
public double

Returns:

hP parameter step
getHP
()

Get parameter step.

public String

Returns:

parameterName parameter name
getParameterName
()

Get parameter name.

public void
setHP(final double
parameter step
hParam
)

Set parameter step.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

hPback to summary
private double hP

Parameter step for finite difference computation.

parameterNameback to summary
private String parameterName

Parameter name.

serialVersionUIDback to summary
private static final long serialVersionUID

Serializable UID.

Constructor Detail

ParameterConfigurationback to summary
pack-priv ParameterConfiguration(final String parameterName, final double hP)

Parameter name and step pair constructor.

Parameters
parameterName:String

parameter name

hP:double

parameter step

Method Detail

getHPback to summary
public double getHP()

Get parameter step.

Returns:double

hP parameter step

getParameterNameback to summary
public String getParameterName()

Get parameter name.

Returns:String

parameterName parameter name

setHPback to summary
public void setHP(final double hParam)

Set parameter step.

Parameters
hParam:double

parameter step