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    *      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.UnivariateFunction;
20  
21  /**
22   * Interface representing a univariate real interpolating function.
23   */
24  public interface UnivariateInterpolator {
25      /**
26       * Computes an interpolating function for the dataset.
27       *
28       * @param xval Arguments for the interpolation points.
29       * @param yval Values for the interpolation points.
30       * @return a function which interpolates the dataset.
31       * @throws org.apache.commons.math4.legacy.exception.MathIllegalArgumentException
32       * if the arguments violate assumptions made by the interpolation algorithm.
33       */
34      UnivariateFunction interpolate(double[] xval, double[] yval);
35  }