Package org.apache.lucene.search

Class VectorScorer

java.lang.Object

org.apache.lucene.search.VectorScorer

Direct Known Subclasses:

VectorScorer.ByteVectorScorer, VectorScorer.FloatVectorScorer

abstract class VectorScorer
extends Object

Computes the similarity score between a given query vector and different document vectors. This is primarily used by KnnVectorQuery 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 final VectorSimilarityFunction	similarity
protected final VectorValues	values

Constructor Summary

Constructors

Constructor	Description
VectorScorer(VectorValues values, VectorSimilarityFunction similarity)

Method Summary

Modifier and Type	Method	Description
boolean	advanceExact(int doc)	Advance the instance to the given document ID and return true if there is a value for that document.
(package private) static VectorScorer	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

values

protected final VectorValues values

similarity

protected final VectorSimilarityFunction similarity

Constructor Details

VectorScorer

VectorScorer(VectorValues values,
 VectorSimilarityFunction similarity)

Method Details

create

static VectorScorer create(LeafReaderContext context,
 FieldInfo fi,
 float[] query)
                    throws IOException

Create a new vector scorer instance.

Parameters:

context - the reader context

fi - the FieldInfo for the field containing document vectors

query - the query vector to compute the similarity for

Throws:

IOException

advanceExact

public boolean advanceExact(int doc)
                     throws IOException

Advance the instance to the given document ID and return true if there is a value for that document.

Throws:

IOException

score

abstract float score()
              throws IOException

Compute the similarity score for the current document.

Throws:

IOException