com.opengamma.strata.math.impl.interpolation

Class ClampedPiecewisePolynomialInterpolator

java.lang.Object

com.opengamma.strata.math.impl.interpolation.PiecewisePolynomialInterpolator

com.opengamma.strata.math.impl.interpolation.ClampedPiecewisePolynomialInterpolator

public class ClampedPiecewisePolynomialInterpolator
extends PiecewisePolynomialInterpolator

Piecewise polynomial interpolator clamped at specified points.

The clamped points are regarded as 'normal' data points in the interpolation result, i.e., PiecewisePolynomialResult or PiecewisePolynomialResultsWithSensitivity. A consequence of this is, for example, that the coefficient sensitivities involve the sensitivities to clamped points.

Constructor Summary

Constructors

Constructor and Description
ClampedPiecewisePolynomialInterpolator(PiecewisePolynomialInterpolator baseMethod, double[] xValuesClamped, double[] yValuesClamped) Construct the interpolator with clamped points.

Method Summary

Modifier and Type	Method and Description
PiecewisePolynomialInterpolator	getPrimaryMethod() Hyman filter modifies derivative values at knot points which are initially computed by a "primary" interpolator.
PiecewisePolynomialResult	interpolate(double[] xValues, double[] yValues) Interpolate.
PiecewisePolynomialResult	interpolate(double[] xValues, double[][] yValuesMatrix) Interpolate.
PiecewisePolynomialResultsWithSensitivity	interpolateWithSensitivity(double[] xValues, double[] yValues) Derive interpolant on {xValues_i, yValues_i} and (yValues) node sensitivity.

Methods inherited from class com.opengamma.strata.math.impl.interpolation.PiecewisePolynomialInterpolator

getValue, getValue, interpolate, interpolate, interpolate, interpolate, interpolate, interpolate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClampedPiecewisePolynomialInterpolator

public ClampedPiecewisePolynomialInterpolator(PiecewisePolynomialInterpolator baseMethod,
                                              double[] xValuesClamped,
                                              double[] yValuesClamped)

Construct the interpolator with clamped points.

Parameters:

baseMethod - The base interpolator must be not be itself

xValuesClamped - X values of the clamped points

yValuesClamped - Y values of the clamped points

Method Detail

interpolate

public PiecewisePolynomialResult interpolate(double[] xValues,
                                             double[] yValues)

Description copied from class: PiecewisePolynomialInterpolator

Interpolate.

Specified by:

interpolate in class PiecewisePolynomialInterpolator

Parameters:

xValues - X values of data

yValues - Y values of data

Returns:

PiecewisePolynomialResult containing knots, coefficients of piecewise polynomials, number of intervals, degree of polynomials, dimension of spline

interpolate

public PiecewisePolynomialResult interpolate(double[] xValues,
                                             double[][] yValuesMatrix)

Description copied from class: PiecewisePolynomialInterpolator

Interpolate.

Specified by:

interpolate in class PiecewisePolynomialInterpolator

Parameters:

xValues - X values of data

yValuesMatrix - Y values of data

Returns:

Coefficient matrix whose i-th row vector is {a_n, a_{n-1}, ... } of f(x) = a_n * (x-x_i)^n + a_{n-1} * (x-x_i)^{n-1} +... for the i-th interval

interpolateWithSensitivity

public PiecewisePolynomialResultsWithSensitivity interpolateWithSensitivity(double[] xValues,
                                                                            double[] yValues)

Description copied from class: PiecewisePolynomialInterpolator

Derive interpolant on {xValues_i, yValues_i} and (yValues) node sensitivity.

Specified by:

interpolateWithSensitivity in class PiecewisePolynomialInterpolator

Parameters:

xValues - X values of data

yValues - Y values of data

Returns:

PiecewisePolynomialResultsWithSensitivity

getPrimaryMethod

public PiecewisePolynomialInterpolator getPrimaryMethod()

Description copied from class: PiecewisePolynomialInterpolator

Hyman filter modifies derivative values at knot points which are initially computed by a "primary" interpolator.

Overrides:

getPrimaryMethod in class PiecewisePolynomialInterpolator

Returns:

The primary interpolator for Hyman filter, interpolation method itself for other interpolators