Module org.apache.lucene.core
Package org.apache.lucene.document

Record Class NearestNeighbor.Cell

java.lang.Object
java.lang.Record
org.apache.lucene.document.NearestNeighbor.Cell
Record Components:
distanceSortKey - The closest distance from a point in this cell to the query point, computed as a sort key through SloppyMath.haversinSortKey(double, double, double, double). Note that this is an approximation to the closest distance, and there could be a point in the cell that is closer.
All Implemented Interfaces:
Comparable<NearestNeighbor.Cell>
Enclosing class:
NearestNeighbor
static record NearestNeighbor.Cell(PointValues.PointTree index, int readerIndex, byte[] minPacked, byte[] maxPacked, double distanceSortKey) extends Record implements Comparable<NearestNeighbor.Cell>

  • Field Details

    • index

      private final PointValues.PointTree index
      The field for the index record component.

    • readerIndex

      private final int readerIndex
      The field for the readerIndex record component.

    • minPacked

      private final byte[] minPacked
      The field for the minPacked record component.

    • maxPacked

      private final byte[] maxPacked
      The field for the maxPacked record component.

    • distanceSortKey

      private final double distanceSortKey
      The field for the distanceSortKey record component.

  • Constructor Details

    • Cell

      Cell(PointValues.PointTree index, int readerIndex, byte[] minPacked, byte[] maxPacked, double distanceSortKey)
      Creates an instance of a Cell record class.
      Parameters:
      index - the value for the index record component
      readerIndex - the value for the readerIndex record component
      minPacked - the value for the minPacked record component
      maxPacked - the value for the maxPacked record component
      distanceSortKey - the value for the distanceSortKey record component

  • Method Details

    • compareTo

      public int compareTo(NearestNeighbor.Cell other)
      Specified by:
      compareTo in interface Comparable<NearestNeighbor.Cell>

    • toString

      public String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • index

      public PointValues.PointTree index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • readerIndex

      public int readerIndex()
      Returns the value of the readerIndex record component.
      Returns:
      the value of the readerIndex record component

    • minPacked

      public byte[] minPacked()
      Returns the value of the minPacked record component.
      Returns:
      the value of the minPacked record component

    • maxPacked

      public byte[] maxPacked()
      Returns the value of the maxPacked record component.
      Returns:
      the value of the maxPacked record component

    • distanceSortKey

      public double distanceSortKey()
      Returns the value of the distanceSortKey record component.
      Returns:
      the value of the distanceSortKey record component