Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc formatting and fixes. 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1385314 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Thomas Neidhart 2012-09-16 16:35:49 +00:00
parent be41bc2053
commit b694b79c60
1 changed files with 13 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/main/java/org/apache/commons/math3/analysis/interpolation/TricubicSplineInterpolatingFunction.java
View File

@ -123,25 +123,16 @@ public class TricubicSplineInterpolatingFunction
* @param y Sample values of the y-coordinate, in increasing order. * @param y Sample values of the y-coordinate, in increasing order.
* @param z Sample values of the y-coordinate, in increasing order. * @param z Sample values of the y-coordinate, in increasing order.
* @param f Values of the function on every grid point. * @param f Values of the function on every grid point.
* @param dFdX Values of the partial derivative of function with respect * @param dFdX Values of the partial derivative of function with respect to x on every grid point.
* to x on every grid point. * @param dFdY Values of the partial derivative of function with respect to y on every grid point.
* @param dFdY Values of the partial derivative of function with respect * @param dFdZ Values of the partial derivative of function with respect to z on every grid point.
* to y on every grid point. * @param d2FdXdY Values of the cross partial derivative of function on every grid point.
* @param dFdZ Values of the partial derivative of function with respect * @param d2FdXdZ Values of the cross partial derivative of function on every grid point.
* to z on every grid point. * @param d2FdYdZ Values of the cross partial derivative of function on every grid point.
* @param d2FdXdY Values of the cross partial derivative of function on * @param d3FdXdYdZ Values of the cross partial derivative of function on every grid point.
* every grid point.
* @param d2FdXdZ Values of the cross partial derivative of function on
* every grid point.
* @param d2FdYdZ Values of the cross partial derivative of function on
* every grid point.
* @param d3FdXdYdZ Values of the cross partial derivative of function on
* every grid point.
* @throws NoDataException if any of the arrays has zero length. * @throws NoDataException if any of the arrays has zero length.
* @throws DimensionMismatchException if the various arrays do not contain * @throws DimensionMismatchException if the various arrays do not contain the expected number of elements.
* the expected number of elements. * @throws NonMonotonicSequenceException if {@code x}, {@code y} or {@code z} are not strictly increasing.
* @throws Exception if {@code x}, {@code y} or {@code z}
* are not strictly increasing.
*/ */
public TricubicSplineInterpolatingFunction(double[] x, public TricubicSplineInterpolatingFunction(double[] x,
double[] y, double[] y,
@ -310,8 +301,7 @@ public class TricubicSplineInterpolatingFunction
/** /**
* {@inheritDoc} * {@inheritDoc}
* *
* @throws OutOfRangeException if any of the variables is outside its * @throws OutOfRangeException if any of the variables is outside its interpolation range.
* interpolation range.
*/ */
public double value(double x, double y, double z) public double value(double x, double y, double z)
throws OutOfRangeException { throws OutOfRangeException {
@ -338,9 +328,8 @@ public class TricubicSplineInterpolatingFunction
/** /**
* @param c Coordinate. * @param c Coordinate.
* @param val Coordinate samples. * @param val Coordinate samples.
* @return the index in {@code val} corresponding to the interval * @return the index in {@code val} corresponding to the interval containing {@code c}, or {@code -1}
* containing {@code c}, or {@code -1} if {@code c} is out of the * if {@code c} is out of the range defined by the end values of {@code val}.
* range defined by the end values of {@code val}.
*/ */
private int searchIndex(double c, double[] val) { private int searchIndex(double c, double[] val) {
if (c < val[0]) { if (c < val[0]) {
@ -402,8 +391,7 @@ public class TricubicSplineInterpolatingFunction
* where the subscripts indicate the partial derivative with respect to * where the subscripts indicate the partial derivative with respect to
* the corresponding variable(s). * the corresponding variable(s).
* *
* @param beta List of function values and function partial derivatives * @param beta List of function values and function partial derivatives values.
* values.
* @return the spline coefficients. * @return the spline coefficients.
*/ */
private double[] computeSplineCoefficients(double[] beta) { private double[] computeSplineCoefficients(double[] beta) {