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 * https://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
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.analysis.interpolation;
23
24 import org.hipparchus.exception.LocalizedCoreFormats;
25 import org.hipparchus.exception.MathIllegalArgumentException;
26 import org.hipparchus.exception.NullArgumentException;
27 import org.hipparchus.util.MathArrays;
28
29 /**
30 * Generates a piecewise-bicubic interpolating function.
31 *
32 */
33 public class PiecewiseBicubicSplineInterpolator
34 implements BivariateGridInterpolator {
35
36 /** Empty constructor.
37 * <p>
38 * This constructor is not strictly necessary, but it prevents spurious
39 * javadoc warnings with JDK 18 and later.
40 * </p>
41 * @since 3.0
42 */
43 public PiecewiseBicubicSplineInterpolator() { // NOPMD - unnecessary constructor added intentionally to make javadoc happy
44 // nothing to do
45 }
46
47 /**
48 * {@inheritDoc}
49 */
50 @Override
51 public PiecewiseBicubicSplineInterpolatingFunction interpolate( final double[] xval,
52 final double[] yval,
53 final double[][] fval)
54 throws MathIllegalArgumentException, NullArgumentException {
55 if (xval == null || yval == null || fval == null || fval[0] == null) {
56 throw new NullArgumentException();
57 }
58
59 if (xval.length == 0 || yval.length == 0 || fval.length == 0) {
60 throw new MathIllegalArgumentException(LocalizedCoreFormats.NO_DATA);
61 }
62
63 MathArrays.checkOrder(xval);
64 MathArrays.checkOrder(yval);
65
66 return new PiecewiseBicubicSplineInterpolatingFunction(xval, yval, fval);
67 }
68
69 }