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    *      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.analysis.differentiation;
18  
19  import org.apache.commons.math4.legacy.analysis.UnivariateFunction;
20  
21  /** Interface for univariate functions derivatives.
22   * <p>This interface represents a simple function which computes
23   * both the value and the first derivative of a mathematical function.
24   * The derivative is computed with respect to the input variable.</p>
25   * @see UnivariateDifferentiableFunction
26   * @see UnivariateFunctionDifferentiator
27   * @since 3.1
28   */
29  public interface UnivariateDifferentiableFunction extends UnivariateFunction {
30  
31      /** Simple mathematical function.
32       * <p>{@link UnivariateDifferentiableFunction} classes compute both the
33       * value and the first derivative of the function.</p>
34       * @param t function input value
35       * @return function result
36       * @throws org.apache.commons.math4.legacy.exception.DimensionMismatchException
37       * if {@code t} is inconsistent with the function's free parameters or order.
38       */
39      DerivativeStructure value(DerivativeStructure t);
40  }