Package org.hipparchus.migration.ode

Interface ParameterJacobianProvider

All Superinterfaces:

NamedParameterJacobianProvider, Parameterizable

@Deprecated
public interface ParameterJacobianProvider
extends NamedParameterJacobianProvider

Deprecated.

as of 1.0, replaced with NamedParameterJacobianProvider

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

Method Summary

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

Methods inherited from interface org.hipparchus.ode.Parameterizable

getParametersNames, isSupported

Method Detail

computeParameterJacobian

default double[] computeParameterJacobian(double t,
                                          double[] y,
                                          double[] yDot,
                                          String paramName)
                                   throws MathIllegalArgumentException,
                                          MathIllegalStateException

Deprecated.

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.

The default implementation calls computeParameterJacobian(double, double[], double[], String, double[])

Specified by:

computeParameterJacobian in interface NamedParameterJacobianProvider

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

Returns:

Jacobian matrix of the ODE with respect to the parameter

Throws:

MathIllegalArgumentException - if arrays dimensions do not match equations settings

MathIllegalStateException - if the number of functions evaluations is exceeded

computeParameterJacobian

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

Deprecated.

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 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:

MathIllegalStateException - if the number of functions evaluations is exceeded

MathIllegalArgumentException - if arrays dimensions do not match equations settings

MathIllegalArgumentException - if the parameter is not supported