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.math3.analysis.interpolation;
18 
19 import org.apache.commons.math3.analysis.UnivariateFunction;
20 import org.apache.commons.math3.exception.DimensionMismatchException;
21 import org.apache.commons.math3.exception.MathIllegalArgumentException;
22 
23 /**
24  * Interface representing a univariate real interpolating function.
25  *
26  */
27 public interface UnivariateInterpolator {
28     /**
29      * Compute an interpolating function for the dataset.
30      *
31      * @param xval Arguments for the interpolation points.
32      * @param yval Values for the interpolation points.
33      * @return a function which interpolates the dataset.
34      * @throws MathIllegalArgumentException
35      * if the arguments violate assumptions made by the interpolation
36      * algorithm.
37      * @throws DimensionMismatchException if arrays lengthes do not match
38      */
interpolate(double xval[], double yval[])39     UnivariateFunction interpolate(double xval[], double yval[])
40         throws MathIllegalArgumentException, DimensionMismatchException;
41 }
42