- java.lang.Object
-
- org.apache.lucene.search.VectorScorer
-
- Direct Known Subclasses:
VectorScorer.ByteVectorScorer
,VectorScorer.FloatVectorScorer
abstract class VectorScorer extends java.lang.Object
Computes the similarity score between a given query vector and different document vectors. This is primarily used byKnnFloatVectorQuery
to run an exact, exhaustive search over the vectors.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
VectorScorer.ByteVectorScorer
private static class
VectorScorer.FloatVectorScorer
-
Field Summary
Fields Modifier and Type Field Description protected VectorSimilarityFunction
similarity
-
Constructor Summary
Constructors Constructor Description VectorScorer(VectorSimilarityFunction similarity)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description (package private) abstract boolean
advanceExact(int doc)
(package private) static VectorScorer.ByteVectorScorer
create(LeafReaderContext context, FieldInfo fi, byte[] query)
(package private) static VectorScorer.FloatVectorScorer
create(LeafReaderContext context, FieldInfo fi, float[] query)
Create a new vector scorer instance.(package private) abstract float
score()
Compute the similarity score for the current document.
-
-
-
Field Detail
-
similarity
protected final VectorSimilarityFunction similarity
-
-
Constructor Detail
-
VectorScorer
VectorScorer(VectorSimilarityFunction similarity)
-
-
Method Detail
-
create
static VectorScorer.FloatVectorScorer create(LeafReaderContext context, FieldInfo fi, float[] query) throws java.io.IOException
Create a new vector scorer instance.- Parameters:
context
- the reader contextfi
- the FieldInfo for the field containing document vectorsquery
- the query vector to compute the similarity for- Throws:
java.io.IOException
-
create
static VectorScorer.ByteVectorScorer create(LeafReaderContext context, FieldInfo fi, byte[] query) throws java.io.IOException
- Throws:
java.io.IOException
-
score
abstract float score() throws java.io.IOException
Compute the similarity score for the current document.- Throws:
java.io.IOException
-
advanceExact
abstract boolean advanceExact(int doc) throws java.io.IOException
- Throws:
java.io.IOException
-
-