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 Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The field for thedimension
record component.private final int
The field for theM
record component.private final int[][]
The field for thenodesByLevel
record component.private final int
The field for thenumLevels
record component.private final int
The field for theoffsetsBlockShift
record component.private final long
The field for theoffsetsLength
record component.private final DirectMonotonicReader.Meta
The field for theoffsetsMeta
record component.private final long
The field for theoffsetsOffset
record component.private final OrdToDocDISIReaderConfiguration
The field for theordToDocVectorValues
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.private final long
The field for thevectorIndexLength
record component.private final long
The field for thevectorIndexOffset
record component. -
Constructor Summary
ConstructorsConstructorDescriptionFieldEntry
(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 aFieldEntry
record class. -
Method Summary
Modifier and TypeMethodDescription(package private) static Lucene95HnswVectorsReader.FieldEntry
create
(IndexInput input, 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.int
M()
Returns the value of theM
record component.int[][]
Returns the value of thenodesByLevel
record component.int
Returns the value of thenumLevels
record component.int
Returns the value of theoffsetsBlockShift
record component.long
Returns the value of theoffsetsLength
record component.Returns the value of theoffsetsMeta
record component.long
Returns the value of theoffsetsOffset
record component.Returns the value of theordToDocVectorValues
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.long
Returns the value of thevectorIndexLength
record component.long
Returns the value of thevectorIndexOffset
record component.
-
Field Details
-
similarityFunction
The field for thesimilarityFunction
record component. -
vectorEncoding
The field for thevectorEncoding
record component. -
vectorDataOffset
private final long vectorDataOffsetThe field for thevectorDataOffset
record component. -
vectorDataLength
private final long vectorDataLengthThe field for thevectorDataLength
record component. -
vectorIndexOffset
private final long vectorIndexOffsetThe field for thevectorIndexOffset
record component. -
vectorIndexLength
private final long vectorIndexLengthThe field for thevectorIndexLength
record component. -
M
private final int MThe field for theM
record component. -
numLevels
private final int numLevelsThe field for thenumLevels
record component. -
dimension
private final int dimensionThe field for thedimension
record component. -
size
private final int sizeThe field for thesize
record component. -
nodesByLevel
private final int[][] nodesByLevelThe field for thenodesByLevel
record component. -
offsetsMeta
The field for theoffsetsMeta
record component. -
offsetsOffset
private final long offsetsOffsetThe field for theoffsetsOffset
record component. -
offsetsBlockShift
private final int offsetsBlockShiftThe field for theoffsetsBlockShift
record component. -
offsetsLength
private final long offsetsLengthThe field for theoffsetsLength
record component. -
ordToDocVectorValues
The field for theordToDocVectorValues
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 aFieldEntry
record class.- Parameters:
similarityFunction
- the value for thesimilarityFunction
record componentvectorEncoding
- the value for thevectorEncoding
record componentvectorDataOffset
- the value for thevectorDataOffset
record componentvectorDataLength
- the value for thevectorDataLength
record componentvectorIndexOffset
- the value for thevectorIndexOffset
record componentvectorIndexLength
- the value for thevectorIndexLength
record componentM
- the value for theM
record componentnumLevels
- the value for thenumLevels
record componentdimension
- the value for thedimension
record componentsize
- the value for thesize
record componentnodesByLevel
- the value for thenodesByLevel
record componentoffsetsMeta
- the value for theoffsetsMeta
record componentoffsetsOffset
- the value for theoffsetsOffset
record componentoffsetsBlockShift
- the value for theoffsetsBlockShift
record componentoffsetsLength
- the value for theoffsetsLength
record componentordToDocVectorValues
- the value for theordToDocVectorValues
record component
-
-
Method Details
-
create
static Lucene95HnswVectorsReader.FieldEntry create(IndexInput input, 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
-
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
-
vectorIndexOffset
public long vectorIndexOffset()Returns the value of thevectorIndexOffset
record component.- Returns:
- the value of the
vectorIndexOffset
record component
-
vectorIndexLength
public long vectorIndexLength()Returns the value of thevectorIndexLength
record component.- Returns:
- the value of the
vectorIndexLength
record component
-
M
public int M()Returns the value of theM
record component.- Returns:
- the value of the
M
record component
-
numLevels
public int numLevels()Returns the value of thenumLevels
record component.- Returns:
- the value of the
numLevels
record component
-
dimension
public int dimension()Returns the value of thedimension
record component.- Returns:
- the value of the
dimension
record component
-
size
public int size()Returns the value of thesize
record component.- Returns:
- the value of the
size
record component
-
nodesByLevel
public int[][] nodesByLevel()Returns the value of thenodesByLevel
record component.- Returns:
- the value of the
nodesByLevel
record component
-
offsetsMeta
Returns the value of theoffsetsMeta
record component.- Returns:
- the value of the
offsetsMeta
record component
-
offsetsOffset
public long offsetsOffset()Returns the value of theoffsetsOffset
record component.- Returns:
- the value of the
offsetsOffset
record component
-
offsetsBlockShift
public int offsetsBlockShift()Returns the value of theoffsetsBlockShift
record component.- Returns:
- the value of the
offsetsBlockShift
record component
-
offsetsLength
public long offsetsLength()Returns the value of theoffsetsLength
record component.- Returns:
- the value of the
offsetsLength
record component
-
ordToDocVectorValues
Returns the value of theordToDocVectorValues
record component.- Returns:
- the value of the
ordToDocVectorValues
record component
-