Module org.apache.lucene.backward_codecs
Package org.apache.lucene.backward_codecs.lucene95

Record Class Lucene95HnswVectorsReader.FieldEntry

java.lang.Object
java.lang.Record
org.apache.lucene.backward_codecs.lucene95.Lucene95HnswVectorsReader.FieldEntry
Enclosing class:
Lucene95HnswVectorsReader
static record Lucene95HnswVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength, OrdToDocDISIReaderConfiguration ordToDocVectorValues) extends Record

  • Field Details

    • similarityFunction

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

    • vectorEncoding

      private final VectorEncoding vectorEncoding
      The field for the vectorEncoding 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.

    • offsetsMeta

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

    • offsetsOffset

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

    • offsetsBlockShift

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

    • offsetsLength

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

    • ordToDocVectorValues

      private final OrdToDocDISIReaderConfiguration ordToDocVectorValues
      The field for the ordToDocVectorValues record component.

  • Constructor Details

    • FieldEntry

      FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, DirectMonotonicReader.Meta offsetsMeta, long offsetsOffset, int offsetsBlockShift, long offsetsLength, OrdToDocDISIReaderConfiguration ordToDocVectorValues)
      Creates an instance of a FieldEntry record class.
      Parameters:
      similarityFunction - the value for the similarityFunction record component
      vectorEncoding - the value for the vectorEncoding 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
      offsetsMeta - the value for the offsetsMeta record component
      offsetsOffset - the value for the offsetsOffset record component
      offsetsBlockShift - the value for the offsetsBlockShift record component
      offsetsLength - the value for the offsetsLength record component
      ordToDocVectorValues - the value for the ordToDocVectorValues record component

  • Method Details

    • create

      static Lucene95HnswVectorsReader.FieldEntry create(IndexInput input, VectorEncoding vectorEncoding, 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

    • vectorEncoding

      public VectorEncoding vectorEncoding()
      Returns the value of the vectorEncoding record component.
      Returns:
      the value of the vectorEncoding 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

    • offsetsMeta

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

    • offsetsOffset

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

    • offsetsBlockShift

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

    • offsetsLength

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

    • ordToDocVectorValues

      public OrdToDocDISIReaderConfiguration ordToDocVectorValues()
      Returns the value of the ordToDocVectorValues record component.
      Returns:
      the value of the ordToDocVectorValues record component