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.MultivariateFunction;
25  import org.hipparchus.exception.MathIllegalArgumentException;
26  import org.hipparchus.exception.NullArgumentException;
27  
28  /**
29   * Interface representing a univariate real interpolating function.
30   *
31   */
32  public interface MultivariateInterpolator {
33  
34      /**
35       * Computes an interpolating function for the data set.
36       *
37       * @param xval the arguments for the interpolation points.
38       * {@code xval[i][0]} is the first component of interpolation point
39       * {@code i}, {@code xval[i][1]} is the second component, and so on
40       * until {@code xval[i][d-1]}, the last component of that interpolation
41       * point (where {@code d} is thus the dimension of the space).
42       * @param yval the values for the interpolation points
43       * @return a function which interpolates the data set
44       * @throws MathIllegalArgumentException if the arguments violate assumptions
45       * made by the interpolation algorithm.
46       * @throws MathIllegalArgumentException when the array dimensions are not consistent.
47       * @throws MathIllegalArgumentException if an array has zero-length.
48       * @throws NullArgumentException if the arguments are {@code null}.
49       */
50      MultivariateFunction interpolate(double[][] xval, double[] yval)
51          throws MathIllegalArgumentException, NullArgumentException;
52  }