Package org.apache.lucene.index

Record Class ReaderUtil.PartitionedHits

java.lang.Object
java.lang.Record
org.apache.lucene.index.ReaderUtil.PartitionedHits
Record Components:
docIdsByLeaf - per-leaf sorted global doc IDs; docIdsByLeaf[k] holds the doc IDs that fall in leaf k (empty if none)
ordinalsByLeaf - per-leaf original input positions; ordinalsByLeaf[k][i] is the index in the original input array of the doc ID at docIdsByLeaf[k][i]
Enclosing class:
ReaderUtil
public static record ReaderUtil.PartitionedHits(int[][] docIdsByLeaf, int[][] ordinalsByLeaf) extends Record
Result of partitioning doc IDs by leaf, including the original input ordinals for scatter/gather. docIdsByLeaf[k] holds the sorted global doc IDs that fall in leaf k, and ordinalsByLeaf[k][i] is the index in the original globalDocIds input array of the doc ID at docIdsByLeaf[k][i].

Both arrays have the same shape: ordinalsByLeaf[k].length == docIdsByLeaf[k].length for every leaf k.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PartitionedHits(int[][] docIdsByLeaf, int[][] ordinalsByLeaf)
    Creates an instance of a PartitionedHits record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int[][]
    docIdsByLeaf()
    Returns the value of the docIdsByLeaf record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int[][]
    ordinalsByLeaf()
    Returns the value of the ordinalsByLeaf record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PartitionedHits

      public PartitionedHits(int[][] docIdsByLeaf, int[][] ordinalsByLeaf)
      Creates an instance of a PartitionedHits record class.
      Parameters:
      docIdsByLeaf - the value for the docIdsByLeaf record component
      ordinalsByLeaf - the value for the ordinalsByLeaf record component

  • Method Details

    • toString

      public final 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • docIdsByLeaf

      public int[][] docIdsByLeaf()
      Returns the value of the docIdsByLeaf record component.
      Returns:
      the value of the docIdsByLeaf record component

    • ordinalsByLeaf

      public int[][] ordinalsByLeaf()
      Returns the value of the ordinalsByLeaf record component.
      Returns:
      the value of the ordinalsByLeaf record component