@cesium/engine/Source/Core/InterpolationAlgorithm.js

CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.

// @ts-check

import DeveloperError from "./DeveloperError.js";

/**
 * The interface for interpolation algorithms.
 *
 * @interface
 *
 * @see LagrangePolynomialApproximation
 * @see LinearApproximation
 * @see HermitePolynomialApproximation
 */
class InterpolationAlgorithm {
  /**
   * Gets the name of this interpolation algorithm.
   * @type {string}
   */
  type;

  /**
   * Given the desired degree, returns the number of data points required for interpolation.
   *
   * @function
   * @param {number} degree The desired degree of interpolation.
   * @returns {number} The number of required data points needed for the desired degree of interpolation.
   */
  getRequiredDataPoints(degree) {
    DeveloperError.throwInstantiationError();
  }

  /**
   * Performs zero order interpolation.
   *
   * @function
   * @param {number} x The independent variable for which the dependent variables will be interpolated.
   * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
   * in this array must be in increasing order and the same value must not occur twice in the array.
   * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
   * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
   * @param {number} yStride The number of dependent variable values in yTable corresponding to
   * each independent variable value in xTable.
   * @param {number[]} [result] An existing array into which to store the result.
   * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
   */
  interpolateOrderZero(x, xTable, yTable, yStride, result) {
    DeveloperError.throwInstantiationError();
  }

  /**
   * Performs higher order interpolation.  Not all interpolators need to support high-order interpolation,
   * if this function remains undefined on implementing objects, interpolateOrderZero will be used instead.
   *
   * @function
   * @param {number} x The independent variable for which the dependent variables will be interpolated.
   * @param {number[]} xTable The array of independent variables to use to interpolate.  The values
   * in this array must be in increasing order and the same value must not occur twice in the array.
   * @param {number[]} yTable The array of dependent variables to use to interpolate.  For a set of three
   * dependent values (p,q,w) at time 1 and time 2 this should be as follows: {p1, q1, w1, p2, q2, w2}.
   * @param {number} yStride The number of dependent variable values in yTable corresponding to
   * each independent variable value in xTable.
   * @param {number} inputOrder The number of derivatives supplied for input.
   * @param {number} outputOrder The number of derivatives desired for output.
   * @param {number[]} [result] An existing array into which to store the result.
   * @returns {number[]} The array of interpolated values, or the result parameter if one was provided.
   */
  interpolate(x, xTable, yTable, yStride, inputOrder, outputOrder, result) {
    DeveloperError.throwInstantiationError();
  }
}

export default InterpolationAlgorithm;