Alexandr Guzhva e57a8939c9 introduce SingleQueryResultCollectHandler (#4926) ...

Summary:
This PR introduces the following:
* a new type of a `ResultHandler` called `SingleQueryResultCollectHandler`
* adds a filtering capability to the core of the FastScan code
* `SIMDResultHandler::size_t in_range_num` and `SIMDResultHandlerToFloat::scan_cnt`, which can be effectively used for early stop checks. These are not currently used in the baseline `FAISS` code, but are used in the `Knowhere` fork

mdouze mnorris11 junjieqi please comment and suggest unit tests + locations that need to be written, given some possible unusual use cases on your end

Pull Request resolved: https://github.com/facebookresearch/faiss/pull/4926

Reviewed By: subhadeepkaran

Differential Revision: D96651396

Pulled By: mnorris11

fbshipit-source-id: c15bc1fc1398d072014315187c9e4dd98c573190

2026-03-18 14:05:55 -07:00

..

index_io_backward_compatibility

Re-enable backwards compatibility tests for rabitq now that 1.14.1 released (#4924)

2026-03-13 19:32:05 -07:00

CMakeLists.txt

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

common_faiss_tests.py

Add ARM SVE support for distance functions (#4798)

2026-02-11 04:05:35 -08:00

external_module_test.py

Re-add example of how to build, link, and test an external SWIG module"" (#3981)

2024-10-23 07:34:38 -07:00

test_approx_topk.cpp

Convert approx_topk and residual_quantizer_encode_steps to SIMDLevel dynamic dispatch (#4923)

2026-03-14 15:12:14 -07:00

test_autotune.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_binary_autotune.py

support SearchParameters for IndexBinary (#4761)

2026-02-04 00:03:15 -08:00

test_binary_factory.py

Add IndexBinaryIDMap2 support to index binary factory (#4603)

2025-10-14 16:47:57 -07:00

test_binary_flat.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_binary_hashindex.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_binary_io.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_binary_search_params.py

support SearchParameters for IndexBinary (#4761)

2026-02-04 00:03:15 -08:00

test_build_blocks.py

add hadamard transformation as an index for IVF (#4856)

2026-03-03 03:11:22 -08:00

test_callback_py.py

Reduce memory usage in timeout callback tests (#4745)

2026-01-05 15:00:20 -08:00

test_callback.cpp

Reduce memory usage in timeout callback tests (#4745)

2026-01-05 15:00:20 -08:00

test_clone.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_clustering_initialization.py

Add k-means++ and AFK-MC² centroid initialization methods (#4740)

2025-12-26 08:43:09 -08:00

test_clustering.py

Add early stopping to k-means clustering (#4741)

2025-12-29 14:05:23 -08:00

test_common_ivf_empty_index.cpp

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_contrib_with_scipy.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_contrib.py

Upgrade Faiss OSS side to numpy2 (#4523)

2025-10-02 09:49:05 -07:00

test_cppcontrib_sa_decode.cpp

Fix CQS signal readability-braces-around-statements in fbcode/faiss/tests (#4457)

2025-07-25 02:37:10 -07:00

test_cppcontrib_uintreader.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_custom_result_handler.cpp

generic result handlers for most indexes (#4762)

2026-01-21 13:58:27 -08:00

test_dealloc_invlists.cpp

Fix string-conversion issue in faiss/invlists/OnDiskInvertedLists.cpp +5 (#4791)

2026-02-03 12:48:14 -08:00

test_disable_pq_sdc_tables.cpp

Fix SCD Table test flakiness (#4069)

2024-12-06 14:21:50 -08:00

test_distances_simd.cpp

dynamic dispatch distances_simd (#4781)

2026-02-11 04:05:35 -08:00

test_documentation.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_extra_distances.py

dynamic dispatch distances_simd (#4781)

2026-02-11 04:05:35 -08:00

test_factory_tools.cpp

Move factory_tools to main library and fix unaligned SIMD store (#4782)

2026-02-01 23:34:04 -08:00

test_factory.py

RaBitQ implementation (#4235)

2025-03-29 12:26:39 -07:00

test_fast_scan_distance_to_code.cpp

Implement distance_to_code for IVFRaBitQFastScanScanner (#4822)

2026-02-20 19:39:13 -08:00

test_fast_scan_ivf.py

clean up serialization tests (#4700)

2025-12-09 05:16:38 -08:00

test_fast_scan.py

Switch all search paths to FastScanCodeScanner and remove make_knn_handler (#4904)

2026-03-12 02:15:42 -07:00

test_fastscan_filter.cpp

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

test_fastscan_filter.py

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

test_fastscan_perf.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_flat_panorama.py

Add IndexFlatIPPanorama (#4787)

2026-02-03 22:40:03 -08:00

test_graph_based.py

Fix to graph deserialization (#4812)

2026-02-18 21:09:15 -08:00

test_hamming.cpp

Fix compilation on macOS ARM64: Use faiss::idx_t instead of long test_hamming (#4755)

2026-01-13 18:04:00 -08:00

test_heap.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_hnsw_panorama.py

Reapply IndexHNSWFlatPanorama with backward compatible serialization (#4692)

2025-12-16 17:08:33 -08:00

test_hnsw.cpp

VisitedTable -> unordered_set if ntotal is large (#4735)

2026-02-13 18:10:48 -08:00

test_index_accuracy.py

generic result handlers for most indexes (#4762)

2026-01-21 13:58:27 -08:00

test_index_binary_from_float.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_index_binary.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_index_composite.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_index.py

Implement IndexFlatL2Panorama (#4645)

2025-11-17 13:03:59 -08:00

test_io_corrupted.cpp

Fix NSG off-by-one neighbor ID check (#4804)

2026-02-12 21:09:31 -08:00

test_io.py

add hadamard transformation as an index for IVF (#4856)

2026-03-03 03:11:22 -08:00

test_ivf_flat_panorama.py

Dot Product Support Similarity Metric for IndexIVFFlatPanorama (#4732)

2025-12-29 17:46:49 -08:00

test_ivf_index.cpp

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_ivflib.py

Fix cloning for IVFFlatPanorama (#4887)

2026-03-09 13:37:57 -07:00

test_ivfpq_codec.cpp

facebook-unused-include-check in fbcode/faiss (#4029)

2024-11-15 13:53:46 -08:00

test_ivfpq_indexing.cpp

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_local_search_quantizer.py

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_lowlevel_ivf.cpp

Add InvertedListScanner support for IndexIVFRaBitQFastScan (#4760)

2026-01-22 17:47:45 -08:00

test_merge_index.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_merge.cpp

Fix CQS signal modernize-use-using in fbcode/faiss/tests [A] (#4476)

2025-07-29 00:45:34 -07:00

test_meta_index.py

Add attribute validation to prevent silent failures in SWIG wrappers (#4583)

2025-09-19 15:12:21 -07:00

test_mmap.cpp

Update callers to use read_index_up API (#4818)

2026-02-20 10:01:09 -08:00

test_NSG_compressed_graph.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_omp_threads_py.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_omp_threads.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_ondisk_ivf.cpp

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_pairs_decoding.cpp

Fix CQS signal modernize-use-using in fbcode/faiss/tests [A] (#4476)

2025-07-29 00:45:34 -07:00

test_params_override.cpp

Fix CQS signal readability-braces-around-statements in fbcode/faiss/tests (#4457)

2025-07-25 02:37:10 -07:00

test_partition.py

Fix E302 lint errors: Add required blank lines before class definitions (#4541)

2025-08-21 15:40:14 -07:00

test_partitioning.cpp

Fix CQS signal modernize-use-using in fbcode/faiss/tests [B] [A] (#4484)

2025-07-29 15:49:12 -07:00

test_pq_code_distance.cpp

Rework PQ code distance for Dynamic Dispatch (#4808)

2026-02-25 06:35:03 -08:00

test_pq_encoding.cpp

Add FastScanCodeScanner dispatch boundary with per-SIMD TUs (#4897)

2026-03-12 02:15:42 -07:00

test_pqfs_unaligned.cpp

Add FastScanCodeScanner dispatch boundary with per-SIMD TUs (#4897)

2026-03-12 02:15:42 -07:00

test_product_quantizer.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_rabitq_fastscan.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_rabitq.py

Replace squared-distance IP with direct dot-product in multi-bit RaBitQ (#4877)

2026-03-05 19:46:53 -08:00

test_RCQ_cropping.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_read_index_deserialize.cpp

Enforce memory limit in read_ProductQuantizer (#4930)

2026-03-17 10:04:22 -07:00

test_referenced_objects.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_refine_panorama.py

Add IndexFlatIPPanorama (#4787)

2026-02-03 22:40:03 -08:00

test_refine.py

Add attribute validation to prevent silent failures in SWIG wrappers (#4583)

2025-09-19 15:12:21 -07:00

test_residual_quantizer.py

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_rowwise_minmax.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_scalar_quantizer_correctness.py

Address review comments on SQ correctness tests (#4771)

2026-01-27 03:31:28 -08:00

test_scalar_quantizer.cpp

clamping variable used for computing percentile (#4687)

2025-11-21 21:34:30 -08:00

test_search_params.py

Fix typos in tests and contrib directories (#4672)

2025-11-12 11:39:51 -08:00

test_simd_dispatch.py

Introduce Dynamic Dispatch infrastructure with SIMDConfig (#4780)

2026-02-09 01:19:35 -08:00

test_simd_levels_x86_avx2.cpp

Introduce Dynamic Dispatch infrastructure with SIMDConfig (#4780)

2026-02-09 01:19:35 -08:00

test_simd_levels_x86_avx512.cpp

Introduce Dynamic Dispatch infrastructure with SIMDConfig (#4780)

2026-02-09 01:19:35 -08:00

test_simd_levels.cpp

Add ARM SVE support for distance functions (#4798)

2026-02-11 04:05:35 -08:00

test_simd_perf.cpp

Fix CMake static targets missing SIMD sources and definitions (#4800)

2026-02-12 00:51:56 -08:00

test_simdlib.cpp

Templatize simdlib types on SIMDLevel (#4866)

2026-03-09 02:23:05 -07:00

test_single_query_collect_handler.cpp

introduce SingleQueryResultCollectHandler (#4926)

2026-03-18 14:05:55 -07:00

test_sliding_ivf.cpp

Fix CQS signal readability-braces-around-statements in fbcode/faiss/tests (#4457)

2025-07-25 02:37:10 -07:00

test_standalone_codec.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_svs_py.py

feat(svs): LeanVec OOD support (#4773)

2026-03-04 13:12:16 -08:00

test_svs.cpp

fix broken test due to renaming to avoid lint (#4712)

2025-12-06 20:38:56 -08:00

test_swig_wrapper.py

Strengthen roundtrip tests by doing serialization after deserialization (#4851)

2026-03-02 16:30:12 -08:00

test_threaded_index.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_transfer_invlists.cpp

clang-format | Format fbsource with clang-format 21.

2025-10-26 23:40:59 -07:00

test_util.h

fix merge_flat_ondisk stress run failures (#3999)

2024-10-28 18:54:58 -07:00

test_utils.cpp

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00

test_zerocopy.cpp

Update callers to use read_index_up API (#4818)

2026-02-20 10:01:09 -08:00

torch_test_contrib.py

PQ with pytorch (#4116)

2025-01-06 09:48:32 -08:00

torch_test_neural_net.py

Enable linting: lint config changes plus arc lint command (#3966)

2024-10-22 09:46:48 -07:00