001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.math.ode.jacobians;
019    
020    import org.apache.commons.math.ode.DerivativeException;
021    import org.apache.commons.math.ode.FirstOrderDifferentialEquations;
022    
023    
024    /** This interface represents {@link ParameterizedODE
025     * first order differential equations} with parameters and partial derivatives.
026     *
027     * @see FirstOrderIntegratorWithJacobians
028     *
029     * @version $Revision: 919963 $ $Date: 2010-03-07 05:59:33 -0500 (Sun, 07 Mar 2010) $
030     * @since 2.1
031     */
032    
033    public interface ODEWithJacobians extends FirstOrderDifferentialEquations {
034    
035        /** Get the number of parameters.
036         * @return number of parameters
037         */
038        int getParametersDimension();
039    
040        /** Compute the partial derivatives of ODE with respect to state.
041         * @param t current value of the independent <I>time</I> variable
042         * @param y array containing the current value of the state vector
043         * @param yDot array containing the current value of the time derivative of the state vector
044         * @param dFdY placeholder array where to put the jacobian of the ODE with respect to the state vector
045         * @param dFdP placeholder array where to put the jacobian of the ODE with respect to the parameters
046         * @throws DerivativeException this exception is propagated to the caller if the
047         * underlying user function triggers one
048         */
049        void computeJacobians(double t, double[] y, double[] yDot, double[][] dFdY, double[][] dFdP)
050            throws DerivativeException;
051    
052    }