Class AlgorithmInterface

src/algorithm/hnswlib/algorithm_interface.h:40–157

template <typename dist_t>
class AlgorithmInterface {
public:
    virtual bool
    addPoint(const void* datapoint, LabelType label) = 0;

    virtual std::priority_queue<std::pair<dist_t, LabelType>>
    searchKnn(const void* query_data,
              size_t k,
              size_t ef,
              const vsag::FilterPtr is_id_allowed = nullptr,
              float skip_ratio = 0.9f,
              vsag::FilterSearchSkipStrategyType skip_strategy_type =
                  vsag::FilterSearchSkipStrategyType::DETERMINISTIC_ACCUMULATIVE,
              vsag::Allocator* allocator = nullptr,
              vsag::IteratorFilterContext* iter_ctx = nullptr,
              bool is_last_filter = false) const = 0;

    virtual std::priority_queue<std::pair<dist_t, LabelType>>
    searchRange(const void* query_data,
                float radius,
                size_t ef,
                const vsag::FilterPtr is_id_allowed = nullptr) const = 0;

    // Return k nearest neighbor in the order of closer fist
    virtual std::vector<std::pair<dist_t, LabelType>>
    searchKnnCloserFirst(const void* query_data,
                         size_t k,
                         size_t ef,
                         const vsag::FilterPtr& is_id_allowed = nullptr) const;

    virtual void
    saveIndex(StreamWriter& writer) = 0;

    virtual size_t
    getMaxElements() = 0;

    virtual float
    getDistanceByLabel(LabelType label, const void* data_point) = 0;

    virtual float
    getDistanceByInternalId(uint32_t internal_id, const void* data_point) {
        return 0;
    }

    virtual float
    getSelfDistanceByInternalId(uint32_t internal_id) {
        return 0;
    }

    virtual tl::expected<vsag::DatasetPtr, vsag::Error>
    getBatchDistanceByLabel(const int64_t* ids, const void* data_point, int64_t count) = 0;

    virtual std::pair<int64_t, int64_t>
    getMinAndMaxId() = 0;

    virtual const float*
    getDataByLabel(LabelType label) const = 0;