Module org.apache.lucene.core
Package org.apache.lucene.codecs.lucene99

Record Class Lucene99ScalarQuantizedVectorsReader.FieldEntry

java.lang.Object
java.lang.Record
org.apache.lucene.codecs.lucene99.Lucene99ScalarQuantizedVectorsReader.FieldEntry
Enclosing class:
Lucene99ScalarQuantizedVectorsReader
private static record Lucene99ScalarQuantizedVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, ScalarQuantizer scalarQuantizer, int size, byte bits, boolean compress, OrdToDocDISIReaderConfiguration ordToDoc) 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.

    • dimension

      private final int dimension
      The field for the dimension 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.

    • scalarQuantizer

      private final ScalarQuantizer scalarQuantizer
      The field for the scalarQuantizer record component.

    • size

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

    • bits

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

    • compress

      private final boolean compress
      The field for the compress record component.

    • ordToDoc

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

  • Constructor Details

    • FieldEntry

      private FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, int dimension, long vectorDataOffset, long vectorDataLength, ScalarQuantizer scalarQuantizer, int size, byte bits, boolean compress, OrdToDocDISIReaderConfiguration ordToDoc)
      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
      dimension - the value for the dimension record component
      vectorDataOffset - the value for the vectorDataOffset record component
      vectorDataLength - the value for the vectorDataLength record component
      scalarQuantizer - the value for the scalarQuantizer record component
      size - the value for the size record component
      bits - the value for the bits record component
      compress - the value for the compress record component
      ordToDoc - the value for the ordToDoc record component

  • Method Details

    • create

      static Lucene99ScalarQuantizedVectorsReader.FieldEntry create(IndexInput input, int versionMeta, 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

    • dimension

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

    • scalarQuantizer

      public ScalarQuantizer scalarQuantizer()
      Returns the value of the scalarQuantizer record component.
      Returns:
      the value of the scalarQuantizer record component

    • size

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

    • bits

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

    • compress

      public boolean compress()
      Returns the value of the compress record component.
      Returns:
      the value of the compress record component

    • ordToDoc

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