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.math.analysis.interpolation;
018    
019    import org.apache.commons.math.MathException;
020    import org.apache.commons.math.analysis.MultivariateRealFunction;
021    
022    /**
023     * Interface representing a univariate real interpolating function.
024     *
025     * @since 2.1
026     * @version $Revision: 924794 $ $Date: 2010-03-18 10:15:50 -0400 (Thu, 18 Mar 2010) $
027     */
028    public interface MultivariateRealInterpolator {
029    
030        /**
031         * Computes an interpolating function for the data set.
032         *
033         * @param xval the arguments for the interpolation points.
034         * {@code xval[i][0]} is the first component of interpolation point
035         * {@code i}, {@code xval[i][1]} is the second component, and so on
036         * until {@code xval[i][d-1]}, the last component of that interpolation
037         * point (where {@code d} is thus the dimension of the space).
038         * @param yval the values for the interpolation points
039         * @return a function which interpolates the data set
040         * @throws MathException if arguments violate assumptions made by the
041         *         interpolation algorithm or some dimension mismatch occurs
042         * @throws IllegalArgumentException if there are no data (xval null or zero length)
043         */
044        MultivariateRealFunction interpolate(double[][] xval, double[] yval)
045            throws MathException, IllegalArgumentException;
046    }