View Javadoc
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    *      https://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  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  
23  package org.hipparchus.analysis;
24  
25  /**
26   * An interface representing a real function that depends on one independent
27   * variable plus some extra parameters.
28   *
29   */
30  public interface ParametricUnivariateFunction {
31      /**
32       * Compute the value of the function.
33       *
34       * @param x Point for which the function value should be computed.
35       * @param parameters Function parameters.
36       * @return the value.
37       */
38      double value(double x, double ... parameters);
39  
40      /**
41       * Compute the gradient of the function with respect to its parameters.
42       *
43       * @param x Point for which the function value should be computed.
44       * @param parameters Function parameters.
45       * @return the value.
46       */
47      double[] gradient(double x, double ... parameters);
48  }