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

Modifier and Type	Field and Description
private static final double[][]	AINV Matrix to compute the spline coefficients from the function values and function derivatives values
private final TricubicFunction[][][]	splines Set of cubic splines patching the whole data grid
private final double[]	xval Samples x-coordinates
private final double[]	yval Samples y-coordinates
private final double[]	zval Samples z-coordinates

Constructor Summary

Access	Constructor and Description
public	TricubicInterpolatingFunction(double[] Sample values of the x-coordinate, in increasing order. x, double[] Sample values of the y-coordinate, in increasing order. y, double[] Sample values of the y-coordinate, in increasing order. z, double[][][] Values of the function on every grid point. f, double[][][] Values of the partial derivative of function with respect to x on every grid point. dFdX, double[][][] Values of the partial derivative of function with respect to y on every grid point. dFdY, double[][][] Values of the partial derivative of function with respect to z on every grid point. dFdZ, double[][][] Values of the cross partial derivative of function on every grid point. d2FdXdY, double[][][] Values of the cross partial derivative of function on every grid point. d2FdXdZ, double[][][] Values of the cross partial derivative of function on every grid point. d2FdYdZ, double[][][] Values of the cross partial derivative of function on every grid point. d3FdXdYdZ)

Access

Constructor and Description

public

TricubicInterpolatingFunction(double[]

Sample values of the x-coordinate, in increasing order.

x, double[]

Sample values of the y-coordinate, in increasing order.

y, double[]

Sample values of the y-coordinate, in increasing order.

z, double[][][]

Values of the function on every grid point.

f, double[][][]

Values of the partial derivative of function with respect to x on every grid point.

dFdX, double[][][]

Values of the partial derivative of function with respect to y on every grid point.

dFdY, double[][][]

Values of the partial derivative of function with respect to z on every grid point.

dFdZ, double[][][]

Values of the cross partial derivative of function on every grid point.

d2FdXdY, double[][][]

Values of the cross partial derivative of function on every grid point.

d2FdXdZ, double[][][]

Values of the cross partial derivative of function on every grid point.

d2FdYdZ, double[][][]

Values of the cross partial derivative of function on every grid point.

d3FdXdYdZ)

Method Summary

Modifier and Type	Method and Description
private double[]	Returns: the spline coefficients. computeCoefficients(double[] List of function values and function partial derivatives values. beta) Compute the spline coefficients from the list of function values and function partial derivatives values at the four corners of a grid element.
public boolean	Returns: `true` if (x, y, z) is a valid point. isValidPoint(double First coordinate. x, double Second coordinate. y, double Third coordinate. z) Indicates whether a point is within the interpolation range.
private int	Returns: the index in `val` corresponding to the interval containing `c`, or `-1` if `c` is out of the range defined by the end values of `val`. searchIndex(double Coordinate. c, double[] Coordinate samples. val)
public double	value(double x-coordinate for which the function value should be computed. x, double y-coordinate for which the function value should be computed. y, double z-coordinate for which the function value should be computed. z) Implements org.apache.commons.math3.analysis.TrivariateFunction.value. Compute the value for the function.

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

Field Detail

AINV	back to summary
private static final double[][] AINV Matrix to compute the spline coefficients from the function values and function derivatives values

splines	back to summary
private final TricubicFunction[][][] splines Set of cubic splines patching the whole data grid

xval	back to summary
private final double[] xval Samples x-coordinates

yval	back to summary
private final double[] yval Samples y-coordinates

zval	back to summary
private final double[] zval Samples z-coordinates

Constructor Detail

TricubicInterpolatingFunction back to summary

TricubicInterpolatingFunction	back to summary
public TricubicInterpolatingFunction(double[] x, double[] y, double[] z, double[][][] f, double[][][] dFdX, double[][][] dFdY, double[][][] dFdZ, double[][][] d2FdXdY, double[][][] d2FdXdZ, double[][][] d2FdYdZ, double[][][] d3FdXdYdZ) throws NoDataException, DimensionMismatchException, NonMonotonicSequenceException Parameters x:double[] Sample values of the x-coordinate, in increasing order. y:double[] Sample values of the y-coordinate, in increasing order. z:double[] Sample values of the y-coordinate, in increasing order. f:double[][][] Values of the function on every grid point. dFdX:double[][][] Values of the partial derivative of function with respect to x on every grid point. dFdY:double[][][] Values of the partial derivative of function with respect to y on every grid point. dFdZ:double[][][] Values of the partial derivative of function with respect to z on every grid point. d2FdXdY:double[][][] Values of the cross partial derivative of function on every grid point. d2FdXdZ:double[][][] Values of the cross partial derivative of function on every grid point. d2FdYdZ:double[][][] Values of the cross partial derivative of function on every grid point. d3FdXdYdZ:double[][][] Values of the cross partial derivative of function on every grid point. Exceptions NoDataException: if any of the arrays has zero length. DimensionMismatchException: if the various arrays do not contain the expected number of elements. NonMonotonicSequenceException: if `x`, `y` or `z` are not strictly increasing.

public TricubicInterpolatingFunction(double[] x, double[] y, double[] z, double[][][] f, double[][][] dFdX, double[][][] dFdY, double[][][] dFdZ, double[][][] d2FdXdY, double[][][] d2FdXdZ, double[][][] d2FdYdZ, double[][][] d3FdXdYdZ) throws NoDataException, DimensionMismatchException, NonMonotonicSequenceException

Parameters

x:double[]: Sample values of the x-coordinate, in increasing order.
y:double[]: Sample values of the y-coordinate, in increasing order.
z:double[]: Sample values of the y-coordinate, in increasing order.
f:double[][][]: Values of the function on every grid point.
dFdX:double[][][]: Values of the partial derivative of function with respect to x on every grid point.
dFdY:double[][][]: Values of the partial derivative of function with respect to y on every grid point.
dFdZ:double[][][]: Values of the partial derivative of function with respect to z on every grid point.
d2FdXdY:double[][][]: Values of the cross partial derivative of function on every grid point.
d2FdXdZ:double[][][]: Values of the cross partial derivative of function on every grid point.
d2FdYdZ:double[][][]: Values of the cross partial derivative of function on every grid point.
d3FdXdYdZ:double[][][]: Values of the cross partial derivative of function on every grid point.

Exceptions

NoDataException:: if any of the arrays has zero length.
DimensionMismatchException:: if the various arrays do not contain the expected number of elements.
NonMonotonicSequenceException:: if x, y or z are not strictly increasing.

Method Detail

computeCoefficients	back to summary
private double[] computeCoefficients(double[] beta) Compute the spline coefficients from the list of function values and function partial derivatives values at the four corners of a grid element. They must be specified in the following order: f(0,0,0) f(1,0,0) f(0,1,0) f(1,1,0) f(0,0,1) f(1,0,1) f(0,1,1) f(1,1,1) f_x(0,0,0) ... (same order as above) f_x(1,1,1) f_y(0,0,0) ... (same order as above) f_y(1,1,1) f_z(0,0,0) ... (same order as above) f_z(1,1,1) f_xy(0,0,0) ... (same order as above) f_xy(1,1,1) f_xz(0,0,0) ... (same order as above) f_xz(1,1,1) f_yz(0,0,0) ... (same order as above) f_yz(1,1,1) f_xyz(0,0,0) ... (same order as above) f_xyz(1,1,1) where the subscripts indicate the partial derivative with respect to the corresponding variable(s). Parameters beta:double[] List of function values and function partial derivatives values. Returns:double[] the spline coefficients.

computeCoefficients

back to summary

private double[] computeCoefficients(double[] beta)

Compute the spline coefficients from the list of function values and function partial derivatives values at the four corners of a grid element. They must be specified in the following order:

f(0,0,0)
f(1,0,0)
f(0,1,0)
f(1,1,0)
f(0,0,1)
f(1,0,1)
f(0,1,1)
f(1,1,1)
f_x(0,0,0)
... (same order as above)
f_x(1,1,1)
f_y(0,0,0)
... (same order as above)
f_y(1,1,1)
f_z(0,0,0)
... (same order as above)
f_z(1,1,1)
f_xy(0,0,0)
... (same order as above)
f_xy(1,1,1)
f_xz(0,0,0)
... (same order as above)
f_xz(1,1,1)
f_yz(0,0,0)
... (same order as above)
f_yz(1,1,1)
f_xyz(0,0,0)
... (same order as above)
f_xyz(1,1,1)

where the subscripts indicate the partial derivative with respect to the corresponding variable(s).

Parameters

beta:double[]: List of function values and function partial derivatives values.

Returns:double[]

the spline coefficients.

isValidPoint back to summary

isValidPoint	back to summary
public boolean isValidPoint(double x, double y, double z) Indicates whether a point is within the interpolation range. Parameters x:double First coordinate. y:double Second coordinate. z:double Third coordinate. Returns:boolean `true` if (x, y, z) is a valid point.

public boolean isValidPoint(double x, double y, double z)

Indicates whether a point is within the interpolation range.

Parameters

x:double: First coordinate.
y:double: Second coordinate.
z:double: Third coordinate.

Returns:boolean

true if (x, y, z) is a valid point.

searchIndex	back to summary
private int searchIndex(double c, double[] val) Parameters c:double Coordinate. val:double[] Coordinate samples. Returns:int the index in `val` corresponding to the interval containing `c`, or `-1` if `c` is out of the range defined by the end values of `val`.

value	back to summary
public double value(double x, double y, double z) throws OutOfRangeException Implements org.apache.commons.math3.analysis.TrivariateFunction.value. Doc from org.apache.commons.math3.analysis.TrivariateFunction.value. Compute the value for the function. Parameters x:double x-coordinate for which the function value should be computed. y:double y-coordinate for which the function value should be computed. z:double z-coordinate for which the function value should be computed. Returns:double the value. Exceptions OutOfRangeException: if any of the variables is outside its interpolation range.

value

back to summary

public double value(double x, double y, double z) throws OutOfRangeException

Implements org.apache.commons.math3.analysis.TrivariateFunction.value.

Doc from org.apache.commons.math3.analysis.TrivariateFunction.value.

Compute the value for the function.

Parameters

x:double: x-coordinate for which the function value should be computed.
y:double: y-coordinate for which the function value should be computed.
z:double: z-coordinate for which the function value should be computed.

Returns:double

the value.

Exceptions

OutOfRangeException:: if any of the variables is outside its interpolation range.

public Class TricubicInterpolatingFunction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail