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 */
17package org.apache.commons.math.analysis.interpolation;
18
19import org.apache.commons.math.MathException;
20import org.apache.commons.math.analysis.MultivariateRealFunction;
21
22/**
23 * Interface representing a univariate real interpolating function.
24 *
25 * @since 2.1
26 * @version $Revision: 924794 $ $Date: 2010-03-18 15:15:50 +0100 (jeu. 18 mars 2010) $
27 */
28public interface MultivariateRealInterpolator {
29
30    /**
31     * Computes an interpolating function for the data set.
32     *
33     * @param xval the arguments for the interpolation points.
34     * {@code xval[i][0]} is the first component of interpolation point
35     * {@code i}, {@code xval[i][1]} is the second component, and so on
36     * until {@code xval[i][d-1]}, the last component of that interpolation
37     * point (where {@code d} is thus the dimension of the space).
38     * @param yval the values for the interpolation points
39     * @return a function which interpolates the data set
40     * @throws MathException if arguments violate assumptions made by the
41     *         interpolation algorithm or some dimension mismatch occurs
42     * @throws IllegalArgumentException if there are no data (xval null or zero length)
43     */
44    MultivariateRealFunction interpolate(double[][] xval, double[] yval)
45        throws MathException, IllegalArgumentException;
46}
47