Home | History | Annotate | Download | only in interpolation
      1 /*
      2  * Licensed to the Apache Software Foundation (ASF) under one or more
      3  * contributor license agreements.  See the NOTICE file distributed with
      4  * this work for additional information regarding copyright ownership.
      5  * The ASF licenses this file to You under the Apache License, Version 2.0
      6  * (the "License"); you may not use this file except in compliance with
      7  * the License.  You may obtain a copy of the License at
      8  *
      9  *      http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  * Unless required by applicable law or agreed to in writing, software
     12  * distributed under the License is distributed on an "AS IS" BASIS,
     13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  * See the License for the specific language governing permissions and
     15  * limitations under the License.
     16  */
     17 package org.apache.commons.math.analysis.interpolation;
     18 
     19 import org.apache.commons.math.MathException;
     20 import org.apache.commons.math.analysis.BivariateRealFunction;
     21 
     22 /**
     23  * Interface representing a bivariate real interpolating function where the
     24  * sample points must be specified on a regular grid.
     25  *
     26  * @version $Revision: 936391 $ $Date: 2010-04-21 19:00:56 +0200 (mer. 21 avril 2010) $
     27  */
     28 public interface BivariateRealGridInterpolator {
     29     /**
     30      * Computes an interpolating function for the data set.
     31      *
     32      * @param xval All the x-coordinates of the interpolation points, sorted
     33      * in increasing order.
     34      * @param yval All the y-coordinates of the interpolation points, sorted
     35      * in increasing order.
     36      * @param fval The values of the interpolation points on all the grid knots:
     37      * {@code fval[i][j] = f(xval[i], yval[j])}.
     38      * @return a function which interpolates the data set.
     39      * @throws MathException if arguments violate assumptions made by the
     40      *         interpolation algorithm.
     41      */
     42     BivariateRealFunction interpolate(double[] xval, double[] yval, double[][] fval)
     43         throws MathException;
     44 }
     45