1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.math4.legacy.ode;
18
19 import org.apache.commons.math4.legacy.exception.DimensionMismatchException;
20 import org.apache.commons.math4.legacy.exception.MaxCountExceededException;
21
22 /** Interface to compute exactly Jacobian matrix for some parameter
23 * when computing {@link JacobianMatrices partial derivatives equations}.
24 *
25 * @since 3.0
26 */
27 public interface ParameterJacobianProvider extends Parameterizable {
28
29 /** Compute the Jacobian matrix of ODE with respect to one parameter.
30 * <p>If the parameter does not belong to the collection returned by
31 * {@link #getParametersNames()}, the Jacobian will be set to 0,
32 * but no errors will be triggered.</p>
33 * @param t current value of the independent <I>time</I> variable
34 * @param y array containing the current value of the main state vector
35 * @param yDot array containing the current value of the time derivative
36 * of the main state vector
37 * @param paramName name of the parameter to consider
38 * @param dFdP placeholder array where to put the Jacobian matrix of the
39 * ODE with respect to the parameter
40 * @exception MaxCountExceededException if the number of functions evaluations is exceeded
41 * @exception DimensionMismatchException if arrays dimensions do not match equations settings
42 * @exception UnknownParameterException if the parameter is not supported
43 */
44 void computeParameterJacobian(double t, double[] y, double[] yDot,
45 String paramName, double[] dFdP)
46 throws DimensionMismatchException, MaxCountExceededException, UnknownParameterException;
47 }