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.TrivariateFunction;
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 trivariate real interpolating function where the
27 * sample points must be specified on a regular grid.
28 *
29 * @since 2.2
30 */
31 public interface TrivariateGridInterpolator {
32 /**
33 * Compute an interpolating function for the dataset.
34 *
35 * @param xval All the x-coordinates of the interpolation points, sorted
36 * in increasing order.
37 * @param yval All the y-coordinates of the interpolation points, sorted
38 * in increasing order.
39 * @param zval All the z-coordinates of the interpolation points, sorted
40 * in increasing order.
41 * @param fval the values of the interpolation points on all the grid knots:
42 * {@code fval[i][j][k] = f(xval[i], yval[j], zval[k])}.
43 * @return a function that interpolates the data set.
44 * @throws NoDataException if any of the arrays has zero length.
45 * @throws DimensionMismatchException if the array lengths are inconsistent.
46 * @throws NonMonotonicSequenceException if arrays are not sorted
47 * @throws NumberIsTooSmallException if the number of points is too small for
48 * the order of the interpolation
49 */
50 TrivariateFunction interpolate(double[] xval, double[] yval, double[] zval,
51 double[][][] fval)
52 throws NoDataException, NumberIsTooSmallException,
53 DimensionMismatchException, NonMonotonicSequenceException;
54 }