core/org.gnit.lucenekmp.search/TopKnnCollector

TopKnnCollector

open class TopKnnCollector @JvmOverloads constructor(k: Int, visitLimit: Int, searchStrategy: KnnSearchStrategy? = null) : 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.

Constructors

TopKnnCollector

@JvmOverloads

constructor(k: Int, visitLimit: Int, searchStrategy: KnnSearchStrategy? = null)

Properties

searchStrategy

open override val searchStrategy: KnnSearchStrategy?

Functions

collect

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

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

open override fun minCompetitiveSimilarity(): Float

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

numCollected

open override fun numCollected(): Int

topDocs

open 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.

toString

open override fun toString(): String

visitedCount

open override fun visitedCount(): Long

visitLimit

open override fun visitLimit(): Long