Record Class FieldInfos.FieldVectorProperties

java.lang.Object
java.lang.Record
org.apache.lucene.index.FieldInfos.FieldVectorProperties
Enclosing class:
FieldInfos

private static record FieldInfos.FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) extends Record
  • Field Details

    • numDimensions

      private final int numDimensions
      The field for the numDimensions record component.
    • vectorEncoding

      private final VectorEncoding vectorEncoding
      The field for the vectorEncoding record component.
    • similarityFunction

      private final VectorSimilarityFunction similarityFunction
      The field for the similarityFunction record component.
  • Constructor Details

    • FieldVectorProperties

      private FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction)
      Creates an instance of a FieldVectorProperties record class.
      Parameters:
      numDimensions - the value for the numDimensions record component
      vectorEncoding - the value for the vectorEncoding record component
      similarityFunction - the value for the similarityFunction record component
  • Method Details

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

      public int numDimensions()
      Returns the value of the numDimensions record component.
      Returns:
      the value of the numDimensions record component
    • vectorEncoding

      public VectorEncoding vectorEncoding()
      Returns the value of the vectorEncoding record component.
      Returns:
      the value of the vectorEncoding record component
    • similarityFunction

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