core/org.gnit.lucenekmp.util.hnsw/HnswGraphBuilder/GraphBuilderKnnCollector

GraphBuilderKnnCollector

class GraphBuilderKnnCollector(k: Int) : KnnCollector

A restricted, specialized knnCollector that can be used when building a graph.

Does not support TopDocs

Constructors

GraphBuilderKnnCollector

constructor(k: Int)

Properties

open override val searchStrategy: KnnSearchStrategy

Functions

fun clear()

open 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

open override fun minCompetitiveSimilarity(): Float

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

fun minimumScore(): Float

fun popNode(): Int

popUntilNearestKNodes

fun popUntilNearestKNodes(): IntArray

fun size(): Int

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.

open override fun visitedCount(): Long

open override fun visitLimit(): Long