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