Apache Commons Math 3.6.1 · org.apache.commons.math3.analysis.interpolation.TricubicSplineInterpolator

Access	Constructor and Description
public	TricubicSplineInterpolator()

Method Summary

Modifier and Type	Method and Description
public TricubicSplineInterpolatingFunction	interpolate(final double[] All the x-coordinates of the interpolation points, sorted in increasing order. xval, final double[] All the y-coordinates of the interpolation points, sorted in increasing order. yval, final double[] All the z-coordinates of the interpolation points, sorted in increasing order. zval, final double[][][] the values of the interpolation points on all the grid knots: `fval[i][j][k] = f(xval[i], yval[j], zval[k])`. fval) Implements org.apache.commons.math3.analysis.interpolation.TrivariateGridInterpolator.interpolate. Deprecated as a consequence of `TricubicSplineInterpolatingFunction` being deprecated. Compute an interpolating function for the dataset.
private int	Returns: the next index nextIndex(int Index i, int Upper limit of the array max) Compute the next index of an array, clipping if necessary.
private int	Returns: the previous index previousIndex(int Index i) Compute the previous index of an array, clipping if necessary.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

TricubicSplineInterpolator	back to summary
public TricubicSplineInterpolator()

interpolate back to summary

interpolate	back to summary
public TricubicSplineInterpolatingFunction interpolate(final double[] xval, final double[] yval, final double[] zval, final double[][][] fval) throws NoDataException, NumberIsTooSmallException, DimensionMismatchException, NonMonotonicSequenceException Implements org.apache.commons.math3.analysis.interpolation.TrivariateGridInterpolator.interpolate. Doc from org.apache.commons.math3.analysis.interpolation.TrivariateGridInterpolator.interpolate. Deprecated as a consequence of `TricubicSplineInterpolatingFunction` being deprecated. See corresponding docs for further information. 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. zval:double[] All the z-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][k] = f(xval[i], yval[j], zval[k])`. Returns:TricubicSplineInterpolatingFunction a function that interpolates the data set. Exceptions NoDataException: if any of the arrays has zero length. NumberIsTooSmallException: if the number of points is too small for the order of the interpolation DimensionMismatchException: if the array lengths are inconsistent. NonMonotonicSequenceException: if arrays are not sorted

Deprecated

as a consequence of TricubicSplineInterpolatingFunction being deprecated. See corresponding docs for further information.

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.
zval:double[]: All the z-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][k] = f(xval[i], yval[j], zval[k]).

a function that interpolates the data set.

Exceptions

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

nextIndex back to summary

nextIndex	back to summary
private int nextIndex(int i, int max) Compute the next index of an array, clipping if necessary. It is assumed (but not checked) that `i` is larger than or equal to 0. Parameters i:int Index max:int Upper limit of the array Returns:int the next index

private int nextIndex(int i, int max)

Compute the next index of an array, clipping if necessary. It is assumed (but not checked) that i is larger than or equal to 0.

Parameters

Returns:int

the next index

previousIndex back to summary

previousIndex	back to summary
private int previousIndex(int i) Compute the previous index of an array, clipping if necessary. It is assumed (but not checked) that `i` is smaller than the size of the array. Parameters i:int Index Returns:int the previous index

private int previousIndex(int i)

Compute the previous index of an array, clipping if necessary. It is assumed (but not checked) that i is smaller than the size of the array.

Parameters

Returns:int

the previous index