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  package org.hipparchus.analysis.differentiation;
23  
24  import org.hipparchus.analysis.UnivariateFunction;
25  import org.hipparchus.exception.MathIllegalArgumentException;
26  
27  /** Interface for univariate functions derivatives.
28   * <p>This interface represents a simple function which computes
29   * both the value and the first derivative of a mathematical function.
30   * The derivative is computed with respect to the input variable.</p>
31   * @see UnivariateDifferentiableFunction
32   * @see UnivariateFunctionDifferentiator
33   */
34  public interface UnivariateDifferentiableFunction extends UnivariateFunction {
35  
36      /**
37       * Compute the value for the function.
38       * @param x the point for which the function value should be computed
39       * @param <T> the type of the field elements
40       * @return the value
41       * @exception MathIllegalArgumentException if {@code x} does not
42       * satisfy the function's constraints (argument out of bound, or unsupported
43       * derivative order for example)
44       */
45      <T extends Derivative<T>> T value(T x) throws MathIllegalArgumentException;
46  
47  }