Module org.apache.lucene.core

Package org.apache.lucene.search

Class VectorSimilarityValuesSource

java.lang.Object

org.apache.lucene.search.DoubleValuesSource

org.apache.lucene.search.VectorSimilarityValuesSource

All Implemented Interfaces:

SegmentCacheable

Direct Known Subclasses:

ByteVectorSimilarityValuesSource, FloatVectorSimilarityValuesSource

abstract class VectorSimilarityValuesSource
extends DoubleValuesSource

An abstract class that provides the vector similarity scores between the query vector and the KnnFloatVectorField or KnnByteVectorField for documents.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldName

Fields inherited from class org.apache.lucene.search.DoubleValuesSource

SCORES

Constructor Summary

Constructors

Constructor	Description
VectorSimilarityValuesSource(String fieldName)

Method Summary

Modifier and Type	Method	Description
protected abstract VectorScorer	getScorer(LeafReaderContext ctx)
DoubleValues	getValues(LeafReaderContext ctx, DoubleValues scores)	Returns a DoubleValues instance for the passed-in LeafReaderContext and scores
boolean	isCacheable(LeafReaderContext ctx)
boolean	needsScores()	Return true if document scores are needed to calculate values
DoubleValuesSource	rewrite(IndexSearcher reader)	Return a DoubleValuesSource specialised for the given IndexSearcher

Methods inherited from class org.apache.lucene.search.DoubleValuesSource

constant, equals, explain, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromQuery, fromScorer, getSortField, hashCode, similarityToQueryVector, similarityToQueryVector, toLongValuesSource, toString

Methods inherited from class java.lang.Object

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

Field Details

fieldName

protected final String fieldName

Constructor Details

VectorSimilarityValuesSource

public VectorSimilarityValuesSource(String fieldName)

Method Details

getValues

public DoubleValues getValues(LeafReaderContext ctx,
 DoubleValues scores)
                       throws IOException

Description copied from class: DoubleValuesSource

Returns a DoubleValues instance for the passed-in LeafReaderContext and scores

If scores are not needed to calculate the values (ie returns false, callers may safely pass null for the scores parameter.

Specified by:

getValues in class DoubleValuesSource

Throws:

IOException

getScorer

protected abstract VectorScorer getScorer(LeafReaderContext ctx)
                                   throws IOException

Throws:

IOException

needsScores

public boolean needsScores()

Description copied from class: DoubleValuesSource

Return true if document scores are needed to calculate values

Specified by:

needsScores in class DoubleValuesSource

rewrite

public DoubleValuesSource rewrite(IndexSearcher reader)
                           throws IOException

Description copied from class: DoubleValuesSource

Return a DoubleValuesSource specialised for the given IndexSearcher

Implementations should assume that this will only be called once. IndexReader-independent implementations can just return this

Queries that use DoubleValuesSource objects should call rewrite() during Query.createWeight(IndexSearcher, ScoreMode, float) rather than during Query.rewrite(IndexSearcher) to avoid IndexReader reference leakage.

For the same reason, implementations that cache references to the IndexSearcher should return a new object from this method.

Specified by:

rewrite in class DoubleValuesSource

Throws:

IOException

isCacheable

public boolean isCacheable(LeafReaderContext ctx)

Returns:

true if the object can be cached against a given leaf