Filtered search: single max-heap search buffer (experiment)

include/svs/index/vamana/dynamic_index.h

@@ -532,6 +532,9 @@ class MutableVamanaIndex {
             [&](const auto is, uint64_t /*tid*/) {
                 for (auto i : is) {
                     for (size_t j = 0, jmax = getsize<1>(ids); j < jmax; ++j) {
+                        if (ids.at(i, j) == static_cast<size_t>(-1)) {
+                            continue; // Padding from a filtered search.
+                        }
                         auto internal = lib::narrow_cast<Idx>(ids.at(i, j));
                         ids.at(i, j) = translate_internal_id(internal);
                     }
@@ -623,8 +626,12 @@ class MutableVamanaIndex {
         QueryResultView<I> results,
         const Queries& queries,
         const search_parameters_type& sp,
-        const lib::DefaultPredicate& cancel = lib::Returns(lib::Const<false>())
+        const lib::DefaultPredicate& cancel = lib::Returns(lib::Const<false>()),
+        const std::function<bool(size_t)>* filter = nullptr
     ) {
+        // Optional `filter`: only entries whose external id passes are returned. It is
+        // called from all search threads. Rows with fewer passing entries than requested
+        // are padded with id `size_t(-1)` and the worst score.
         threads::parallel_for(
             threadpool_,
             threads::StaticPartition{queries.size()},
@@ -637,23 +644,39 @@ class MutableVamanaIndex {
                         : sp.buffer_config_,
                     distance::comparator(distance_),
                     sp.search_buffer_visited_set_};
+                // Filtered: the buffer checks the filter itself (two heaps).
+                std::function<bool(Idx)> internal_filter;
+                if (filter != nullptr) {
+                    internal_filter = [&](Idx i) {
+                        return (*filter)(translator_.get_external(i));
+                    };
+                    buffer.enable_heap(&internal_filter);
+                }
 
                 auto prefetch_parameters = GreedySearchPrefetchParameters{
                     sp.prefetch_lookahead_, sp.prefetch_step_};
 
                 auto scratch = extensions::per_thread_batch_search_setup(data_, distance_);
 
-                extensions::per_thread_batch_search(
-                    data_,
-                    buffer,
-                    scratch,
-                    queries,
-                    results,
-                    threads::UnitRange{is},
-                    greedy_search_closure(prefetch_parameters, cancel),
-                    *this,
-                    cancel
-                );
+                auto run = [&](const auto& search) {
+                    extensions::per_thread_batch_search(
+                        data_,
+                        buffer,
+                        scratch,
+                        queries,
+                        results,
+                        threads::UnitRange{is},
+                        search,
+                        *this,
+                        cancel
+                    );
+                };
+                auto search = greedy_search_closure(prefetch_parameters, cancel);
+                if (filter == nullptr) {
+                    run(search);
+                } else {
+                    run(extensions::FilteredSearch<decltype(search)>{search, filter});
+                }
             }
         );
 

include/svs/index/vamana/dynamic_search_buffer.h

@@ -26,6 +26,7 @@
 #include <cstring>
 #include <functional>
 #include <iostream>
+#include <limits>
 #include <optional>
 #include <type_traits>
 #include <unordered_set>
@@ -95,6 +96,17 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     vector_type candidates_{};
     // An optional visited filter.
     std::optional<set_type> visited_{std::nullopt};
+    // Optional (`enable_heap`): keep `candidates_` as a max-heap (worst entry on top)
+    // instead of a sorted list while searching. `cleanup()` sorts it once at the end and
+    // returns to the sorted-list behaviour.
+    // `internal_filter_`: the filter, called with an internal id; a neighbor that fails it
+    // stays in the buffer (it is still visited) but is marked not valid.
+    bool use_heap_ = false;
+    const std::function<bool(Idx)>* internal_filter_ = nullptr;
+    bool heap_sorted_ = false;
+    // Cached index of the best unvisited entry (`size()` if none); `npos` if stale.
+    static constexpr size_t npos = std::numeric_limits<size_t>::max();
+    mutable size_t heap_next_ = npos;
 
   public:
     MutableBuffer() = default;
@@ -197,6 +209,8 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     /// @brief Prepare the buffer for a new search operation.
     void clear() {
         candidates_.clear();
+        heap_sorted_ = false;
+        heap_next_ = npos;
         best_unvisited_ = 0;
         roi_end_ = 0;
         valid_ = 0;
@@ -223,6 +237,14 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
 
     size_t capacity() const { return candidates_.capacity(); }
 
+    /// @brief Keep the buffer as a max-heap during search (search window = capacity). A
+    /// neighbor is valid only if it also passes `*internal_filter` (called with its
+    /// internal id).
+    void enable_heap(const std::function<bool(Idx)>* internal_filter) {
+        use_heap_ = internal_filter != nullptr;
+        internal_filter_ = internal_filter;
+    }
+
     /// @brief Return the number of valid elements currently contained in the buffer.
     size_t valid() const { return valid_; }
 
@@ -267,6 +289,9 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     /// N.B.: If `done()` evaluates to `true`, do not try to extract further candidates
     /// from it using `next()`.
     bool done() const {
+        if (heap_mode()) {
+            return heap_best_unvisited() == size();
+        }
         // Until we've reached the target number of valid elements, we have to ignore
         // the state of `roi_end_`.
         return best_unvisited_ == ((valid() < target_valid_) ? size() : roi_end_);
@@ -282,6 +307,12 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     /// Post-conditions:
     /// * The returned neighbor will be marked as visited.
     const_reference next() {
+        if (heap_mode()) {
+            reference node = candidates_[heap_best_unvisited()];
+            node.set_visited();
+            heap_next_ = npos;
+            return node;
+        }
         // Get the best unvisited node
         reference node = getindex(candidates_, best_unvisited_);
         node.set_visited();
@@ -302,6 +333,10 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     ///
     /// Therefore, sequences of `push_back` must always be followed by a call to `sort`.
     void push_back(value_type neighbor) {
+        if (heap_mode()) {
+            heap_insert(neighbor);
+            return;
+        }
         // Follow the contract of not appending more valid elements than the capacity
         // allows.
         bool valid = neighbor.valid();
@@ -453,6 +488,9 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
 
     /// Insert the given neighbor into the search buffer.
     size_t insert(value_type neighbor) {
+        if (heap_mode()) {
+            return heap_insert(neighbor);
+        }
         if (can_skip(neighbor.distance())) {
             return size();
         }
@@ -505,6 +543,9 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
 
     // Sort all stored elements in the buffer.
     void sort() {
+        if (heap_mode()) {
+            return; // The heap is kept in order on every insert.
+        }
         assert(valid() <= valid_capacity_);
 
         // Put the elements in ascending order.
@@ -554,6 +595,11 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
 
     // TODO: Switch over to using iterators for the return values to avoid this.
     void cleanup() {
+        if (heap_mode()) {
+            // Sort once, then continue as a sorted list (e.g. for the top-up).
+            std::sort(begin(), end(), compare_);
+            heap_sorted_ = true;
+        }
         auto new_end =
             std::remove_if(begin(), end(), [](const auto& x) { return !x.valid(); });
         candidates_.resize(new_end - begin());
@@ -619,6 +665,64 @@ template <typename Idx, typename Cmp = std::less<>> class MutableBuffer {
     }
 
   private:
+    bool heap_mode() const { return use_heap_ && !heap_sorted_; }
+
+    // Max-heap order: the worst entry on top.
+    auto heap_compare() const {
+        return [this](const value_type& a, const value_type& b) {
+            return compare_(a.distance(), b.distance());
+        };
+    }
+
+    size_t heap_insert(value_type neighbor) {
+        // Same rules as the sorted list: skip entries worse than the worst valid one when
+        // full, and ids already present.
+        if (full() && compare_(candidates_.front().distance(), neighbor.distance())) {
+            return size();
+        }
+        for (const auto& candidate : candidates_) {
+            if (candidate.id() == neighbor.id()) {
+                return size() + 1;
+            }
+        }
+        // Only now (the entry could improve the results) is the filter called.
+        if (neighbor.valid() && !(*internal_filter_)(neighbor.id())) {
+            neighbor = value_type(neighbor.id(), neighbor.distance(), false);
+        }
+        candidates_.push_back(neighbor);
+        std::push_heap(begin(), end(), heap_compare());
+        valid_ += static_cast<size_t>(neighbor.valid());
+        // Too many valid entries: drop from the top until one valid entry is dropped.
+        while (valid_ > valid_capacity_) {
+            std::pop_heap(begin(), end(), heap_compare());
+            valid_ -= static_cast<size_t>(candidates_.back().valid());
+            candidates_.pop_back();
+        }
+        // When full, the worst entry must be valid (invalid entries beyond it are dropped).
+        while (full() && !candidates_.front().valid()) {
+            std::pop_heap(begin(), end(), heap_compare());
+            candidates_.pop_back();
+        }
+        heap_next_ = npos;
+        return 0;
+    }
+
+    // Linear scan for the best unvisited entry; cached until the next insert or `next()`.
+    size_t heap_best_unvisited() const {
+        if (heap_next_ == npos) {
+            size_t best = size();
+            for (size_t i = 0; i < size(); ++i) {
+                if (!candidates_[i].visited() &&
+                    (best == size() ||
+                     compare_(candidates_[i].distance(), candidates_[best].distance()))) {
+                    best = i;
+                }
+            }
+            heap_next_ = best;
+        }
+        return heap_next_;
+    }
+
     /// Return how many more valid candidates exist than required.
     /// If the number of valid candidates is *less* than the target, a negative number
     /// is returned.

include/svs/index/vamana/extensions.h

@@ -27,6 +27,9 @@
 #include "svs/lib/preprocessor.h"
 #include "svs/lib/threads.h"
 
+#include <functional>
+#include <limits>
+
 namespace svs::index::vamana::extensions {
 
 /////
@@ -432,12 +435,18 @@ struct VamanaSingleSearchType {
 /// with additional results.
 template <typename Index, typename SearchBuffer, typename Query>
 void check_and_supplement_search_buffer(
-    const Index& index, SearchBuffer& search_buffer, const Query& query
+    const Index& index,
+    SearchBuffer& search_buffer,
+    const Query& query,
+    const std::function<bool(size_t)>* filter = nullptr
 ) {
     if (search_buffer.valid() < search_buffer.target_window() &&
         search_buffer.valid() < index.size()) {
         search_buffer.sort();
         for (auto external_id : index.external_ids()) {
+            if (filter != nullptr && !(*filter)(external_id)) {
+                continue;
+            }
             auto internal_id = index.translate_external_id(external_id);
             auto dist = index.get_distance(external_id, query);
             auto builder = index.internal_search_builder();
@@ -449,6 +458,15 @@ void check_and_supplement_search_buffer(
     }
 }
 
+/// A search closure that also carries the filter of a filtered search.
+template <typename Search> struct FilteredSearch {
+    Search search;
+    const std::function<bool(size_t)>* filter;
+    template <typename... Args> void operator()(Args&&... args) const {
+        search(std::forward<Args>(args)...);
+    }
+};
+
 /// Customization point object for processing single queries.
 inline constexpr VamanaSingleSearchType single_search{};
 
@@ -481,7 +499,12 @@ SVS_FORCE_INLINE void svs_invoke(
     search(query, accessor, distance, search_buffer);
 
     if constexpr (Index::needs_id_translation) {
-        check_and_supplement_search_buffer(index, search_buffer, query);
+        const std::function<bool(size_t)>* filter = nullptr;
+        if constexpr (requires { search.filter; }) {
+            filter =
+                search.filter; // Filtered search: keep filtered-out ids out of the top-up.
+        }
+        check_and_supplement_search_buffer(index, search_buffer, query, filter);
     }
 }
 
@@ -586,6 +609,15 @@ void svs_invoke(
 
         // Copy back results.
         for (size_t j = 0; j < num_neighbors; ++j) {
+            if constexpr (requires { search.filter; }) {
+                if (j >= search_buffer.size()) { // Filtered: fewer than k passed.
+                    result.index(i, j) = static_cast<I>(-1);
+                    result.distance(i, j) = distance::comparator(distance)(0.0f, 1.0f)
+                                                ? std::numeric_limits<float>::infinity()
+                                                : -std::numeric_limits<float>::infinity();
+                    continue;
+                }
+            }
             result.set(search_buffer[j], i, j);
         }
     }