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.math3.analysis.interpolation;
018
019import org.apache.commons.math3.exception.DimensionMismatchException;
020import org.apache.commons.math3.exception.NoDataException;
021import org.apache.commons.math3.exception.NonMonotonicSequenceException;
022import org.apache.commons.math3.exception.NullArgumentException;
023import org.apache.commons.math3.util.MathArrays;
024
025/**
026 * Generates a bicubic interpolating function.
027 *
028 * @since 2.2
029 */
030public class BicubicSplineInterpolator
031    implements BivariateGridInterpolator
032{
033
034    /**
035     * Default constructor.
036     */
037    public BicubicSplineInterpolator()
038    {
039
040    }
041
042    /**
043     * {@inheritDoc}
044     */
045    public BicubicSplineInterpolatingFunction interpolate( final double[] xval, final double[] yval,
046                                                          final double[][] fval)
047        throws DimensionMismatchException, NullArgumentException, NoDataException, NonMonotonicSequenceException
048    {
049        if ( xval == null || yval == null || fval == null || fval[0] == null )
050        {
051            throw new NullArgumentException();
052        }
053
054        if ( xval.length == 0 || yval.length == 0 || fval.length == 0 )
055        {
056            throw new NoDataException();
057        }
058
059        MathArrays.checkOrder(xval);
060        MathArrays.checkOrder(yval);
061
062        return new BicubicSplineInterpolatingFunction( xval, yval, fval );
063    }
064}