Module org.apache.lucene.core
Package org.apache.lucene.search
Class TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector
- java.lang.Object
-
- org.apache.lucene.search.TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector
-
- All Implemented Interfaces:
KnnCollector
- Enclosing class:
- TimeLimitingKnnCollectorManager
class TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector extends java.lang.Object implements KnnCollector
-
-
Field Summary
Fields Modifier and Type Field Description private KnnCollector
collector
-
Constructor Summary
Constructors Constructor Description TimeLimitingKnnCollector(KnnCollector collector)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
collect(int docId, float similarity)
Collect the provided docId and include in the result set.boolean
earlyTerminated()
If search visits too many documents, the results collector will terminate early.void
incVisitedCount(int count)
int
k()
float
minCompetitiveSimilarity()
This method is utilized during search to ensure only competitive results are explored.TopDocs
topDocs()
This drains the collected nearest kNN results and returns them in a newTopDocs
collection, ordered by score descending.long
visitedCount()
long
visitLimit()
-
-
-
Field Detail
-
collector
private final KnnCollector collector
-
-
Constructor Detail
-
TimeLimitingKnnCollector
TimeLimitingKnnCollector(KnnCollector collector)
-
-
Method Detail
-
earlyTerminated
public boolean earlyTerminated()
Description copied from interface:KnnCollector
If search visits too many documents, the results collector will terminate early. Usually, this is due to some restricted filter on the document set.When collection is earlyTerminated, the results are not a correct representation of k nearest neighbors.
- Specified by:
earlyTerminated
in interfaceKnnCollector
- Returns:
- is the current result set marked as incomplete?
-
incVisitedCount
public void incVisitedCount(int count)
- Specified by:
incVisitedCount
in interfaceKnnCollector
- Parameters:
count
- increments the visited vector count, must be greater than 0.
-
visitedCount
public long visitedCount()
- Specified by:
visitedCount
in interfaceKnnCollector
- Returns:
- the current visited vector count
-
visitLimit
public long visitLimit()
- Specified by:
visitLimit
in interfaceKnnCollector
- Returns:
- the visited vector limit
-
k
public int k()
- Specified by:
k
in interfaceKnnCollector
- Returns:
- the expected number of collected results
-
collect
public boolean collect(int docId, float similarity)
Description copied from interface:KnnCollector
Collect the provided docId and include in the result set.- Specified by:
collect
in interfaceKnnCollector
- Parameters:
docId
- of the vector to collectsimilarity
- its calculated similarity- Returns:
- true if the vector is collected
-
minCompetitiveSimilarity
public float minCompetitiveSimilarity()
Description copied from interface:KnnCollector
This method is utilized during search to ensure only competitive results are explored.Consequently, if this results collector wants to collect `k` results, this should return
Float.NEGATIVE_INFINITY
when not full.When full, the minimum score should be returned.
- Specified by:
minCompetitiveSimilarity
in interfaceKnnCollector
- Returns:
- the current minimum competitive similarity in the collection
-
topDocs
public TopDocs topDocs()
Description copied from interface:KnnCollector
This drains the collected nearest kNN results and returns them in a newTopDocs
collection, ordered by score descending. NOTE: This is generally a destructive action and the collector should not be used after topDocs() is called.- Specified by:
topDocs
in interfaceKnnCollector
- Returns:
- The collected top documents
-
-