Interface PointDistanceFunction

public interface PointDistanceFunction

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distance2D(double deltaX, double deltaY)
    Calculate a representation of distance based on the deltas between two points in 2D space.
    default double
    distance2D(int seed, int cellX, int cellY, double cellCentreX, double cellCentreY, double deltaX, double deltaY)
    Calculate a representation of distance based on the deltas between an arbitrary point and a cell-centre point in 2D space.
    double
    distance3D(double deltaX, double deltaY, double deltaZ)
    Calculate a representation of distance based on the deltas between two points in 3D space.
    default double
    distance3D(int seed, int cellX, int cellY, int cellZ, double cellCentreX, double cellCentreY, double cellCentreZ, double deltaX, double deltaY, double deltaZ)
    Calculate a representation of distance based on the deltas between an arbitrary point and a cell-centre point in 3D space.

  • Method Details

    • distance2D

      double distance2D(double deltaX, double deltaY)
      Calculate a representation of distance based on the deltas between two points in 2D space.
      Parameters:
      deltaX - The x-delta between two points.
      deltaY - The y-delta between two points.
      Returns:
      The distance representation for the given deltas.

    • distance3D

      double distance3D(double deltaX, double deltaY, double deltaZ)
      Calculate a representation of distance based on the deltas between two points in 3D space.
      Parameters:
      deltaX - The x-delta between two points.
      deltaY - The y-delta between two points.
      deltaZ - The z-delta between two points.
      Returns:
      The distance representation for the given deltas.

    • distance2D

      default double distance2D(int seed, int cellX, int cellY, double cellCentreX, double cellCentreY, double deltaX, double deltaY)
      Calculate a representation of distance based on the deltas between an arbitrary point and a cell-centre point in 2D space.
      Parameters:
      seed - The seed used to calculate the cell centre-point.
      cellX - The x-index of the cell.
      cellY - The y-index of the cell.
      cellCentreX - The x-coordinate of the cell centre-point.
      cellCentreY - The y-coordinate of the cell centre-point.
      deltaX - The x-delta between the arbitrary point and cell centre-point.
      deltaY - The y-delta between the arbitrary point and cell centre-point.
      Returns:
      The distance representation for the given deltas.

    • distance3D

      default double distance3D(int seed, int cellX, int cellY, int cellZ, double cellCentreX, double cellCentreY, double cellCentreZ, double deltaX, double deltaY, double deltaZ)
      Calculate a representation of distance based on the deltas between an arbitrary point and a cell-centre point in 3D space.
      Parameters:
      seed - The seed used to calculate the cell centre-point.
      cellX - The x-index of the cell.
      cellY - The y-index of the cell.
      cellZ - The z-index of the cell.
      cellCentreX - The x-coordinate of the cell centre-point.
      cellCentreY - The y-coordinate of the cell centre-point.
      cellCentreZ - The z-coordinate of the cell centre-point.
      deltaX - The x-delta between the arbitrary point and cell centre-point.
      deltaY - The y-delta between the arbitrary point and cell centre-point.
      deltaZ - The z-delta between the arbitrary point and cell centre-point.
      Returns:
      The distance representation for the given deltas.