com.opengamma.strata.market.cube.interpolator

Interface BoundCubeInterpolator

public interface BoundCubeInterpolator

A cube interpolator that has been bound to a specific cube.

A bound interpolator is created from a CubeInterpolator. The bind process takes the definition of the interpolator and combines it with the x-y-z-w values. This allows implementations to optimize interpolation calculations.

Method Summary

Modifier and Type	Method and Description
ValueDerivatives	firstPartialDerivatives(double x, double y, double z) Computes the partial derivatives of the cube.
double	interpolate(double x, double y, double z) Computes the w-value for the specified x-y-z value by interpolation.
DoubleArray	parameterSensitivity(double x, double y, double z) Computes the sensitivity of the x-y-z-value with respect to the cube parameters.

Method Detail

interpolate

double interpolate(double x,
                   double y,
                   double z)

Computes the w-value for the specified x-y-z value by interpolation.

Parameters:

x - the x-value to find the w-value for

y - the y-value to find the w-value for

z - the z-value to find the w-value for

Returns:

the value at the x-y-value

Throws:

RuntimeException - if the z-value cannot be calculated

firstPartialDerivatives

ValueDerivatives firstPartialDerivatives(double x,
                                         double y,
                                         double z)

Computes the partial derivatives of the cube.

The first derivatives are dw/dx, dw/dy, dw/dz. The derivatives are in the following order:

• [0] derivative with respect to x
• [1] derivative with respect to y
• [2] derivative with respect to z

Parameters:

x - the x-value at which the partial derivative is taken

y - the y-value at which the partial derivative is taken

z - the z-value at which the partial derivative is taken

Returns:

the w-value and it's partial first derivatives

Throws:

RuntimeException - if the derivative cannot be calculated

parameterSensitivity

DoubleArray parameterSensitivity(double x,
                                 double y,
                                 double z)

Computes the sensitivity of the x-y-z-value with respect to the cube parameters.

This returns an array with one element for each parameter of the cube. The array contains the sensitivity of the w-value at the specified x-y-z-value to each parameter.

Parameters:

x - the x-value at which the parameter sensitivity is computed

y - the y-value at which the parameter sensitivity is computed

z - the z-value at which the parameter sensitivity is computed

Returns:

the sensitivity

Throws:

RuntimeException - if the sensitivity cannot be calculated