Uses of Interface
org.apache.lucene.search.KnnCollector

Packages that use KnnCollector

Package	Description
org.apache.lucene.backward_codecs.lucene90	Lucene 9.0 file format.
org.apache.lucene.backward_codecs.lucene91	Lucene 9.1 file format.
org.apache.lucene.backward_codecs.lucene92	Lucene 9.2 file format.
org.apache.lucene.backward_codecs.lucene94	Lucene 9.4 file format.
org.apache.lucene.backward_codecs.lucene95	Lucene 9.5 file format.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.lucene99	Lucene 9.9 file format.
org.apache.lucene.codecs.perfield	Postings format that can delegate to different formats per-field.
org.apache.lucene.codecs.simpletext	Simpletext Codec: writes human readable postings.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.index.memory	High-performance single-document main memory Apache Lucene fulltext search index.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.highlight	Highlighting search terms.
org.apache.lucene.search.join	Support for index-time and query-time joins.
org.apache.lucene.search.knn	Classes related to vector search: knn and vector fields.
org.apache.lucene.util.hnsw	Navigable Small-World graph, nominally Hierarchical but currently only has a single layer.

Uses of KnnCollector in org.apache.lucene.backward_codecs.lucene90

Methods in org.apache.lucene.backward_codecs.lucene90 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene90HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene90HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.backward_codecs.lucene91

Methods in org.apache.lucene.backward_codecs.lucene91 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene91HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene91HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.backward_codecs.lucene92

Methods in org.apache.lucene.backward_codecs.lucene92 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene92HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene92HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.backward_codecs.lucene94

Methods in org.apache.lucene.backward_codecs.lucene94 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene94HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene94HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.backward_codecs.lucene95

Methods in org.apache.lucene.backward_codecs.lucene95 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene95HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene95HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.codecs

Methods in org.apache.lucene.codecs with parameters of type KnnCollector

Modifier and Type	Method	Description
abstract void	KnnVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.
abstract void	KnnVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.

Uses of KnnCollector in org.apache.lucene.codecs.lucene99

Methods in org.apache.lucene.codecs.lucene99 with parameters of type KnnCollector

Modifier and Type	Method	Description
void	Lucene99HnswVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	Lucene99HnswVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.codecs.perfield

Methods in org.apache.lucene.codecs.perfield with parameters of type KnnCollector

Modifier and Type	Method	Description
void	PerFieldKnnVectorsFormat.FieldsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	PerFieldKnnVectorsFormat.FieldsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.codecs.simpletext

Methods in org.apache.lucene.codecs.simpletext with parameters of type KnnCollector

Modifier and Type	Method	Description
void	SimpleTextKnnVectorsReader.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	SimpleTextKnnVectorsReader.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.index

Methods in org.apache.lucene.index with parameters of type KnnCollector

Modifier and Type	Method	Description
void	SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper.search(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	SlowCompositeCodecReaderWrapper.SlowCompositeKnnVectorsReaderWrapper.search(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
final void	CodecReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
final void	CodecReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
void	DocValuesLeafReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	DocValuesLeafReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
void	ExitableDirectoryReader.ExitableFilterAtomicReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	ExitableDirectoryReader.ExitableFilterAtomicReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
void	FilterLeafReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	FilterLeafReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)
abstract void	LeafReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.
abstract void	LeafReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)	Return the k nearest neighbor documents as determined by comparison of their vector values for this field, to the given vector, by the field's similarity function.
void	ParallelLeafReader.searchNearestVectors(String fieldName, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	ParallelLeafReader.searchNearestVectors(String fieldName, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.index.memory

Methods in org.apache.lucene.index.memory with parameters of type KnnCollector

Modifier and Type	Method	Description
void	MemoryIndex.MemoryIndexReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	MemoryIndex.MemoryIndexReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.search

Classes in org.apache.lucene.search that implement KnnCollector

Modifier and Type	Class	Description
class	AbstractKnnCollector	AbstractKnnCollector is the default implementation for a knn collector used for gathering kNN results and providing topDocs from the gathered neighbors
(package private) class	TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector
class	TopKnnCollector	TopKnnCollector is a specific KnnCollector.
(package private) class	VectorSimilarityCollector	Perform a similarity-based graph search.

Fields in org.apache.lucene.search declared as KnnCollector

Modifier and Type	Field	Description
private final KnnCollector	TimeLimitingKnnCollectorManager.TimeLimitingKnnCollector.collector

Methods in org.apache.lucene.search that return KnnCollector

Modifier and Type	Method	Description
KnnCollector	TimeLimitingKnnCollectorManager.newCollector(int visitedLimit, LeafReaderContext context)

Constructors in org.apache.lucene.search with parameters of type KnnCollector

Modifier	Constructor	Description
(package private)	TimeLimitingKnnCollector(KnnCollector collector)

Uses of KnnCollector in org.apache.lucene.search.highlight

Methods in org.apache.lucene.search.highlight with parameters of type KnnCollector

Modifier and Type	Method	Description
void	TermVectorLeafReader.searchNearestVectors(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)
void	TermVectorLeafReader.searchNearestVectors(String field, float[] target, KnnCollector knnCollector, Bits acceptDocs)

Uses of KnnCollector in org.apache.lucene.search.join

Classes in org.apache.lucene.search.join that implement KnnCollector

Modifier and Type	Class	Description
(package private) class	DiversifyingNearestChildrenKnnCollector	This collects the nearest children vectors.

Methods in org.apache.lucene.search.join that return KnnCollector

Modifier and Type	Method	Description
KnnCollector	DiversifyingNearestChildrenKnnCollectorManager.newCollector(int visitedLimit, LeafReaderContext context)	Return a new DiversifyingNearestChildrenKnnCollector instance.

Uses of KnnCollector in org.apache.lucene.search.knn

Classes in org.apache.lucene.search.knn that implement KnnCollector

Modifier and Type	Class	Description
final class	MultiLeafKnnCollector	MultiLeafKnnCollector is a specific KnnCollector that can exchange the top collected results across segments through a shared global queue.

Methods in org.apache.lucene.search.knn that return KnnCollector

Modifier and Type	Method	Description
KnnCollector	KnnCollectorManager.newCollector(int visitedLimit, LeafReaderContext context)	Return a new KnnCollector instance.
KnnCollector	TopKnnCollectorManager.newCollector(int visitedLimit, LeafReaderContext context)	Return a new TopKnnCollector instance.

Uses of KnnCollector in org.apache.lucene.util.hnsw

Classes in org.apache.lucene.util.hnsw that implement KnnCollector

Modifier and Type	Class	Description
static final class	HnswGraphBuilder.GraphBuilderKnnCollector	A restricted, specialized knnCollector that can be used when building a graph.
final class	OrdinalTranslatedKnnCollector	Wraps a provided KnnCollector object, translating the provided vectorId ordinal to a documentId

Fields in org.apache.lucene.util.hnsw declared as KnnCollector

Modifier and Type	Field	Description
private final KnnCollector	OrdinalTranslatedKnnCollector.in

Methods in org.apache.lucene.util.hnsw that return KnnCollector

Modifier and Type	Method	Description
static KnnCollector	HnswGraphSearcher.search(RandomVectorScorer scorer, int topK, OnHeapHnswGraph graph, Bits acceptOrds, int visitedLimit)	Search OnHeapHnswGraph, this method is thread safe.

Methods in org.apache.lucene.util.hnsw with parameters of type KnnCollector

Modifier and Type	Method	Description
private int	HnswGraphSearcher.findBestEntryPoint(RandomVectorScorer scorer, HnswGraph graph, KnnCollector collector)	Function to find the best entry point from which to search the zeroth graph layer.
static void	HnswGraphSearcher.search(RandomVectorScorer scorer, KnnCollector knnCollector, HnswGraph graph, Bits acceptOrds)	Searches HNSW graph for the nearest neighbors of a query vector.
private static void	HnswGraphSearcher.search(RandomVectorScorer scorer, KnnCollector knnCollector, HnswGraph graph, HnswGraphSearcher graphSearcher, Bits acceptOrds)
(package private) void	HnswGraphSearcher.searchLevel(KnnCollector results, RandomVectorScorer scorer, int level, int[] eps, HnswGraph graph, Bits acceptOrds)	Add the closest neighbors found to a priority queue (heap).

Constructors in org.apache.lucene.util.hnsw with parameters of type KnnCollector

Modifier	Constructor	Description
	OrdinalTranslatedKnnCollector(KnnCollector in, IntToIntFunction vectorOrdinalToDocId)