org.apache.commons.math3.ode.ParameterizedODE Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-math3 Show documentation
Show all versions of commons-math3 Show documentation
The Apache Commons Math project is a library of lightweight, self-contained mathematics and statistics components addressing the most common practical problems not immediately available in the Java programming language or commons-lang.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.math3.ode;
/** Interface to compute by finite difference Jacobian matrix for some parameter
* when computing {@link JacobianMatrices partial derivatives equations}.
*
* @since 3.0
*/
public interface ParameterizedODE extends Parameterizable {
/** Get parameter value from its name.
* @param name parameter name
* @return parameter value
* @exception UnknownParameterException if parameter is not supported
*/
double getParameter(String name) throws UnknownParameterException;
/** Set the value for a given parameter.
* @param name parameter name
* @param value parameter value
* @exception UnknownParameterException if parameter is not supported
*/
void setParameter(String name, double value) throws UnknownParameterException;
}