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