Package org.apache.lucene.search
Class TopKnnCollector
- java.lang.Object
-
- org.apache.lucene.search.AbstractKnnCollector
-
- org.apache.lucene.search.TopKnnCollector
-
- All Implemented Interfaces:
KnnCollector
public class TopKnnCollector extends AbstractKnnCollector
TopKnnCollector is a specific KnnCollector. A minHeap is used to keep track of the currently collected vectors allowing for efficient updates as better vectors are collected.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected NeighborQueuequeue-
Fields inherited from class org.apache.lucene.search.AbstractKnnCollector
visitedCount
-
-
Constructor Summary
Constructors Constructor Description TopKnnCollector(int k, int visitLimit)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancollect(int docId, float similarity)Collect the provided docId and include in the result set.floatminCompetitiveSimilarity()This method is utilized during search to ensure only competitive results are explored.intnumCollected()TopDocstopDocs()This drains the collected nearest kNN results and returns them in a newTopDocscollection, ordered by score descending.StringtoString()-
Methods inherited from class org.apache.lucene.search.AbstractKnnCollector
earlyTerminated, incVisitedCount, k, visitedCount, visitLimit
-
-
-
-
Field Detail
-
queue
protected final NeighborQueue queue
-
-
Method Detail
-
collect
public boolean collect(int docId, float similarity)Description copied from interface:KnnCollectorCollect the provided docId and include in the result set.- Specified by:
collectin interfaceKnnCollector- Specified by:
collectin classAbstractKnnCollector- 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:KnnCollectorThis 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_INFINITYwhen not full.When full, the minimum score should be returned.
- Specified by:
minCompetitiveSimilarityin interfaceKnnCollector- Specified by:
minCompetitiveSimilarityin classAbstractKnnCollector- Returns:
- the current minimum competitive similarity in the collection
-
topDocs
public TopDocs topDocs()
Description copied from interface:KnnCollectorThis drains the collected nearest kNN results and returns them in a newTopDocscollection, ordered by score descending. NOTE: This is generally a destructive action and the collector should not be used after topDocs() is called.- Specified by:
topDocsin interfaceKnnCollector- Specified by:
topDocsin classAbstractKnnCollector- Returns:
- The collected top documents
-
numCollected
public int numCollected()
- Specified by:
numCollectedin classAbstractKnnCollector
-
-