Module org.apache.lucene.backward_codecs
Package org.apache.lucene.backward_codecs.lucene91

Record Class Lucene91HnswVectorsReader.FieldEntry

java.lang.Object
java.lang.Record
org.apache.lucene.backward_codecs.lucene91.Lucene91HnswVectorsReader.FieldEntry
Enclosing class:
Lucene91HnswVectorsReader
private static record Lucene91HnswVectorsReader.FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int maxConn, int numLevels, int dimension, int size, int[] ordToDoc, IntUnaryOperator ordToDocOperator, int[][] nodesByLevel, long[] graphOffsetsByLevel) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    dimension
    The field for the dimension record component.
    private final long[]
    graphOffsetsByLevel
    The field for the graphOffsetsByLevel record component.
    private final int
    maxConn
    The field for the maxConn record component.
    private final int[][]
    nodesByLevel
    The field for the nodesByLevel record component.
    private final int
    numLevels
    The field for the numLevels record component.
    private final int[]
    ordToDoc
    The field for the ordToDoc record component.
    private final IntUnaryOperator
    ordToDocOperator
    The field for the ordToDocOperator record component.
    private final VectorSimilarityFunction
    similarityFunction
    The field for the similarityFunction record component.
    private final int
    size
    The field for the size record component.
    private final long
    vectorDataLength
    The field for the vectorDataLength record component.
    private final long
    vectorDataOffset
    The field for the vectorDataOffset record component.
    private final long
    vectorIndexLength
    The field for the vectorIndexLength record component.
    private final long
    vectorIndexOffset
    The field for the vectorIndexOffset record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int maxConn, int numLevels, int dimension, int size, int[] ordToDoc, IntUnaryOperator ordToDocOperator, int[][] nodesByLevel, long[] graphOffsetsByLevel)
    Creates an instance of a FieldEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) static Lucene91HnswVectorsReader.FieldEntry
    create(DataInput input, VectorSimilarityFunction similarityFunction)
     
    int
    dimension()
    Returns the value of the dimension record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long[]
    graphOffsetsByLevel()
    Returns the value of the graphOffsetsByLevel record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxConn()
    Returns the value of the maxConn record component.
    int[][]
    nodesByLevel()
    Returns the value of the nodesByLevel record component.
    int
    numLevels()
    Returns the value of the numLevels record component.
    int[]
    ordToDoc()
    Returns the value of the ordToDoc record component.
    (package private) int
    ordToDoc(int ord)
     
    IntUnaryOperator
    ordToDocOperator()
    Returns the value of the ordToDocOperator record component.
    VectorSimilarityFunction
    similarityFunction()
    Returns the value of the similarityFunction record component.
    int
    size()
    Returns the value of the size record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    vectorDataLength()
    Returns the value of the vectorDataLength record component.
    long
    vectorDataOffset()
    Returns the value of the vectorDataOffset record component.
    long
    vectorIndexLength()
    Returns the value of the vectorIndexLength record component.
    long
    vectorIndexOffset()
    Returns the value of the vectorIndexOffset record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • similarityFunction

      private final VectorSimilarityFunction similarityFunction
      The field for the similarityFunction 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.

    • vectorIndexOffset

      private final long vectorIndexOffset
      The field for the vectorIndexOffset record component.

    • vectorIndexLength

      private final long vectorIndexLength
      The field for the vectorIndexLength record component.

    • maxConn

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

    • numLevels

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

    • dimension

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

    • size

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

    • ordToDoc

      private final int[] ordToDoc
      The field for the ordToDoc record component.

    • ordToDocOperator

      private final IntUnaryOperator ordToDocOperator
      The field for the ordToDocOperator record component.

    • nodesByLevel

      private final int[][] nodesByLevel
      The field for the nodesByLevel record component.

    • graphOffsetsByLevel

      private final long[] graphOffsetsByLevel
      The field for the graphOffsetsByLevel record component.

  • Constructor Details

    • FieldEntry

      private FieldEntry(VectorSimilarityFunction similarityFunction, long vectorDataOffset, long vectorDataLength, long vectorIndexOffset, long vectorIndexLength, int maxConn, int numLevels, int dimension, int size, int[] ordToDoc, IntUnaryOperator ordToDocOperator, int[][] nodesByLevel, long[] graphOffsetsByLevel)
      Creates an instance of a FieldEntry record class.
      Parameters:
      similarityFunction - the value for the similarityFunction record component
      vectorDataOffset - the value for the vectorDataOffset record component
      vectorDataLength - the value for the vectorDataLength record component
      vectorIndexOffset - the value for the vectorIndexOffset record component
      vectorIndexLength - the value for the vectorIndexLength record component
      maxConn - the value for the maxConn record component
      numLevels - the value for the numLevels record component
      dimension - the value for the dimension record component
      size - the value for the size record component
      ordToDoc - the value for the ordToDoc record component
      ordToDocOperator - the value for the ordToDocOperator record component
      nodesByLevel - the value for the nodesByLevel record component
      graphOffsetsByLevel - the value for the graphOffsetsByLevel record component

  • Method Details

    • create

      static Lucene91HnswVectorsReader.FieldEntry create(DataInput input, VectorSimilarityFunction similarityFunction) throws IOException
      Throws:
      IOException

    • ordToDoc

      int ordToDoc(int ord)

    • 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

    • 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

    • vectorIndexOffset

      public long vectorIndexOffset()
      Returns the value of the vectorIndexOffset record component.
      Returns:
      the value of the vectorIndexOffset record component

    • vectorIndexLength

      public long vectorIndexLength()
      Returns the value of the vectorIndexLength record component.
      Returns:
      the value of the vectorIndexLength record component

    • maxConn

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

    • numLevels

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

    • dimension

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

    • size

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

    • ordToDoc

      public int[] ordToDoc()
      Returns the value of the ordToDoc record component.
      Returns:
      the value of the ordToDoc record component

    • ordToDocOperator

      public IntUnaryOperator ordToDocOperator()
      Returns the value of the ordToDocOperator record component.
      Returns:
      the value of the ordToDocOperator record component

    • nodesByLevel

      public int[][] nodesByLevel()
      Returns the value of the nodesByLevel record component.
      Returns:
      the value of the nodesByLevel record component

    • graphOffsetsByLevel

      public long[] graphOffsetsByLevel()
      Returns the value of the graphOffsetsByLevel record component.
      Returns:
      the value of the graphOffsetsByLevel record component