1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.math4.legacy.analysis.interpolation;
18
19 import org.apache.commons.math4.legacy.exception.DimensionMismatchException;
20 import org.apache.commons.math4.legacy.exception.NoDataException;
21 import org.apache.commons.math4.legacy.exception.NonMonotonicSequenceException;
22 import org.apache.commons.math4.legacy.exception.NullArgumentException;
23 import org.apache.commons.math4.legacy.core.MathArrays;
24
25 /**
26 * Generates a piecewise-bicubic interpolating function.
27 *
28 * @since 2.2
29 */
30 public class PiecewiseBicubicSplineInterpolator
31 implements BivariateGridInterpolator {
32
33 /**
34 * {@inheritDoc}
35 */
36 @Override
37 public PiecewiseBicubicSplineInterpolatingFunction interpolate( final double[] xval,
38 final double[] yval,
39 final double[][] fval)
40 throws DimensionMismatchException,
41 NullArgumentException,
42 NoDataException,
43 NonMonotonicSequenceException {
44 if ( xval == null ||
45 yval == null ||
46 fval == null ||
47 fval[0] == null ) {
48 throw new NullArgumentException();
49 }
50
51 if ( xval.length == 0 ||
52 yval.length == 0 ||
53 fval.length == 0 ) {
54 throw new NoDataException();
55 }
56
57 MathArrays.checkOrder(xval);
58 MathArrays.checkOrder(yval);
59
60 return new PiecewiseBicubicSplineInterpolatingFunction( xval, yval, fval );
61 }
62 }