Package org.hipparchus.analysis.interpolation

Class BilinearInterpolator

java.lang.Object

org.hipparchus.analysis.interpolation.BilinearInterpolator

All Implemented Interfaces:

BivariateGridInterpolator

public class BilinearInterpolator
extends Object
implements BivariateGridInterpolator

Interpolate grid data using bi-linear interpolation.

Since:

1.4

Constructor Summary

Constructors

Constructor	Description
BilinearInterpolator()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
BilinearInterpolatingFunction	interpolate(double[] xval, double[] yval, double[][] fval)	Compute an interpolating function for the dataset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BilinearInterpolator

public BilinearInterpolator()

Empty constructor.

This constructor is not strictly necessary, but it prevents spurious javadoc warnings with JDK 18 and later.

Since:

3.0

Method Details

interpolate

public BilinearInterpolatingFunction interpolate(double[] xval,
 double[] yval,
 double[][] fval)
                                          throws MathIllegalArgumentException

Compute an interpolating function for the dataset.

Specified by:

interpolate in interface BivariateGridInterpolator

Parameters:

xval - All the x-coordinates of the interpolation points, sorted in increasing order.

yval - All the y-coordinates of the interpolation points, sorted in increasing order.

fval - The values of the interpolation points on all the grid knots: fval[i][j] = f(xval[i], yval[j]).

Returns:

a function which interpolates the dataset.

Throws:

MathIllegalArgumentException - if any of the arrays has zero length.

MathIllegalArgumentException - if the array lengths are inconsistent.

MathIllegalArgumentException - if the array is not sorted.

MathIllegalArgumentException - if the number of points is too small for the order of the interpolation