Record Class Lucene90HnswVectorsReader.FieldEntry
java.lang.Object
java.lang.Record
org.apache.lucene.backward_codecs.lucene90.Lucene90HnswVectorsReader.FieldEntry
- Enclosing class:
Lucene90HnswVectorsReader
private static record Lucene90HnswVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long indexDataOffset, long indexDataLength, int dimension, int[] ordToDoc, long[] ordOffsets)
extends Record
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The field for thedimension
record component.private final long
The field for theindexDataLength
record component.private final long
The field for theindexDataOffset
record component.private final long[]
The field for theordOffsets
record component.private final int[]
The field for theordToDoc
record component.private final VectorSimilarityFunction
The field for thesimilarityFunction
record component.private final long
The field for thevectorDataLength
record component.private final long
The field for thevectorDataOffset
record component. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
FieldEntry
(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long indexDataOffset, long indexDataLength, int dimension, int[] ordToDoc, long[] ordOffsets) Creates an instance of aFieldEntry
record class. -
Method Summary
Modifier and TypeMethodDescription(package private) static Lucene90HnswVectorsReader.FieldEntry
create
(DataInput input, 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.long
Returns the value of theindexDataLength
record component.long
Returns the value of theindexDataOffset
record component.long[]
Returns the value of theordOffsets
record component.int[]
ordToDoc()
Returns the value of theordToDoc
record component.Returns the value of thesimilarityFunction
record component.(package private) int
size()
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.
-
Field Details
-
similarityFunction
The field for thesimilarityFunction
record component. -
vectorDataOffset
private final long vectorDataOffsetThe field for thevectorDataOffset
record component. -
vectorDataLength
private final long vectorDataLengthThe field for thevectorDataLength
record component. -
indexDataOffset
private final long indexDataOffsetThe field for theindexDataOffset
record component. -
indexDataLength
private final long indexDataLengthThe field for theindexDataLength
record component. -
dimension
private final int dimensionThe field for thedimension
record component. -
ordToDoc
private final int[] ordToDocThe field for theordToDoc
record component. -
ordOffsets
private final long[] ordOffsetsThe field for theordOffsets
record component.
-
-
Constructor Details
-
FieldEntry
private FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long indexDataOffset, long indexDataLength, int dimension, int[] ordToDoc, long[] ordOffsets) Creates an instance of aFieldEntry
record class.- Parameters:
similarityFunction
- the value for thesimilarityFunction
record componentvectorDataOffset
- the value for thevectorDataOffset
record componentvectorDataLength
- the value for thevectorDataLength
record componentindexDataOffset
- the value for theindexDataOffset
record componentindexDataLength
- the value for theindexDataLength
record componentdimension
- the value for thedimension
record componentordToDoc
- the value for theordToDoc
record componentordOffsets
- the value for theordOffsets
record component
-
-
Method Details
-
create
static Lucene90HnswVectorsReader.FieldEntry create(DataInput input, VectorSimilarityFunction similarityFunction) throws IOException - Throws:
IOException
-
size
int size() -
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
-
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
-
indexDataOffset
public long indexDataOffset()Returns the value of theindexDataOffset
record component.- Returns:
- the value of the
indexDataOffset
record component
-
indexDataLength
public long indexDataLength()Returns the value of theindexDataLength
record component.- Returns:
- the value of the
indexDataLength
record component
-
dimension
public int dimension()Returns the value of thedimension
record component.- Returns:
- the value of the
dimension
record component
-
ordToDoc
public int[] ordToDoc()Returns the value of theordToDoc
record component.- Returns:
- the value of the
ordToDoc
record component
-
ordOffsets
public long[] ordOffsets()Returns the value of theordOffsets
record component.- Returns:
- the value of the
ordOffsets
record component
-