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.math.analysis.interpolation;
018    
019    import java.io.Serializable;
020    
021    import org.apache.commons.math.analysis.polynomials.PolynomialFunctionLagrangeForm;
022    
023    /**
024     * Implements the <a href="http://mathworld.wolfram.com/NevillesAlgorithm.html">
025     * Neville's Algorithm</a> for interpolation of real univariate functions. For
026     * reference, see <b>Introduction to Numerical Analysis</b>, ISBN 038795452X,
027     * chapter 2.
028     * <p>
029     * The actual code of Neville's algorithm is in PolynomialFunctionLagrangeForm,
030     * this class provides an easy-to-use interface to it.</p>
031     *
032     * @version $Id: NevilleInterpolator.java 1179928 2011-10-07 03:20:39Z psteitz $
033     * @since 1.2
034     */
035    public class NevilleInterpolator implements UnivariateRealInterpolator,
036        Serializable {
037    
038        /** serializable version identifier */
039        static final long serialVersionUID = 3003707660147873733L;
040    
041        /**
042         * Computes an interpolating function for the data set.
043         *
044         * @param x the interpolating points array
045         * @param y the interpolating values array
046         * @return a function which interpolates the data set
047         * @throws org.apache.commons.math.exception.DimensionMismatchException if
048         * the array lengths are different.
049         * @throws org.apache.commons.math.exception.NumberIsTooSmallException if
050         * the number of points is less than 2.
051         * @throws org.apache.commons.math.exception.NonMonotonicSequenceException
052         * if two abscissae have the same value.
053         */
054        public PolynomialFunctionLagrangeForm interpolate(double x[], double y[]) {
055            return new PolynomialFunctionLagrangeForm(x, y);
056        }
057    }