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
20 /** Interface to compute by finite difference Jacobian matrix for some parameter
21 * when computing {@link JacobianMatrices partial derivatives equations}.
22 *
23 * @since 3.0
24 */
25
26 public interface ParameterizedODE extends Parameterizable {
27
28 /** Get parameter value from its name.
29 * @param name parameter name
30 * @return parameter value
31 * @exception UnknownParameterException if parameter is not supported
32 */
33 double getParameter(String name) throws UnknownParameterException;
34
35 /** Set the value for a given parameter.
36 * @param name parameter name
37 * @param value parameter value
38 * @exception UnknownParameterException if parameter is not supported
39 */
40 void setParameter(String name, double value) throws UnknownParameterException;
41 }