    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.math3.analysis.interpolation;
    018
    019    import org.apache.commons.math3.analysis.TrivariateFunction;
    020    import org.apache.commons.math3.exception.DimensionMismatchException;
    021    import org.apache.commons.math3.exception.NoDataException;
    022
    023    /**
    024     * Interface representing a trivariate real interpolating function where the
    025     * sample points must be specified on a regular grid.
    026     *
    027     * @since 2.2
    028     * @version $Id: TrivariateGridInterpolator.java 1379904 2012-09-01 23:54:52Z erans $
    029     */
    030    public interface TrivariateGridInterpolator {
    031        /**
    032         * Compute an interpolating function for the dataset.
    033         *
    034         * @param xval All the x-coordinates of the interpolation points, sorted
    035         * in increasing order.
    036         * @param yval All the y-coordinates of the interpolation points, sorted
    037         * in increasing order.
    038         * @param zval All the z-coordinates of the interpolation points, sorted
    039         * in increasing order.
    040         * @param fval the values of the interpolation points on all the grid knots:
    041         * {@code fval[i][j][k] = f(xval[i], yval[j], zval[k])}.
    042         * @return a function that interpolates the data set.
    043         * @throws NoDataException if any of the arrays has zero length.
    044         * @throws DimensionMismatchException if the array lengths are inconsistent.
    045         */
    046        TrivariateFunction interpolate(double[] xval, double[] yval, double[] zval,
    047                                       double[][][] fval)
    048            throws NoDataException,
    049                   DimensionMismatchException;
    050    }