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.math4.legacy.analysis.interpolation;
18
19 import org.apache.commons.math4.legacy.analysis.BivariateFunction;
20 import org.apache.commons.math4.legacy.exception.DimensionMismatchException;
21 import org.apache.commons.math4.legacy.exception.NoDataException;
22 import org.apache.commons.math4.legacy.exception.NonMonotonicSequenceException;
23 import org.apache.commons.math4.legacy.exception.NumberIsTooSmallException;
24
25 /**
26 * Interface representing a bivariate real interpolating function where the
27 * sample points must be specified on a regular grid.
28 *
29 */
30 public interface BivariateGridInterpolator {
31 /**
32 * Compute an interpolating function for the dataset.
33 *
34 * @param xval All the x-coordinates of the interpolation points, sorted
35 * in increasing order.
36 * @param yval All the y-coordinates of the interpolation points, sorted
37 * in increasing order.
38 * @param fval The values of the interpolation points on all the grid knots:
39 * {@code fval[i][j] = f(xval[i], yval[j])}.
40 * @return a function which interpolates the dataset.
41 * @throws NoDataException if any of the arrays has zero length.
42 * @throws DimensionMismatchException if the array lengths are inconsistent.
43 * @throws NonMonotonicSequenceException if the array is not sorted.
44 * @throws NumberIsTooSmallException if the number of points is too small for
45 * the order of the interpolation
46 */
47 BivariateFunction interpolate(double[] xval, double[] yval,
48 double[][] fval)
49 throws NoDataException, DimensionMismatchException,
50 NonMonotonicSequenceException, NumberIsTooSmallException;
51 }