Record Class Lucene94HnswVectorsReader.FieldEntry
java.lang.Object
java.lang.Record
org.apache.lucene.backward_codecs.lucene94.Lucene94HnswVectorsReader.FieldEntry
- Enclosing class:
Lucene94HnswVectorsReader
static record Lucene94HnswVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, VectorEncoding vectorEncoding, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int M, int numLevels, int dimension, int size, int[][] nodesByLevel, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength)
extends Record
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final long
The field for theaddressesLength
record component.private final long
The field for theaddressesOffset
record component.private final int
The field for theblockShift
record component.private final byte
The field for thedenseRankPower
record component.private final int
The field for thedimension
record component.private final long
The field for thedocsWithFieldLength
record component.private final long
The field for thedocsWithFieldOffset
record component.private final long[]
The field for thegraphOffsetsByLevel
record component.private final short
The field for thejumpTableEntryCount
record component.private final int
The field for theM
record component.private final DirectMonotonicReader.Meta
The field for themeta
record component.private final int[][]
The field for thenodesByLevel
record component.private final int
The field for thenumLevels
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, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength) Creates an instance of aFieldEntry
record class. -
Method Summary
Modifier and TypeMethodDescriptionlong
Returns the value of theaddressesLength
record component.long
Returns the value of theaddressesOffset
record component.int
Returns the value of theblockShift
record component.(package private) static Lucene94HnswVectorsReader.FieldEntry
create
(IndexInput input, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) byte
Returns the value of thedenseRankPower
record component.int
Returns the value of thedimension
record component.long
Returns the value of thedocsWithFieldLength
record component.long
Returns the value of thedocsWithFieldOffset
record component.final boolean
Indicates whether some other object is "equal to" this one.long[]
Returns the value of thegraphOffsetsByLevel
record component.final int
hashCode()
Returns a hash code value for this object.short
Returns the value of thejumpTableEntryCount
record component.int
M()
Returns the value of theM
record component.meta()
Returns the value of themeta
record component.int[][]
Returns the value of thenodesByLevel
record component.int
Returns the value of thenumLevels
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. -
graphOffsetsByLevel
private final long[] graphOffsetsByLevelThe field for thegraphOffsetsByLevel
record component. -
docsWithFieldOffset
private final long docsWithFieldOffsetThe field for thedocsWithFieldOffset
record component. -
docsWithFieldLength
private final long docsWithFieldLengthThe field for thedocsWithFieldLength
record component. -
jumpTableEntryCount
private final short jumpTableEntryCountThe field for thejumpTableEntryCount
record component. -
denseRankPower
private final byte denseRankPowerThe field for thedenseRankPower
record component. -
addressesOffset
private final long addressesOffsetThe field for theaddressesOffset
record component. -
blockShift
private final int blockShiftThe field for theblockShift
record component. -
meta
The field for themeta
record component. -
addressesLength
private final long addressesLengthThe field for theaddressesLength
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, long[] graphOffsetsByLevel, long docsWithFieldOffset, long docsWithFieldLength, short jumpTableEntryCount, byte denseRankPower, long addressesOffset, int blockShift, DirectMonotonicReader.Meta meta, long addressesLength) 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 componentgraphOffsetsByLevel
- the value for thegraphOffsetsByLevel
record componentdocsWithFieldOffset
- the value for thedocsWithFieldOffset
record componentdocsWithFieldLength
- the value for thedocsWithFieldLength
record componentjumpTableEntryCount
- the value for thejumpTableEntryCount
record componentdenseRankPower
- the value for thedenseRankPower
record componentaddressesOffset
- the value for theaddressesOffset
record componentblockShift
- the value for theblockShift
record componentmeta
- the value for themeta
record componentaddressesLength
- the value for theaddressesLength
record component
-
-
Method Details
-
create
static Lucene94HnswVectorsReader.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
-
graphOffsetsByLevel
public long[] graphOffsetsByLevel()Returns the value of thegraphOffsetsByLevel
record component.- Returns:
- the value of the
graphOffsetsByLevel
record component
-
docsWithFieldOffset
public long docsWithFieldOffset()Returns the value of thedocsWithFieldOffset
record component.- Returns:
- the value of the
docsWithFieldOffset
record component
-
docsWithFieldLength
public long docsWithFieldLength()Returns the value of thedocsWithFieldLength
record component.- Returns:
- the value of the
docsWithFieldLength
record component
-
jumpTableEntryCount
public short jumpTableEntryCount()Returns the value of thejumpTableEntryCount
record component.- Returns:
- the value of the
jumpTableEntryCount
record component
-
denseRankPower
public byte denseRankPower()Returns the value of thedenseRankPower
record component.- Returns:
- the value of the
denseRankPower
record component
-
addressesOffset
public long addressesOffset()Returns the value of theaddressesOffset
record component.- Returns:
- the value of the
addressesOffset
record component
-
blockShift
public int blockShift()Returns the value of theblockShift
record component.- Returns:
- the value of the
blockShift
record component
-
meta
Returns the value of themeta
record component.- Returns:
- the value of the
meta
record component
-
addressesLength
public long addressesLength()Returns the value of theaddressesLength
record component.- Returns:
- the value of the
addressesLength
record component
-