Class VectorSimilarityFunction
java.lang.Object
org.apache.lucene.queries.function.ValueSource
org.apache.lucene.queries.function.valuesource.VectorSimilarityFunction
- Direct Known Subclasses:
ByteVectorSimilarityFunction,FloatVectorSimilarityFunction
VectorSimilarityFunction returns a similarity function between two knn vectors.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final VectorSimilarityFunctionprotected final ValueSourceprotected final ValueSource -
Constructor Summary
ConstructorsConstructorDescriptionVectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2) -
Method Summary
Modifier and TypeMethodDescriptiondescription of field, used in explain()booleanprotected abstract floatfunc(int doc, FunctionValues f1, FunctionValues f2) getValues(Map<Object, Object> context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight().inthashCode()Methods inherited from class org.apache.lucene.queries.function.ValueSource
asDoubleValuesSource, asLongValuesSource, createWeight, fromDoubleValuesSource, getSortField, newContext, toString
-
Field Details
-
similarityFunction
-
vector1
-
vector2
-
-
Constructor Details
-
VectorSimilarityFunction
public VectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)
-
-
Method Details
-
getValues
public FunctionValues getValues(Map<Object, Object> context, LeafReaderContext readerContext) throws IOExceptionDescription copied from class:ValueSourceGets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.- Specified by:
getValuesin classValueSource- Throws:
IOException
-
func
- Throws:
IOException
-
equals
- Specified by:
equalsin classValueSource
-
hashCode
public int hashCode()- Specified by:
hashCodein classValueSource
-
description
Description copied from class:ValueSourcedescription of field, used in explain()- Specified by:
descriptionin classValueSource
-