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

public Interface ParameterJacobianProvider

extends Parameterizable
Known Direct Implementers
org.apache.commons.math3.ode.ParameterJacobianWrapper
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .MaxCountExceededException
Interface to compute exactly Jacobian matrix for some parameter when computing partial derivatives equations.
Since
3.0

Method Summary

Modifier and TypeMethod and Description
public void
computeParameterJacobian(double
current value of the independent time variable
t, double[]
array containing the current value of the main state vector
y, double[]
array containing the current value of the time derivative of the main state vector
yDot, String
name of the parameter to consider
paramName, double[]
placeholder array where to put the Jacobian matrix of the ODE with respect to the parameter
dFdP)

Compute the Jacobian matrix of ODE with respect to one parameter.

Inherited from org.apache.commons.math3.ode.Parameterizable:
getParametersNamesisSupported

Method Detail

computeParameterJacobianback to summary
public void computeParameterJacobian(double t, double[] y, double[] yDot, String paramName, double[] dFdP) throws DimensionMismatchException, MaxCountExceededException, UnknownParameterException

Compute the Jacobian matrix of ODE with respect to one parameter.

If the parameter does not belong to the collection returned by getParametersNames(), the Jacobian will be set to 0, but no errors will be triggered.

Parameters
t:double

current value of the independent time variable

y:double[]

array containing the current value of the main state vector

yDot:double[]

array containing the current value of the time derivative of the main state vector

paramName:String

name of the parameter to consider

dFdP:double[]

placeholder array where to put the Jacobian matrix of the ODE with respect to the parameter

Exceptions
DimensionMismatchException:
if arrays dimensions do not match equations settings
MaxCountExceededException:
if the number of functions evaluations is exceeded
UnknownParameterException:
if the parameter is not supported