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     */
017    
018    package org.apache.commons.math3.analysis;
019    
020    /**
021     * An interface representing a real function that depends on one independent
022     * variable plus some extra parameters.
023     *
024     * @since 3.0
025     * @version $Id: ParametricUnivariateFunction.java 1364387 2012-07-22 18:14:11Z tn $
026     */
027    public interface ParametricUnivariateFunction {
028        /**
029         * Compute the value of the function.
030         *
031         * @param x Point for which the function value should be computed.
032         * @param parameters Function parameters.
033         * @return the value.
034         */
035        double value(double x, double ... parameters);
036    
037        /**
038         * Compute the gradient of the function with respect to its parameters.
039         *
040         * @param x Point for which the function value should be computed.
041         * @param parameters Function parameters.
042         * @return the value.
043         */
044        double[] gradient(double x, double ... parameters);
045    }