View Javadoc
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  
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.OrdinaryDifferentialEquation;
27  
28  /** Interface expanding {@link FirstOrderDifferentialEquations first order
29   *  differential equations} in order to compute exactly the main state jacobian
30   *  matrix for {@link JacobianMatrices partial derivatives equations}.
31   * @deprecated as of 1.0, replaced with {@link org.hipparchus.ode.ODEJacobiansProvider}
32   */
33  @Deprecated
34  public interface MainStateJacobianProvider extends OrdinaryDifferentialEquation {
35  
36      /** Compute the jacobian matrix of ODE with respect to main state.
37       * @param t current value of the independent <I>time</I> variable
38       * @param y array containing the current value of the main state vector
39       * @param yDot array containing the current value of the time derivative of the main state vector
40       * @return Jacobian matrix of the ODE w.r.t. the main state vector
41       * @exception MathIllegalStateException if the number of functions evaluations is exceeded
42       * @exception MathIllegalArgumentException if arrays dimensions do not match equations settings
43       */
44      double[][] computeMainStateJacobian(double t, double[] y, double[] yDot)
45          throws MathIllegalArgumentException, MathIllegalStateException;
46  
47  }