Interface ParameterJacobianProvider
-
- All Superinterfaces:
Parameterizable
public interface ParameterJacobianProvider extends Parameterizable
Interface to compute exactly Jacobian matrix for some parameter when computingpartial derivatives equations.- Since:
- 3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcomputeParameterJacobian(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.math4.legacy.ode.Parameterizable
getParametersNames, isSupported
-
-
-
-
Method Detail
-
computeParameterJacobian
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
Parameterizable.getParametersNames(), the Jacobian will be set to 0, but no errors will be triggered.- Parameters:
t- current value of the independent time variabley- array containing the current value of the main state vectoryDot- array containing the current value of the time derivative of the main state vectorparamName- name of the parameter to considerdFdP- placeholder array where to put the Jacobian matrix of the ODE with respect to the parameter- Throws:
MaxCountExceededException- if the number of functions evaluations is exceededDimensionMismatchException- if arrays dimensions do not match equations settingsUnknownParameterException- if the parameter is not supported
-
-