Module org.apache.lucene.backward_codecs
Package org.apache.lucene.backward_codecs.lucene92

Record Class Lucene92HnswVectorsReader.FieldEntry

java.lang.Object
java.lang.Record
org.apache.lucene.backward_codecs.lucene92.Lucene92HnswVectorsReader.FieldEntry
Enclosing class:
Lucene92HnswVectorsReader
static record Lucene92HnswVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final long
    addressesLength
    The field for the addressesLength record component.
    private final long
    addressesOffset
    The field for the addressesOffset record component.
    private final int
    blockShift
    The field for the blockShift record component.
    private final byte
    denseRankPower
    The field for the denseRankPower record component.
    private final int
    dimension
    The field for the dimension record component.
    private final long
    docsWithFieldLength
    The field for the docsWithFieldLength record component.
    private final long
    docsWithFieldOffset
    The field for the docsWithFieldOffset record component.
    private final long[]
    graphOffsetsByLevel
    The field for the graphOffsetsByLevel record component.
    private final short
    jumpTableEntryCount
    The field for the jumpTableEntryCount record component.
    private final int
    M
    The field for the M record component.
    private final DirectMonotonicReader.Meta
    meta
    The field for the meta record component.
    private final int[][]
    nodesByLevel
    The field for the nodesByLevel record component.
    private final int
    numLevels
    The field for the numLevels record component.
    private final VectorSimilarityFunction
    similarityFunction
    The field for the similarityFunction record component.
    private final int
    size
    The field for the size record component.
    private final long
    vectorDataLength
    The field for the vectorDataLength record component.
    private final long
    vectorDataOffset
    The field for the vectorDataOffset record component.
    private final long
    vectorIndexLength
    The field for the vectorIndexLength record component.
    private final long
    vectorIndexOffset
    The field for the vectorIndexOffset record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength)
    Creates an instance of a FieldEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    addressesLength()
    Returns the value of the addressesLength record component.
    long
    addressesOffset()
    Returns the value of the addressesOffset record component.
    int
    blockShift()
    Returns the value of the blockShift record component.
    (package private) static Lucene92HnswVectorsReader.FieldEntry
    create(IndexInput input, VectorSimilarityFunction similarityFunction)
     
    byte
    denseRankPower()
    Returns the value of the denseRankPower record component.
    int
    dimension()
    Returns the value of the dimension record component.
    long
    docsWithFieldLength()
    Returns the value of the docsWithFieldLength record component.
    long
    docsWithFieldOffset()
    Returns the value of the docsWithFieldOffset record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long[]
    graphOffsetsByLevel()
    Returns the value of the graphOffsetsByLevel record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    short
    jumpTableEntryCount()
    Returns the value of the jumpTableEntryCount record component.
    int
    M()
    Returns the value of the M record component.
    DirectMonotonicReader.Meta
    meta()
    Returns the value of the meta record component.
    int[][]
    nodesByLevel()
    Returns the value of the nodesByLevel record component.
    int
    numLevels()
    Returns the value of the numLevels record component.
    VectorSimilarityFunction
    similarityFunction()
    Returns the value of the similarityFunction record component.
    int
    size()
    Returns the value of the size record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    vectorDataLength()
    Returns the value of the vectorDataLength record component.
    long
    vectorDataOffset()
    Returns the value of the vectorDataOffset record component.
    long
    vectorIndexLength()
    Returns the value of the vectorIndexLength record component.
    long
    vectorIndexOffset()
    Returns the value of the vectorIndexOffset record component.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • similarityFunction

      private final VectorSimilarityFunction similarityFunction
      The field for the similarityFunction record component.

    • vectorDataOffset

      private final long vectorDataOffset
      The field for the vectorDataOffset record component.

    • vectorDataLength

      private final long vectorDataLength
      The field for the vectorDataLength record component.

    • vectorIndexOffset

      private final long vectorIndexOffset
      The field for the vectorIndexOffset record component.

    • vectorIndexLength

      private final long vectorIndexLength
      The field for the vectorIndexLength record component.

    • M

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

    • numLevels

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

    • dimension

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

    • size

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

    • nodesByLevel

      private final int[][] nodesByLevel
      The field for the nodesByLevel record component.

    • graphOffsetsByLevel

      private final long[] graphOffsetsByLevel
      The field for the graphOffsetsByLevel record component.

    • docsWithFieldOffset

      private final long docsWithFieldOffset
      The field for the docsWithFieldOffset record component.

    • docsWithFieldLength

      private final long docsWithFieldLength
      The field for the docsWithFieldLength record component.

    • jumpTableEntryCount

      private final short jumpTableEntryCount
      The field for the jumpTableEntryCount record component.

    • denseRankPower

      private final byte denseRankPower
      The field for the denseRankPower record component.

    • addressesOffset

      private final long addressesOffset
      The field for the addressesOffset record component.

    • blockShift

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

    • meta

      private final DirectMonotonicReader.Meta meta
      The field for the meta record component.

    • addressesLength

      private final long addressesLength
      The field for the addressesLength record component.

  • Constructor Details

    • FieldEntry

      FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength)
      Creates an instance of a FieldEntry record class.
      Parameters:
      similarityFunction - the value for the similarityFunction record component
      vectorDataOffset - the value for the vectorDataOffset record component
      vectorDataLength - the value for the vectorDataLength record component
      vectorIndexOffset - the value for the vectorIndexOffset record component
      vectorIndexLength - the value for the vectorIndexLength record component
      M - the value for the M record component
      numLevels - the value for the numLevels record component
      dimension - the value for the dimension record component
      size - the value for the size record component
      nodesByLevel - the value for the nodesByLevel record component
      graphOffsetsByLevel - the value for the graphOffsetsByLevel record component
      docsWithFieldOffset - the value for the docsWithFieldOffset record component
      docsWithFieldLength - the value for the docsWithFieldLength record component
      jumpTableEntryCount - the value for the jumpTableEntryCount record component
      denseRankPower - the value for the denseRankPower record component
      addressesOffset - the value for the addressesOffset record component
      blockShift - the value for the blockShift record component
      meta - the value for the meta record component
      addressesLength - the value for the addressesLength record component

  • Method Details

    • create

      static Lucene92HnswVectorsReader.FieldEntry create(IndexInput input, VectorSimilarityFunction similarityFunction) throws IOException
      Throws:
      IOException

    • 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. 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.

    • similarityFunction

      public VectorSimilarityFunction similarityFunction()
      Returns the value of the similarityFunction record component.
      Returns:
      the value of the similarityFunction record component

    • vectorDataOffset

      public long vectorDataOffset()
      Returns the value of the vectorDataOffset record component.
      Returns:
      the value of the vectorDataOffset record component

    • vectorDataLength

      public long vectorDataLength()
      Returns the value of the vectorDataLength record component.
      Returns:
      the value of the vectorDataLength record component

    • vectorIndexOffset

      public long vectorIndexOffset()
      Returns the value of the vectorIndexOffset record component.
      Returns:
      the value of the vectorIndexOffset record component

    • vectorIndexLength

      public long vectorIndexLength()
      Returns the value of the vectorIndexLength record component.
      Returns:
      the value of the vectorIndexLength record component

    • M

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

    • numLevels

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

    • dimension

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

    • size

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

    • nodesByLevel

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

    • graphOffsetsByLevel

      public long[] graphOffsetsByLevel()
      Returns the value of the graphOffsetsByLevel record component.
      Returns:
      the value of the graphOffsetsByLevel record component

    • docsWithFieldOffset

      public long docsWithFieldOffset()
      Returns the value of the docsWithFieldOffset record component.
      Returns:
      the value of the docsWithFieldOffset record component

    • docsWithFieldLength

      public long docsWithFieldLength()
      Returns the value of the docsWithFieldLength record component.
      Returns:
      the value of the docsWithFieldLength record component

    • jumpTableEntryCount

      public short jumpTableEntryCount()
      Returns the value of the jumpTableEntryCount record component.
      Returns:
      the value of the jumpTableEntryCount record component

    • denseRankPower

      public byte denseRankPower()
      Returns the value of the denseRankPower record component.
      Returns:
      the value of the denseRankPower record component

    • addressesOffset

      public long addressesOffset()
      Returns the value of the addressesOffset record component.
      Returns:
      the value of the addressesOffset record component

    • blockShift

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

    • meta

      public DirectMonotonicReader.Meta meta()
      Returns the value of the meta record component.
      Returns:
      the value of the meta record component

    • addressesLength

      public long addressesLength()
      Returns the value of the addressesLength record component.
      Returns:
      the value of the addressesLength record component