View Javadoc
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.CalculusFieldUnivariateFunction;
21  import org.hipparchus.exception.MathIllegalArgumentException;
22  
23  /**
24   * Interface representing a univariate field interpolating function.
25   * @since 1.5
26   */
27  public interface FieldUnivariateInterpolator {
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       * @param <T> the type of the field elements
34       * @return a function which interpolates the dataset.
35       * @throws MathIllegalArgumentException
36       * if the arguments violate assumptions made by the interpolation
37       * algorithm.
38       * @throws MathIllegalArgumentException if arrays lengthes do not match
39       */
40      <T extends CalculusFieldElement<T>> CalculusFieldUnivariateFunction<T> interpolate(T[] xval, T[] yval)
41          throws MathIllegalArgumentException;
42  }