Module org.apache.lucene.codecs
Package org.apache.lucene.codecs.simpletext

Record Class SimpleTextKnnVectorsReader.FieldEntry

java.lang.Object
java.lang.Record
org.apache.lucene.codecs.simpletext.SimpleTextKnnVectorsReader.FieldEntry
Enclosing class:
SimpleTextKnnVectorsReader
private static record SimpleTextKnnVectorsReader.FieldEntry(int dimension, long vectorDataOffset, long vectorDataLength, int[] ordToDoc, VectorSimilarityFunction similarityFunction) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    dimension
    The field for the dimension record component.
    private final int[]
    ordToDoc
    The field for the ordToDoc record component.
    private final VectorSimilarityFunction
    similarityFunction
    The field for the similarityFunction record component.
    private final long
    vectorDataLength
    The field for the vectorDataLength record component.
    private final long
    vectorDataOffset
    The field for the vectorDataOffset record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    FieldEntry(int dimension, long vectorDataOffset, long vectorDataLength, int[] ordToDoc, VectorSimilarityFunction similarityFunction)
    Creates an instance of a FieldEntry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    final int
    hashCode()
    Returns a hash code value for this object.
    int[]
    ordToDoc()
    Returns the value of the ordToDoc record component.
    VectorSimilarityFunction
    similarityFunction()
    Returns the value of the similarityFunction record component.
    (package private) int
    size()
     
    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.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • dimension

      private final int dimension
      The field for the dimension 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.

    • ordToDoc

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

    • similarityFunction

      private final VectorSimilarityFunction similarityFunction
      The field for the similarityFunction record component.

  • Constructor Details

    • FieldEntry

      private FieldEntry(int dimension, long vectorDataOffset, long vectorDataLength, int[] ordToDoc, VectorSimilarityFunction similarityFunction)
      Creates an instance of a FieldEntry record class.
      Parameters:
      dimension - the value for the dimension record component
      vectorDataOffset - the value for the vectorDataOffset record component
      vectorDataLength - the value for the vectorDataLength record component
      ordToDoc - the value for the ordToDoc record component
      similarityFunction - the value for the similarityFunction record component

  • Method Details

    • size

      int size()

    • 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.

    • dimension

      public int dimension()
      Returns the value of the dimension record component.
      Returns:
      the value of the dimension 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

    • ordToDoc

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

    • similarityFunction

      public VectorSimilarityFunction similarityFunction()
      Returns the value of the similarityFunction record component.
      Returns:
      the value of the similarityFunction record component