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.FirstOrderDifferentialEquations;
021    
022    
023    /** This interface represents {@link FirstOrderDifferentialEquations
024     * first order differential equations} with parameters.
025     *
026     * @see FirstOrderIntegratorWithJacobians
027     *
028     * @version $Revision: 918702 $ $Date: 2010-03-03 16:28:16 -0500 (Wed, 03 Mar 2010) $
029     * @since 2.1
030     */
031    
032    public interface ParameterizedODE
033        extends FirstOrderDifferentialEquations {
034    
035        /** Get the number of parameters.
036         * @return number of parameters
037         */
038        int getParametersDimension();
039    
040        /** Set a parameter.
041         * @param i index of the parameters (must be between 0
042         * and {@link #getParametersDimension() getParametersDimension() - 1})
043         * @param value value for the parameter
044         */
045        void setParameter(int i, double value);
046    
047    }