Class PiecewiseBicubicSplineInterpolatingFunction
java.lang.Object
org.apache.commons.math3.analysis.interpolation.PiecewiseBicubicSplineInterpolatingFunction
- All Implemented Interfaces:
BivariateFunction
public class PiecewiseBicubicSplineInterpolatingFunction
extends Object
implements BivariateFunction
Function that implements the
bicubic spline
interpolation.
This implementation currently uses
AkimaSplineInterpolator
as the
underlying one-dimensional interpolator, which requires 5 sample points;
insufficient data will raise an exception when the
value
method is called.- Since:
- 3.4
-
Constructor Summary
ConstructorsConstructorDescriptionPiecewiseBicubicSplineInterpolatingFunction
(double[] x, double[] y, double[][] f) -
Method Summary
Modifier and TypeMethodDescriptionboolean
isValidPoint
(double x, double y) Indicates whether a point is within the interpolation range.double
value
(double x, double y) Compute the value for the function.
-
Constructor Details
-
PiecewiseBicubicSplineInterpolatingFunction
public PiecewiseBicubicSplineInterpolatingFunction(double[] x, double[] y, double[][] f) throws DimensionMismatchException, NullArgumentException, NoDataException, NonMonotonicSequenceException - Parameters:
x
- Sample values of the x-coordinate, in increasing order.y
- Sample values of the y-coordinate, in increasing order.f
- Values of the function on every grid point. the expected number of elements.- Throws:
NonMonotonicSequenceException
- ifx
ory
are not strictly increasing.NullArgumentException
- if any of the arguments are nullNoDataException
- if any of the arrays has zero length.DimensionMismatchException
- if the length of x and y don't match the row, column height of f
-
-
Method Details
-
value
Compute the value for the function.- Specified by:
value
in interfaceBivariateFunction
- Parameters:
x
- Abscissa for which the function value should be computed.y
- Ordinate for which the function value should be computed.- Returns:
- the value.
- Throws:
OutOfRangeException
-
isValidPoint
public boolean isValidPoint(double x, double y) Indicates whether a point is within the interpolation range.- Parameters:
x
- First coordinate.y
- Second coordinate.- Returns:
true
if (x, y) is a valid point.- Since:
- 3.3
-