Class VectorSimilarityFunction
- java.lang.Object
-
- org.apache.lucene.queries.function.ValueSource
-
- org.apache.lucene.queries.function.valuesource.VectorSimilarityFunction
-
- Direct Known Subclasses:
ByteVectorSimilarityFunction,FloatVectorSimilarityFunction
public abstract class VectorSimilarityFunction extends ValueSource
VectorSimilarityFunctionreturns a similarity function between two knn vectors.
-
-
Field Summary
Fields Modifier and Type Field Description protected VectorSimilarityFunctionsimilarityFunctionprotected ValueSourcevector1protected ValueSourcevector2
-
Constructor Summary
Constructors Constructor Description VectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description Stringdescription()description of field, used in explain()booleanequals(Object o)protected abstract floatfunc(int doc, FunctionValues f1, FunctionValues f2)FunctionValuesgetValues(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 Detail
-
similarityFunction
protected final VectorSimilarityFunction similarityFunction
-
vector1
protected final ValueSource vector1
-
vector2
protected final ValueSource vector2
-
-
Constructor Detail
-
VectorSimilarityFunction
public VectorSimilarityFunction(VectorSimilarityFunction similarityFunction, ValueSource vector1, ValueSource vector2)
-
-
Method Detail
-
getValues
public FunctionValues getValues(Map<Object,Object> context, LeafReaderContext readerContext) throws IOException
Description 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
protected abstract float func(int doc, FunctionValues f1, FunctionValues f2) throws IOException- Throws:
IOException
-
equals
public boolean equals(Object o)
- Specified by:
equalsin classValueSource
-
hashCode
public int hashCode()
- Specified by:
hashCodein classValueSource
-
description
public String description()
Description copied from class:ValueSourcedescription of field, used in explain()- Specified by:
descriptionin classValueSource
-
-