001 /*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.commons.math3.analysis.interpolation;
018
019 import java.io.Serializable;
020
021 import org.apache.commons.math3.analysis.polynomials.PolynomialFunctionLagrangeForm;
022 import org.apache.commons.math3.exception.DimensionMismatchException;
023 import org.apache.commons.math3.exception.NumberIsTooSmallException;
024 import org.apache.commons.math3.exception.NonMonotonicSequenceException;
025
026 /**
027 * Implements the <a href="http://mathworld.wolfram.com/NevillesAlgorithm.html">
028 * Neville's Algorithm</a> for interpolation of real univariate functions. For
029 * reference, see <b>Introduction to Numerical Analysis</b>, ISBN 038795452X,
030 * chapter 2.
031 * <p>
032 * The actual code of Neville's algorithm is in PolynomialFunctionLagrangeForm,
033 * this class provides an easy-to-use interface to it.</p>
034 *
035 * @version $Id: NevilleInterpolator.java 1379904 2012-09-01 23:54:52Z erans $
036 * @since 1.2
037 */
038 public class NevilleInterpolator implements UnivariateInterpolator,
039 Serializable {
040
041 /** serializable version identifier */
042 static final long serialVersionUID = 3003707660147873733L;
043
044 /**
045 * Computes an interpolating function for the data set.
046 *
047 * @param x Interpolating points.
048 * @param y Interpolating values.
049 * @return a function which interpolates the data set
050 * @throws DimensionMismatchException if the array lengths are different.
051 * @throws NumberIsTooSmallException if the number of points is less than 2.
052 * @throws NonMonotonicSequenceException if two abscissae have the same
053 * value.
054 */
055 public PolynomialFunctionLagrangeForm interpolate(double x[], double y[])
056 throws DimensionMismatchException,
057 NumberIsTooSmallException,
058 NonMonotonicSequenceException {
059 return new PolynomialFunctionLagrangeForm(x, y);
060 }
061 }