org.apache.commons.math3.ode

Interface ParameterJacobianProvider

All Superinterfaces:

Parameterizable

public interface ParameterJacobianProvider
extends Parameterizable

Interface to compute exactly Jacobian matrix for some parameter when computing partial derivatives equations.

Since:

3.0

Version:

$Id: ParameterJacobianProvider.java 1244107 2012-02-14 16:17:55Z erans $

Method Summary

Methods

Modifier and Type	Method and Description
void	computeParameterJacobian(double t, double[] y, double[] yDot, String paramName, double[] dFdP) Compute the Jacobian matrix of ODE with respect to one parameter.

Methods inherited from interface org.apache.commons.math3.ode.Parameterizable

getParametersNames, isSupported

Method Detail

computeParameterJacobian

void computeParameterJacobian(double t,
                            double[] y,
                            double[] yDot,
                            String paramName,
                            double[] dFdP)
                              throws MathIllegalArgumentException

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

The parameter must be one given by Parameterizable.getParametersNames().

Parameters:

t - current value of the independent time variable

y - array containing the current value of the main state vector

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

paramName - name of the parameter to consider

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

Throws:

MathIllegalArgumentException - if the parameter is not supported