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    package org.apache.commons.math3.analysis.interpolation;
018    
019    import org.apache.commons.math3.analysis.UnivariateFunction;
020    import org.apache.commons.math3.exception.DimensionMismatchException;
021    import org.apache.commons.math3.exception.MathIllegalArgumentException;
022    
023    /**
024     * Interface representing a univariate real interpolating function.
025     *
026     * @version $Id: UnivariateInterpolator.java 1455194 2013-03-11 15:45:54Z luc $
027     */
028    public interface UnivariateInterpolator {
029        /**
030         * Compute an interpolating function for the dataset.
031         *
032         * @param xval Arguments for the interpolation points.
033         * @param yval Values for the interpolation points.
034         * @return a function which interpolates the dataset.
035         * @throws MathIllegalArgumentException
036         * if the arguments violate assumptions made by the interpolation
037         * algorithm.
038         * @throws DimensionMismatchException if arrays lengthes do not match
039         */
040        UnivariateFunction interpolate(double xval[], double yval[])
041            throws MathIllegalArgumentException, DimensionMismatchException;
042    }