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 */
17package org.apache.commons.math.analysis.interpolation;
18
19import org.apache.commons.math.MathException;
20import org.apache.commons.math.analysis.TrivariateRealFunction;
21
22/**
23 * Interface representing a trivariate real interpolating function where the
24 * sample points must be specified on a regular grid.
25 *
26 * @version $Revision$ $Date$
27 * @since 2.2
28 */
29public interface TrivariateRealGridInterpolator {
30    /**
31     * Computes an interpolating function for the data set.
32     *
33     * @param xval All the x-coordinates of the interpolation points, sorted
34     * in increasing order.
35     * @param yval All the y-coordinates of the interpolation points, sorted
36     * in increasing order.
37     * @param zval All the z-coordinates of the interpolation points, sorted
38     * in increasing order.
39     * @param fval the values of the interpolation points on all the grid knots:
40     * {@code fval[i][j][k] = f(xval[i], yval[j], zval[k])}.
41     * @return a function that interpolates the data set.
42     * @throws org.apache.commons.math.exception.NoDataException if any of the arrays has zero length.
43     * @throws org.apache.commons.math.exception.DimensionMismatchException if the array lengths are inconsistent.
44     * @throws MathException if arguments violate assumptions made by the
45     *         interpolation algorithm.
46     */
47    TrivariateRealFunction interpolate(double[] xval, double[] yval, double[] zval, double[][][] fval)
48        throws MathException;
49}
50