1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 package org.hipparchus.analysis.interpolation;
18
19 import org.hipparchus.CalculusFieldElement;
20 import org.hipparchus.analysis.CalculusFieldBivariateFunction;
21 import org.hipparchus.exception.MathIllegalArgumentException;
22
23 /**
24 * Interface representing a bivariate field interpolating function where the
25 * sample points must be specified on a regular grid.
26 * @param <T> type of the field elements
27 * @since 4.0
28 */
29 public interface FieldBivariateGridInterpolator<T extends CalculusFieldElement<T>> {
30 /**
31 * Compute an interpolating function for the dataset.
32 *
33 * @param xval All the x-coordinates of the interpolation points, sorted
34 * in increasing order.
35 * @param yval All the y-coordinates of the interpolation points, sorted
36 * in increasing order.
37 * @param fval The values of the interpolation points on all the grid knots:
38 * {@code fval[i][j] = f(xval[i], yval[j])}.
39 * @return a function which interpolates the dataset.
40 * @throws MathIllegalArgumentException if any of the arrays has zero length.
41 * @throws MathIllegalArgumentException if the array lengths are inconsistent.
42 * @throws MathIllegalArgumentException if the array is not sorted.
43 * @throws MathIllegalArgumentException if the number of points is too small for
44 * the order of the interpolation
45 */
46 CalculusFieldBivariateFunction<T> interpolate(T[] xval, T[] yval, T[][] fval)
47 throws MathIllegalArgumentException;
48 }