Top Description Constructors Methods
org.apache.commons.math3.analysis.interpolation

public Class TricubicInterpolator

extends Object
implements TrivariateGridInterpolator
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.analysis.interpolation.TrivariateGridInterpolator
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .NoDataException, .NonMonotonicSequenceException, .NumberIsTooSmallException, org.apache.commons.math3.util.MathArrays

Generates a tricubic interpolating function.
Since
3.4

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public TricubicInterpolatingFunction
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.

Compute an interpolating function for the dataset.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

TricubicInterpolatorback to summary
public TricubicInterpolator()

Method Detail

interpolateback to summary
public TricubicInterpolatingFunction 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.

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:TricubicInterpolatingFunction

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