core/org.gnit.lucenekmp.search/VectorSimilarityCollector

VectorSimilarityCollector

class VectorSimilarityCollector(traversalSimilarity: Float, resultSimilarity: Float, visitLimit: Long) : AbstractKnnCollector

Perform a similarity-based graph search.

Constructors

VectorSimilarityCollector

constructor(traversalSimilarity: Float, resultSimilarity: Float, visitLimit: Long)

Properties

open override val searchStrategy: KnnSearchStrategy?

Functions

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.

open override fun numCollected(): 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