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.MultivariateFunction;
020    
021    /**
022     * Interface representing a univariate real interpolating function.
023     *
024     * @since 2.1
025     * @version $Id: MultivariateInterpolator.java 1364387 2012-07-22 18:14:11Z tn $
026     */
027    public interface MultivariateInterpolator {
028    
029        /**
030         * Computes an interpolating function for the data set.
031         *
032         * @param xval the arguments for the interpolation points.
033         * {@code xval[i][0]} is the first component of interpolation point
034         * {@code i}, {@code xval[i][1]} is the second component, and so on
035         * until {@code xval[i][d-1]}, the last component of that interpolation
036         * point (where {@code d} is thus the dimension of the space).
037         * @param yval the values for the interpolation points
038         * @return a function which interpolates the data set
039         * @throws org.apache.commons.math3.exception.MathIllegalArgumentException
040         * if the arguments violate assumptions made by the interpolation
041         * algorithm.
042         * @throws org.apache.commons.math3.exception.DimensionMismatchException
043         * when the array dimensions are not consistent.
044         * @throws org.apache.commons.math3.exception.NoDataException if an
045         * array has zero-length.
046         * @throws org.apache.commons.math3.exception.NullArgumentException if
047         * the arguments are {@code null}.
048         */
049        MultivariateFunction interpolate(double[][] xval, double[] yval);
050    }