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