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

- Packages that use KnnCollector
  Package | Description
  --- | ---
  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.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  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.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.index

    Methods in org.apache.lucene.index with parameters of type KnnCollector
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | CodecReader.`searchNearestVectors​(String field, byte[] target, KnnCollector knnCollector, Bits acceptDocs)` |
    `void` | CodecReader.`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.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
    `class` | `TopKnnCollector` | TopKnnCollector is a specific KnnCollector.

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

    Classes in org.apache.lucene.search.knn that implement KnnCollector
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `MultiLeafTopKnnCollector` | MultiLeafTopKnnCollector 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.

  - ### 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 class` | `HnswGraphBuilder.GraphBuilderKnnCollector` | A restricted, specialized knnCollector that can be used when building a graph.
    `class` | `OrdinalTranslatedKnnCollector` | Wraps a provided KnnCollector object, translating the provided vectorId ordinal to a documentId

    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
    --- | --- | ---
    `static void` | HnswGraphSearcher.`search​(RandomVectorScorer scorer, KnnCollector knnCollector, HnswGraph graph, Bits acceptOrds)` | Searches HNSW graph for the nearest neighbors of a query vector.

    Constructors in org.apache.lucene.util.hnsw with parameters of type KnnCollector
    Constructor | Description
    --- | ---
    `OrdinalTranslatedKnnCollector​(KnnCollector in, IntToIntFunction vectorOrdinalToDocId)` |