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 */
017package org.apache.commons.math4.analysis.interpolation;
018
019import java.io.Serializable;
020
021import org.apache.commons.math4.analysis.polynomials.PolynomialFunctionLagrangeForm;
022import org.apache.commons.math4.exception.DimensionMismatchException;
023import org.apache.commons.math4.exception.NonMonotonicSequenceException;
024import org.apache.commons.math4.exception.NumberIsTooSmallException;
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 * @since 1.2
036 */
037public class NevilleInterpolator implements UnivariateInterpolator,
038    Serializable {
039
040    /** serializable version identifier */
041    static final long serialVersionUID = 3003707660147873733L;
042
043    /**
044     * Computes an interpolating function for the data set.
045     *
046     * @param x Interpolating points.
047     * @param y Interpolating values.
048     * @return a function which interpolates the data set
049     * @throws DimensionMismatchException if the array lengths are different.
050     * @throws NumberIsTooSmallException if the number of points is less than 2.
051     * @throws NonMonotonicSequenceException if two abscissae have the same
052     * value.
053     */
054    @Override
055    public PolynomialFunctionLagrangeForm interpolate(double x[], double y[])
056        throws DimensionMismatchException,
057               NumberIsTooSmallException,
058               NonMonotonicSequenceException {
059        return new PolynomialFunctionLagrangeForm(x, y);
060    }
061}