Package org.apache.commons.math4.legacy.analysis.interpolation

Class TricubicInterpolator

java.lang.Object

org.apache.commons.math4.legacy.analysis.interpolation.TricubicInterpolator

All Implemented Interfaces:

TrivariateGridInterpolator

public class TricubicInterpolator
extends Object
implements TrivariateGridInterpolator

Generates a tricubic interpolating function.

Since:

3.4

Constructor Summary

Constructors

Constructor	Description
TricubicInterpolator()

Method Summary

Modifier and Type	Method	Description
TricubicInterpolatingFunction	interpolate(double[] xval, double[] yval, double[] zval, 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 Detail

TricubicInterpolator

public TricubicInterpolator()

Method Detail

interpolate

public TricubicInterpolatingFunction interpolate(double[] xval,
                                                 double[] yval,
                                                 double[] zval,
                                                 double[][][] fval)
                                          throws NoDataException,
                                                 NumberIsTooSmallException,
                                                 DimensionMismatchException,
                                                 NonMonotonicSequenceException

Compute an interpolating function for the dataset.

Specified by:

interpolate in interface TrivariateGridInterpolator

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.

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

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

Returns:

a function that interpolates the data set.

Throws:

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