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.math.analysis.interpolation;
18  
19  import org.apache.commons.math.MathException;
20  import org.apache.commons.math.analysis.UnivariateRealFunction;
21  
22  /**
23   * Interface representing a univariate real interpolating function.
24   *  
25   * @version $Revision: 799857 $ $Date: 2009-08-01 09:07:12 -0400 (Sat, 01 Aug 2009) $
26   */
27  public interface UnivariateRealInterpolator {
28  
29      /**
30       * Computes an interpolating function for the data set.
31       * @param xval the arguments for the interpolation points
32       * @param yval the values for the interpolation points
33       * @return a function which interpolates the data set
34       * @throws MathException if arguments violate assumptions made by the
35       *         interpolationg algorithm
36       */
37      public UnivariateRealFunction interpolate(double xval[], double yval[])
38          throws MathException;
39  }