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 * 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
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.migration.ode;
23
24 import org.hipparchus.exception.MathIllegalArgumentException;
25 import org.hipparchus.exception.MathIllegalStateException;
26 import org.hipparchus.ode.NamedParameterJacobianProvider;
27
28 /** Interface to compute exactly Jacobian matrix for some parameter
29 * when computing {@link JacobianMatrices partial derivatives equations}.
30 * @deprecated as of 1.0, replaced with {@link NamedParameterJacobianProvider}
31 */
32 @Deprecated
33 public interface ParameterJacobianProvider extends NamedParameterJacobianProvider {
34
35 /** {@inheritDoc}
36 * <p>
37 * The default implementation calls {@link #computeParameterJacobian(double,
38 * double[], double[], String, double[])}
39 * </p>
40 */
41 @Override
42 default double[] computeParameterJacobian(final double t, final double[] y,
43 final double[] yDot, final String paramName)
44 throws MathIllegalArgumentException, MathIllegalStateException {
45 final double[] dFdP = new double[y.length];
46 computeParameterJacobian(t, y, yDot, paramName, dFdP);
47 return dFdP;
48 }
49
50 /** Compute the Jacobian matrix of ODE with respect to one parameter.
51 * <p>If the parameter does not belong to the collection returned by
52 * {@link #getParametersNames()}, the Jacobian will be set to 0,
53 * but no errors will be triggered.</p>
54 * @param t current value of the independent <I>time</I> variable
55 * @param y array containing the current value of the main state vector
56 * @param yDot array containing the current value of the time derivative
57 * of the main state vector
58 * @param paramName name of the parameter to consider
59 * @param dFdP placeholder array where to put the Jacobian matrix of the
60 * ODE with respect to the parameter
61 * @exception MathIllegalStateException if the number of functions evaluations is exceeded
62 * @exception MathIllegalArgumentException if arrays dimensions do not match equations settings
63 * @exception MathIllegalArgumentException if the parameter is not supported
64 */
65 void computeParameterJacobian(double t, double[] y, double[] yDot,
66 String paramName, double[] dFdP)
67 throws MathIllegalArgumentException, MathIllegalStateException;
68
69 }