Raymond | dee0849 | 2015-04-02 10:43:13 -0700 | [diff] [blame] | 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 | package org.apache.commons.math.ode.jacobians; |
| 19 | |
| 20 | import org.apache.commons.math.ode.DerivativeException; |
| 21 | import org.apache.commons.math.ode.FirstOrderDifferentialEquations; |
| 22 | |
| 23 | |
| 24 | /** This interface represents {@link ParameterizedODE |
| 25 | * first order differential equations} with parameters and partial derivatives. |
| 26 | * |
| 27 | * @see FirstOrderIntegratorWithJacobians |
| 28 | * |
| 29 | * @version $Revision: 1073158 $ $Date: 2011-02-21 22:46:52 +0100 (lun. 21 févr. 2011) $ |
| 30 | * @since 2.1 |
| 31 | * @deprecated as of 2.2 the complete package is deprecated, it will be replaced |
| 32 | * in 3.0 by a completely rewritten implementation |
| 33 | */ |
| 34 | @Deprecated |
| 35 | public interface ODEWithJacobians extends FirstOrderDifferentialEquations { |
| 36 | |
| 37 | /** Get the number of parameters. |
| 38 | * @return number of parameters |
| 39 | */ |
| 40 | int getParametersDimension(); |
| 41 | |
| 42 | /** Compute the partial derivatives of ODE with respect to state. |
| 43 | * @param t current value of the independent <I>time</I> variable |
| 44 | * @param y array containing the current value of the state vector |
| 45 | * @param yDot array containing the current value of the time derivative of the state vector |
| 46 | * @param dFdY placeholder array where to put the jacobian of the ODE with respect to the state vector |
| 47 | * @param dFdP placeholder array where to put the jacobian of the ODE with respect to the parameters |
| 48 | * @throws DerivativeException this exception is propagated to the caller if the |
| 49 | * underlying user function triggers one |
| 50 | */ |
| 51 | void computeJacobians(double t, double[] y, double[] yDot, double[][] dFdY, double[][] dFdP) |
| 52 | throws DerivativeException; |
| 53 | |
| 54 | } |