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