org.apache.commons.math3.analysis.interpolation

public Interface BivariateGridInterpolator

Known Direct Implementers: org.apache.commons.math3.analysis.interpolation.PiecewiseBicubicSplineInterpolator, org.apache.commons.math3.analysis.interpolation.BicubicInterpolator, org.apache.commons.math3.analysis.interpolation.BicubicSplineInterpolator
Imports: org.apache.commons.math3.analysis.BivariateFunction, org.apache.commons.math3.exception.DimensionMismatchException, .NoDataException, .NonMonotonicSequenceException, .NumberIsTooSmallException

Interface representing a bivariate real interpolating function where the sample points must be specified on a regular grid.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public BivariateFunction	Returns: a function which interpolates the dataset. interpolate(double[] All the x-coordinates of the interpolation points, sorted in increasing order. xval, double[] All the y-coordinates of the interpolation points, sorted in increasing order. yval, double[][] The values of the interpolation points on all the grid knots: `fval[i][j] = f(xval[i], yval[j])`. fval) Compute an interpolating function for the dataset.

Returns:

a function which interpolates the dataset.

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

xval, double[]

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

yval, double[][]

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

fval)

Compute an interpolating function for the dataset.

interpolate back to summary

interpolate	back to summary
public BivariateFunction interpolate(double[] xval, double[] yval, double[][] fval) throws NoDataException, DimensionMismatchException, NonMonotonicSequenceException, NumberIsTooSmallException Compute an interpolating function for the dataset. Parameters xval:double[] All the x-coordinates of the interpolation points, sorted in increasing order. yval:double[] All the y-coordinates of the interpolation points, sorted in increasing order. fval:double[][] The values of the interpolation points on all the grid knots: `fval[i][j] = f(xval[i], yval[j])`. Returns:BivariateFunction a function which interpolates the dataset. Exceptions NoDataException: if any of the arrays has zero length. DimensionMismatchException: if the array lengths are inconsistent. NonMonotonicSequenceException: if the array is not sorted. NumberIsTooSmallException: if the number of points is too small for the order of the interpolation

Compute an interpolating function for the dataset.

Parameters

xval:double[]: All the x-coordinates of the interpolation points, sorted in increasing order.
yval:double[]: All the y-coordinates of the interpolation points, sorted in increasing order.
fval:double[][]: The values of the interpolation points on all the grid knots: fval[i][j] = f(xval[i], yval[j]).

a function which interpolates the dataset.

Exceptions

NoDataException:: if any of the arrays has zero length.
DimensionMismatchException:: if the array lengths are inconsistent.
NonMonotonicSequenceException:: if the array is not sorted.
NumberIsTooSmallException:: if the number of points is too small for the order of the interpolation