Module org.apache.lucene.core
Package org.apache.lucene.index
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 Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The field for thenumDimensions
record component.private final VectorSimilarityFunction
The field for thesimilarityFunction
record component.private final VectorEncoding
The field for thevectorEncoding
record component. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
FieldVectorProperties
(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Creates an instance of aFieldVectorProperties
record class. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.int
Returns the value of thenumDimensions
record component.Returns the value of thesimilarityFunction
record component.final String
toString()
Returns a string representation of this record class.Returns the value of thevectorEncoding
record component.
-
Field Details
-
numDimensions
private final int numDimensionsThe field for thenumDimensions
record component. -
vectorEncoding
The field for thevectorEncoding
record component. -
similarityFunction
The field for thesimilarityFunction
record component.
-
-
Constructor Details
-
FieldVectorProperties
private FieldVectorProperties(int numDimensions, VectorEncoding vectorEncoding, VectorSimilarityFunction similarityFunction) Creates an instance of aFieldVectorProperties
record class.- Parameters:
numDimensions
- the value for thenumDimensions
record componentvectorEncoding
- the value for thevectorEncoding
record componentsimilarityFunction
- the value for thesimilarityFunction
record component
-
-
Method Details
-
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 '=='. -
numDimensions
public int numDimensions()Returns the value of thenumDimensions
record component.- Returns:
- the value of the
numDimensions
record component
-
vectorEncoding
Returns the value of thevectorEncoding
record component.- Returns:
- the value of the
vectorEncoding
record component
-
similarityFunction
Returns the value of thesimilarityFunction
record component.- Returns:
- the value of the
similarityFunction
record component
-