Module org.apache.lucene.core

Package org.apache.lucene.search

Class AbstractVectorSimilarityQuery.VectorSimilarityScorer

java.lang.Object

org.apache.lucene.search.Scorable

org.apache.lucene.search.Scorer

org.apache.lucene.search.AbstractVectorSimilarityQuery.VectorSimilarityScorer

Enclosing class:

AbstractVectorSimilarityQuery

private static class AbstractVectorSimilarityQuery.VectorSimilarityScorer
extends Scorer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lucene.search.Scorable

Scorable.ChildScorable

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final float[]	cachedScore
(package private) final DocIdSetIterator	iterator

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

weight

Constructor Summary

Constructors

Constructor	Description
VectorSimilarityScorer(Weight weight, DocIdSetIterator iterator, float[] cachedScore)

Method Summary

Modifier and Type	Method	Description
int	docID()	Returns the doc ID that is currently being scored.
(package private) static AbstractVectorSimilarityQuery.VectorSimilarityScorer	fromAcceptDocs(Weight weight, float boost, VectorScorer scorer, DocIdSetIterator acceptDocs, float threshold)
(package private) static AbstractVectorSimilarityQuery.VectorSimilarityScorer	fromScoreDocs(Weight weight, float boost, ScoreDoc[] scoreDocs)
float	getMaxScore(int upTo)	Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.
DocIdSetIterator	iterator()	Return a DocIdSetIterator over matching documents.
float	score()	Returns the score of the current document matching the query.

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

advanceShallow, getWeight, twoPhaseIterator

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

getChildren, setMinCompetitiveScore, smoothingScore

Methods inherited from class java.lang.Object

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

Field Details

iterator

final DocIdSetIterator iterator

cachedScore

final float[] cachedScore

Constructor Details

VectorSimilarityScorer

VectorSimilarityScorer(Weight weight,
 DocIdSetIterator iterator,
 float[] cachedScore)

Method Details

fromScoreDocs

static AbstractVectorSimilarityQuery.VectorSimilarityScorer fromScoreDocs(Weight weight,
 float boost,
 ScoreDoc[] scoreDocs)

fromAcceptDocs

static AbstractVectorSimilarityQuery.VectorSimilarityScorer fromAcceptDocs(Weight weight,
 float boost,
 VectorScorer scorer,
 DocIdSetIterator acceptDocs,
 float threshold)

docID

public int docID()

Description copied from class: Scorable

Returns the doc ID that is currently being scored.

Specified by:

docID in class Scorable

iterator

public DocIdSetIterator iterator()

Description copied from class: Scorer

Return a DocIdSetIterator over matching documents.

The returned iterator will either be positioned on -1 if no documents have been scored yet, DocIdSetIterator.NO_MORE_DOCS if all documents have been scored already, or the last document id that has been scored otherwise.

The returned iterator is a view: calling this method several times will return iterators that have the same state.

Specified by:

iterator in class Scorer

getMaxScore

public float getMaxScore(int upTo)

Description copied from class: Scorer

Return the maximum score that documents between the last target that this iterator was shallow-advanced to included and upTo included.

Specified by:

getMaxScore in class Scorer

score

public float score()

Description copied from class: Scorable

Returns the score of the current document matching the query.

Specified by:

score in class Scorable