Class FieldTrilinearInterpolatingFunction<T extends CalculusFieldElement<T>>

java.lang.Object
org.hipparchus.analysis.interpolation.FieldTrilinearInterpolatingFunction<T>
Type Parameters:
T - Type of the field elements.
All Implemented Interfaces:
CalculusFieldTrivariateFunction<T>

public class FieldTrilinearInterpolatingFunction<T extends CalculusFieldElement<T>> extends Object implements CalculusFieldTrivariateFunction<T>
Interpolate grid data using tri-linear interpolation.

This interpolator is thread-safe.

Since:
4.1
  • Constructor Details

    • FieldTrilinearInterpolatingFunction

      public FieldTrilinearInterpolatingFunction(T[] xVal, T[] yVal, T[] zVal, T[][][] fVal) throws MathIllegalArgumentException
      Simple constructor.
      Parameters:
      xVal - All the x-coordinates of the interpolation points, sorted in increasing order.
      yVal - All the y-coordinates of the interpolation points, sorted in increasing order.
      zVal - All the z-coordinates of the interpolation points, sorted in increasing order.
      fVal - The values of the interpolation points on all the grid knots: fVal[i][j][k] = f(xVal[i], yVal[j], zVal[k]).
      Throws:
      MathIllegalArgumentException - if grid size is smaller than 2 or if the grid is not sorted in strict increasing order
  • Method Details

    • getXInf

      public T getXInf()
      Get the lowest grid x coordinate.
      Returns:
      lowest grid x coordinate
    • getXSup

      public T getXSup()
      Get the highest grid x coordinate.
      Returns:
      highest grid x coordinate
    • getYInf

      public T getYInf()
      Get the lowest grid y coordinate.
      Returns:
      lowest grid y coordinate
    • getYSup

      public T getYSup()
      Get the highest grid y coordinate.
      Returns:
      highest grid y coordinate
    • getZInf

      public T getZInf()
      Get the lowest grid z coordinate.
      Returns:
      lowest grid z coordinate
    • getZSup

      public T getZSup()
      Get the highest grid z coordinate.
      Returns:
      highest grid z coordinate
    • value

      public T value(T x, T y, T z)
      Compute the value for the function.
      Specified by:
      value in interface CalculusFieldTrivariateFunction<T extends CalculusFieldElement<T>>
      Parameters:
      x - x-coordinate of the interpolation point.
      y - y-coordinate of the interpolation point.
      z - z-coordinate of the interpolation point.
      Returns:
      the value.