Module org.apache.lucene.core
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 Summary
FieldsModifier and TypeFieldDescriptionprivate final byte
The field for thebits
record component.private final boolean
The field for thecompress
record component.private final int
The field for thedimension
record component.private final OrdToDocDISIReaderConfiguration
The field for theordToDoc
record component.private final ScalarQuantizer
The field for thescalarQuantizer
record component.private final VectorSimilarityFunction
The field for thesimilarityFunction
record component.private final int
The field for thesize
record component.private final long
The field for thevectorDataLength
record component.private final long
The field for thevectorDataOffset
record component.private final VectorEncoding
The field for thevectorEncoding
record component. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
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 aFieldEntry
record class. -
Method Summary
Modifier and TypeMethodDescriptionbyte
bits()
Returns the value of thebits
record component.boolean
compress()
Returns the value of thecompress
record component.(package private) static Lucene99ScalarQuantizedVectorsReader.FieldEntry
create
(IndexInput input, int versionMeta, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) int
Returns the value of thedimension
record component.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.ordToDoc()
Returns the value of theordToDoc
record component.Returns the value of thescalarQuantizer
record component.Returns the value of thesimilarityFunction
record component.int
size()
Returns the value of thesize
record component.final String
toString()
Returns a string representation of this record class.long
Returns the value of thevectorDataLength
record component.long
Returns the value of thevectorDataOffset
record component.Returns the value of thevectorEncoding
record component.
-
Field Details
-
similarityFunction
The field for thesimilarityFunction
record component. -
vectorEncoding
The field for thevectorEncoding
record component. -
dimension
private final int dimensionThe field for thedimension
record component. -
vectorDataOffset
private final long vectorDataOffsetThe field for thevectorDataOffset
record component. -
vectorDataLength
private final long vectorDataLengthThe field for thevectorDataLength
record component. -
scalarQuantizer
The field for thescalarQuantizer
record component. -
size
private final int sizeThe field for thesize
record component. -
bits
private final byte bitsThe field for thebits
record component. -
compress
private final boolean compressThe field for thecompress
record component. -
ordToDoc
The field for theordToDoc
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 aFieldEntry
record class.- Parameters:
similarityFunction
- the value for thesimilarityFunction
record componentvectorEncoding
- the value for thevectorEncoding
record componentdimension
- the value for thedimension
record componentvectorDataOffset
- the value for thevectorDataOffset
record componentvectorDataLength
- the value for thevectorDataLength
record componentscalarQuantizer
- the value for thescalarQuantizer
record componentsize
- the value for thesize
record componentbits
- the value for thebits
record componentcompress
- the value for thecompress
record componentordToDoc
- the value for theordToDoc
record component
-
-
Method Details
-
create
static Lucene99ScalarQuantizedVectorsReader.FieldEntry create(IndexInput input, int versionMeta, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) throws IOException - Throws:
IOException
-
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. -
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. -
equals
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 withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
similarityFunction
Returns the value of thesimilarityFunction
record component.- Returns:
- the value of the
similarityFunction
record component
-
vectorEncoding
Returns the value of thevectorEncoding
record component.- Returns:
- the value of the
vectorEncoding
record component
-
dimension
public int dimension()Returns the value of thedimension
record component.- Returns:
- the value of the
dimension
record component
-
vectorDataOffset
public long vectorDataOffset()Returns the value of thevectorDataOffset
record component.- Returns:
- the value of the
vectorDataOffset
record component
-
vectorDataLength
public long vectorDataLength()Returns the value of thevectorDataLength
record component.- Returns:
- the value of the
vectorDataLength
record component
-
scalarQuantizer
Returns the value of thescalarQuantizer
record component.- Returns:
- the value of the
scalarQuantizer
record component
-
size
public int size()Returns the value of thesize
record component.- Returns:
- the value of the
size
record component
-
bits
public byte bits()Returns the value of thebits
record component.- Returns:
- the value of the
bits
record component
-
compress
public boolean compress()Returns the value of thecompress
record component.- Returns:
- the value of the
compress
record component
-
ordToDoc
Returns the value of theordToDoc
record component.- Returns:
- the value of the
ordToDoc
record component
-