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.math3.analysis;
19
20 /**
21 * An interface representing a real function that depends on one independent
22 * variable plus some extra parameters.
23 *
24 * @since 3.0
25 * @version $Id: ParametricUnivariateFunction.java 1364387 2012-07-22 18:14:11Z tn $
26 */
27 public interface ParametricUnivariateFunction {
28 /**
29 * Compute the value of the function.
30 *
31 * @param x Point for which the function value should be computed.
32 * @param parameters Function parameters.
33 * @return the value.
34 */
35 double value(double x, double ... parameters);
36
37 /**
38 * Compute the gradient of the function with respect to its parameters.
39 *
40 * @param x Point for which the function value should be computed.
41 * @param parameters Function parameters.
42 * @return the value.
43 */
44 double[] gradient(double x, double ... parameters);
45 }