001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.math3.analysis.differentiation;
018
019import org.apache.commons.math3.analysis.UnivariateFunction;
020import org.apache.commons.math3.exception.DimensionMismatchException;
021
022/** Interface for univariate functions derivatives.
023 * <p>This interface represents a simple function which computes
024 * both the value and the first derivative of a mathematical function.
025 * The derivative is computed with respect to the input variable.</p>
026 * @see UnivariateDifferentiableFunction
027 * @see UnivariateFunctionDifferentiator
028 * @since 3.1
029 * @version $Id: UnivariateDifferentiableFunction.java 1462496 2013-03-29 14:56:08Z psteitz $
030 */
031public interface UnivariateDifferentiableFunction extends UnivariateFunction {
032
033    /** Simple mathematical function.
034     * <p>{@link UnivariateDifferentiableFunction} classes compute both the
035     * value and the first derivative of the function.</p>
036     * @param t function input value
037     * @return function result
038     * @exception DimensionMismatchException if t is inconsistent with the
039     * function's free parameters or order
040     */
041    DerivativeStructure value(DerivativeStructure t)
042        throws DimensionMismatchException;
043
044}