core/org.gnit.lucenekmp.search/AbstractKnnCollector

AbstractKnnCollector

abstract class AbstractKnnCollector : KnnCollector

AbstractKnnCollector is the default implementation for a knn collector used for gathering kNN results and providing topDocs from the gathered neighbors

Inheritors

TopKnnCollector

VectorSimilarityCollector

Properties

searchStrategy

open override val searchStrategy: KnnSearchStrategy?

Functions

collect

abstract override fun collect(docId: Int, similarity: Float): Boolean

Collect the provided docId and include in the result set.

earlyTerminated

open override fun earlyTerminated(): Boolean

If search visits too many documents, the results collector will terminate early. Usually, this is due to some restricted filter on the document set.

incVisitedCount

open override fun incVisitedCount(count: Int)

open override fun k(): Int

minCompetitiveSimilarity

abstract override fun minCompetitiveSimilarity(): Float

This method is utilized during search to ensure only competitive results are explored.

numCollected

abstract fun numCollected(): Int

topDocs

abstract override fun topDocs(): TopDocs

This drains the collected nearest kNN results and returns them in a new TopDocs collection, ordered by score descending. NOTE: This is generally a destructive action and the collector should not be used after topDocs() is called.

visitedCount

open override fun visitedCount(): Long

visitLimit

open override fun visitLimit(): Long