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 expanding {@link FirstOrderDifferentialEquations first order
23 * differential equations} in order to compute exactly the main state jacobian
24 * matrix for {@link JacobianMatrices partial derivatives equations}.
25 *
26 * @since 3.0
27 */
28 public interface MainStateJacobianProvider extends FirstOrderDifferentialEquations {
29
30 /** Compute the jacobian matrix of ODE with respect to main state.
31 * @param t current value of the independent <I>time</I> variable
32 * @param y array containing the current value of the main state vector
33 * @param yDot array containing the current value of the time derivative of the main state vector
34 * @param dFdY placeholder array where to put the jacobian matrix of the ODE w.r.t. the main state vector
35 * @exception MaxCountExceededException if the number of functions evaluations is exceeded
36 * @exception DimensionMismatchException if arrays dimensions do not match equations settings
37 */
38 void computeMainStateJacobian(double t, double[] y, double[] yDot, double[][] dFdY)
39 throws MaxCountExceededException, DimensionMismatchException;
40 }