ScalableVectorSearch/bindings/cpp/include/svs/runtime/dynamic_vamana_index.h at 55325e150d9e9bcbc0631d8995c1bae638b722ee · intel/ScalableVectorSearch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright 2025 Intel Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once
#include <svs/runtime/api_defs.h>
#include <svs/runtime/training.h>
#include <svs/runtime/vamana_index.h>

#include <cstddef>
#include <istream>
#include <ostream>

namespace svs {
namespace runtime {
inline namespace v0 {

// Abstract interface for Dynamic Vamana-based indexes.
struct SVS_RUNTIME_API DynamicVamanaIndex : public VamanaIndex {
    virtual Status add(size_t n, const size_t* labels, const float* x) noexcept = 0;
    virtual Status
    remove_selected(size_t* num_removed, const IDFilter& selector) noexcept = 0;
    virtual Status remove(size_t n, const size_t* labels) noexcept = 0;

    virtual Status reset() noexcept = 0;

    // Utility function to check storage kind support
    static Status check_storage_kind(StorageKind storage_kind) noexcept;

    static Status
    check_params(const VamanaIndex::DynamicIndexParams& dynamic_index_params) noexcept;

    // Static constructors and destructors
    // ABI backward compatibility
    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        const VamanaIndex::BuildParams& params = {},
        const VamanaIndex::SearchParams& default_search_params = {}
    ) noexcept;

    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        const VamanaIndex::BuildParams& params,
        const VamanaIndex::SearchParams& default_search_params,
        const VamanaIndex::DynamicIndexParams& dynamic_index_params
    ) noexcept;

    static Status destroy(DynamicVamanaIndex* index) noexcept;

    virtual Status save(std::ostream& out) const noexcept = 0;
    static Status load(
        DynamicVamanaIndex** index,
        std::istream& in,
        MetricType metric,
        StorageKind storage_kind
    ) noexcept;

    virtual size_t blocksize_bytes() const noexcept = 0;

    // Override for VamanaIndex interface
    Status add(size_t, const float*) noexcept override {
        return Status(
            ErrorCode::NOT_IMPLEMENTED,
            "Use add(size_t n, const size_t* labels, const float* x) for DynamicVamanaIndex"
        );
    }
};

struct SVS_RUNTIME_API DynamicVamanaIndexLeanVec : public DynamicVamanaIndex {
    // Specialization to build LeanVec-based Vamana index with specified leanvec dims
    // ABI backward compatibility
    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        size_t leanvec_dims,
        const VamanaIndex::BuildParams& params = {},
        const VamanaIndex::SearchParams& default_search_params = {}
    ) noexcept;

    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        size_t leanvec_dims,
        const VamanaIndex::BuildParams& params,
        const VamanaIndex::SearchParams& default_search_params,
        const VamanaIndex::DynamicIndexParams& dynamic_index_params
    ) noexcept;

    // Specialization to build LeanVec-based Vamana index with provided training data
    // ABI backward compatibility
    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        const LeanVecTrainingData* training_data,
        const VamanaIndex::BuildParams& params = {},
        const VamanaIndex::SearchParams& default_search_params = {}
    ) noexcept;

    static Status build(
        DynamicVamanaIndex** index,
        size_t dim,
        MetricType metric,
        StorageKind storage_kind,
        const LeanVecTrainingData* training_data,
        const VamanaIndex::BuildParams& params,
        const VamanaIndex::SearchParams& default_search_params,
        const VamanaIndex::DynamicIndexParams& dynamic_index_params
    ) noexcept;
};

} // namespace v0
} // namespace runtime
} // namespace svs