    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.BivariateRealFunction;
    021
    022    /**
    023     * Interface representing a bivariate real interpolating function where the
    024     * sample points must be specified on a regular grid.
    025     *
    026     * @version $Revision: 936391 $ $Date: 2010-04-21 19:00:56 +0200 (mer. 21 avril 2010) $
    027     */
    028    public interface BivariateRealGridInterpolator {
    029        /**
    030         * Computes an interpolating function for the data set.
    031         *
    032         * @param xval All the x-coordinates of the interpolation points, sorted
    033         * in increasing order.
    034         * @param yval All the y-coordinates of the interpolation points, sorted
    035         * in increasing order.
    036         * @param fval The values of the interpolation points on all the grid knots:
    037         * {@code fval[i][j] = f(xval[i], yval[j])}.
    038         * @return a function which interpolates the data set.
    039         * @throws MathException if arguments violate assumptions made by the
    040         *         interpolation algorithm.
    041         */
    042        BivariateRealFunction interpolate(double[] xval, double[] yval, double[][] fval)
    043            throws MathException;
    044    }