Module org.apache.lucene.core

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 KnnFloatVectorQuery 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

Constructor Summary

Constructors

Constructor	Description
VectorScorer(VectorSimilarityFunction similarity)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Field Details

similarity

protected final VectorSimilarityFunction similarity

Constructor Details

VectorScorer

VectorScorer(VectorSimilarityFunction similarity)

Method Details

create

static VectorScorer.FloatVectorScorer 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

create

static VectorScorer.ByteVectorScorer create(LeafReaderContext context,
 FieldInfo fi,
 byte[] query)
                                     throws IOException

Throws:

IOException

score

abstract float score()
              throws IOException

Compute the similarity score for the current document.

Throws:

IOException

advanceExact

abstract boolean advanceExact(int doc)
                       throws IOException

Throws:

IOException