View Javadoc
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    *      https://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  
18  /*
19   * This is not the original file distributed by the Apache Software Foundation
20   * It has been modified by the Hipparchus project
21   */
22  package org.hipparchus.analysis.interpolation;
23  
24  import org.hipparchus.analysis.TrivariateFunction;
25  import org.hipparchus.exception.MathIllegalArgumentException;
26  
27  /**
28   * Interface representing a trivariate real interpolating function where the
29   * sample points must be specified on a regular grid.
30   *
31   */
32  public interface TrivariateGridInterpolator {
33      /**
34       * Compute an interpolating function for the dataset.
35       *
36       * @param xval All the x-coordinates of the interpolation points, sorted
37       * in increasing order.
38       * @param yval All the y-coordinates of the interpolation points, sorted
39       * in increasing order.
40       * @param zval All the z-coordinates of the interpolation points, sorted
41       * in increasing order.
42       * @param fval the values of the interpolation points on all the grid knots:
43       * {@code fval[i][j][k] = f(xval[i], yval[j], zval[k])}.
44       * @return a function that interpolates the data set.
45       * @throws MathIllegalArgumentException if any of the arrays has zero length.
46       * @throws MathIllegalArgumentException if the array lengths are inconsistent.
47       * @throws MathIllegalArgumentException if arrays are not sorted
48       * @throws MathIllegalArgumentException if the number of points is too small for
49       * the order of the interpolation
50       */
51      TrivariateFunction interpolate(double[] xval, double[] yval, double[] zval,
52                                     double[][][] fval)
53          throws MathIllegalArgumentException;
54  }