1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 * https://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.hipparchus.ode;
18
19 import org.hipparchus.exception.MathIllegalArgumentException;
20 import org.hipparchus.exception.MathIllegalStateException;
21
22 /** Interface to compute exactly Jacobian matrix for some parameter
23 * when computing {@link VariationalEquation partial derivatives equations}.
24 *
25 */
26 public interface NamedParameterJacobianProvider extends Parameterizable {
27
28 /** Compute the Jacobian matrix of ODE with respect to one parameter.
29 * <p>If the parameter does not belong to the collection returned by
30 * {@link #getParametersNames()}, the Jacobian will be set to 0,
31 * but no errors will be triggered.</p>
32 * @param t current value of the independent <I>time</I> variable
33 * @param y array containing the current value of the main state vector
34 * @param yDot array containing the current value of the time derivative
35 * of the main state vector
36 * @param paramName name of the parameter to consider
37 * @return Jacobian matrix of the ODE with respect to the parameter
38 * @exception MathIllegalStateException if the number of functions evaluations is exceeded
39 * @exception MathIllegalArgumentException if arrays dimensions do not match equations settings
40 * @exception MathIllegalArgumentException if the parameter is not supported
41 */
42 double[] computeParameterJacobian(double t, double[] y, double[] yDot, String paramName)
43 throws MathIllegalArgumentException, MathIllegalStateException;
44
45 }