iridium-db 0.4.0

A high-performance vector-graph hybrid storage and indexing engine
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use std::cmp::{Ordering, Reverse};
use std::collections::{BinaryHeap, HashMap, HashSet};

/// A newtype around f64 implementing total-order Ord (via total_cmp), so it can be used
/// in BinaryHeap.  Larger value = higher priority (max-heap semantics by default).
#[derive(Debug, Clone, Copy, PartialEq)]
pub(super) struct OrderedF64(pub f64);

impl Eq for OrderedF64 {}

impl PartialOrd for OrderedF64 {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for OrderedF64 {
    fn cmp(&self, other: &Self) -> Ordering {
        self.0.total_cmp(&other.0)
    }
}

#[derive(Clone)]
struct HnswNode {
    #[allow(dead_code)]
    level: usize,
    /// `neighbors[layer]` = list of neighbor node IDs at that layer.
    neighbors: Vec<Vec<u64>>,
}

#[derive(Clone)]
pub struct HnswGraph {
    m: usize,
    m0: usize,
    ef_construction: usize,
    ml: f64,
    entry_point: Option<u64>,
    max_level: usize,
    nodes: HashMap<u64, HnswNode>,
    vectors: HashMap<u64, Vec<f32>>,
}

impl HnswGraph {
    pub fn new(m: usize, m0: usize, ef_construction: usize) -> Self {
        let ml = 1.0 / (m as f64).ln();
        Self {
            m,
            m0,
            ef_construction,
            ml,
            entry_point: None,
            max_level: 0,
            nodes: HashMap::new(),
            vectors: HashMap::new(),
        }
    }

    pub fn len(&self) -> usize {
        self.nodes.len()
    }

    pub fn is_empty(&self) -> bool {
        self.nodes.is_empty()
    }

    pub fn contains(&self, node_id: u64) -> bool {
        self.nodes.contains_key(&node_id)
    }

    /// Returns the dimensionality of stored vectors (from the first vector, if any).
    pub fn infer_dim(&self) -> Option<usize> {
        self.vectors.values().next().map(|v| v.len())
    }

    /// Iterate over all `(node_id, vector)` pairs stored in the graph.
    pub fn all_vectors(&self) -> impl Iterator<Item = (u64, &Vec<f32>)> {
        self.vectors.iter().map(|(id, vec)| (*id, vec))
    }

    /// Assign a random level using the HNSW level distribution.
    fn assign_level(&self, seed: u64) -> usize {
        let state = seed
            .wrapping_mul(6364136223846793005_u64)
            .wrapping_add(1442695040888963407_u64);
        // Map bits 40-63 to a float in (0, 1]
        let r = ((state >> 40) as f64) / ((1u64 << 24) as f64);
        let r = r.clamp(f64::MIN_POSITIVE, 1.0);
        let level = (-r.ln() * self.ml).floor() as usize;
        level.min(16)
    }

    /// Cosine distance = 1 - cosine_similarity.  Returns 1.0 for zero-norm vectors.
    fn cosine_distance(a: &[f32], b: &[f32]) -> f64 {
        if a.len() != b.len() || a.is_empty() {
            return 1.0;
        }
        let mut dot = 0.0_f64;
        let mut norm_a = 0.0_f64;
        let mut norm_b = 0.0_f64;
        for (x, y) in a.iter().zip(b.iter()) {
            let x = *x as f64;
            let y = *y as f64;
            dot += x * y;
            norm_a += x * x;
            norm_b += y * y;
        }
        if norm_a <= f64::EPSILON || norm_b <= f64::EPSILON {
            return 1.0;
        }
        let sim = (dot / (norm_a.sqrt() * norm_b.sqrt())).clamp(-1.0, 1.0);
        1.0 - sim
    }

    /// Standard HNSW greedy beam search at a single layer.
    ///
    /// Returns a max-heap of `(distance, node_id)` — the `ef` nearest nodes found.
    fn search_layer(
        &self,
        query: &[f32],
        entry_points: &[(u64, f64)],
        ef: usize,
        layer: usize,
    ) -> BinaryHeap<(OrderedF64, u64)> {
        let degree_hint = if layer == 0 { self.m0 } else { self.m };
        let entry_capacity = entry_points.len().max(1);
        let beam_capacity = ef.max(entry_capacity);
        let visited_capacity =
            entry_capacity.saturating_add(beam_capacity.saturating_mul(degree_hint.max(1)));
        let mut visited: HashSet<u64> = HashSet::with_capacity(visited_capacity);
        // min-heap of (dist, id) — process nearest candidates first
        let mut candidates: BinaryHeap<Reverse<(OrderedF64, u64)>> =
            BinaryHeap::with_capacity(beam_capacity);
        // max-heap of (dist, id) — keep the ef nearest found
        let mut found: BinaryHeap<(OrderedF64, u64)> = BinaryHeap::with_capacity(beam_capacity);
        let mut worst_found = f64::MAX;

        for &(ep_id, ep_dist) in entry_points {
            if visited.insert(ep_id) {
                candidates.push(Reverse((OrderedF64(ep_dist), ep_id)));
                worst_found =
                    Self::push_found_candidate(&mut found, ef, OrderedF64(ep_dist), ep_id);
            }
        }

        while let Some(Reverse((OrderedF64(c_dist), c_id))) = candidates.pop() {
            if c_dist > worst_found {
                break;
            }
            let Some(node) = self.nodes.get(&c_id) else {
                continue;
            };
            let Some(neighbors) = node.neighbors.get(layer) else {
                continue;
            };

            for &nbr_id in neighbors {
                if !visited.insert(nbr_id) {
                    continue;
                }
                let Some(nbr_vec) = self.vectors.get(&nbr_id) else {
                    continue;
                };

                let dist = Self::cosine_distance(query, nbr_vec);
                if found.len() >= ef && dist >= worst_found {
                    continue;
                }

                candidates.push(Reverse((OrderedF64(dist), nbr_id)));
                worst_found = Self::push_found_candidate(&mut found, ef, OrderedF64(dist), nbr_id);
            }
        }
        found
    }

    fn push_found_candidate(
        found: &mut BinaryHeap<(OrderedF64, u64)>,
        ef: usize,
        distance: OrderedF64,
        node_id: u64,
    ) -> f64 {
        found.push((distance, node_id));
        if found.len() > ef {
            found.pop();
        }
        found.peek().map(|(d, _)| d.0).unwrap_or(f64::MAX)
    }

    /// Simple neighbor selection: keep the `m_limit` closest candidates.
    fn select_neighbors(candidates: &[(u64, f64)], m_limit: usize) -> Vec<u64> {
        let mut sorted = candidates.to_vec();
        sorted.sort_by(|a, b| a.1.total_cmp(&b.1));
        sorted.truncate(m_limit);
        sorted.into_iter().map(|(id, _)| id).collect()
    }

    /// Insert a vector into the graph.  `rng` is used as the level-assignment seed.
    /// If `node_id` already exists the vector is updated but topology is unchanged.
    pub fn insert(&mut self, node_id: u64, vector: Vec<f32>, rng: u64) {
        if self.nodes.contains_key(&node_id) {
            self.vectors.insert(node_id, vector);
            return;
        }

        let level = self.assign_level(rng);
        self.vectors.insert(node_id, vector.clone());

        let mut node = HnswNode {
            level,
            neighbors: vec![Vec::new(); level + 1],
        };

        let Some(ep) = self.entry_point else {
            self.nodes.insert(node_id, node);
            self.entry_point = Some(node_id);
            self.max_level = level;
            return;
        };

        let ep_dist = Self::cosine_distance(
            &vector,
            self.vectors.get(&ep).expect("entry point has vector"),
        );
        let mut current_ep: Vec<(u64, f64)> = vec![(ep, ep_dist)];

        let top_level = self.max_level;

        // Greedy descent from top_level to level+1 (if any).
        for lc in (level + 1..=top_level).rev() {
            let found = self.search_layer(&vector, &current_ep, 1, lc);
            let best = found.into_sorted_vec().into_iter().next();
            if let Some((OrderedF64(d), best_id)) = best {
                current_ep = vec![(best_id, d)];
            }
        }

        // Insert at each layer from min(level, top_level) down to 0.
        for lc in (0..=level.min(top_level)).rev() {
            let found = self.search_layer(&vector, &current_ep, self.ef_construction, lc);

            let mut candidates: Vec<(u64, f64)> = found
                .into_iter()
                .map(|(OrderedF64(d), id)| (id, d))
                .collect();
            candidates.sort_by(|a, b| a.1.total_cmp(&b.1));

            // Update entry points for the next (lower) layer
            current_ep = candidates.iter().map(|&(id, d)| (id, d)).collect();

            let m_max = if lc == 0 { self.m0 } else { self.m };
            let neighbors = Self::select_neighbors(&candidates, m_max);

            node.neighbors[lc] = neighbors.clone();

            // Bidirectional links + pruning
            for &nbr_id in &neighbors {
                if let Some(nbr_node) = self.nodes.get_mut(&nbr_id) {
                    if lc < nbr_node.neighbors.len() && !nbr_node.neighbors[lc].contains(&node_id) {
                        nbr_node.neighbors[lc].push(node_id);
                        if nbr_node.neighbors[lc].len() > m_max {
                            if let Some(nbr_vec) = self.vectors.get(&nbr_id).cloned() {
                                let mut nbr_cands: Vec<(u64, f64)> = nbr_node.neighbors[lc]
                                    .iter()
                                    .filter_map(|&id| {
                                        self.vectors
                                            .get(&id)
                                            .map(|v| (id, Self::cosine_distance(&nbr_vec, v)))
                                    })
                                    .collect();
                                nbr_cands.sort_by(|a, b| a.1.total_cmp(&b.1));
                                nbr_cands.truncate(m_max);
                                nbr_node.neighbors[lc] =
                                    nbr_cands.into_iter().map(|(id, _)| id).collect();
                            }
                        }
                    }
                }
            }
        }

        self.nodes.insert(node_id, node);

        if level > top_level {
            self.entry_point = Some(node_id);
            self.max_level = level;
        }
    }

    /// Search for the k nearest neighbors.
    /// Returns `(node_id, cosine_similarity)` pairs sorted by similarity descending.
    pub fn search(&self, query: &[f32], k: usize, ef: usize) -> Vec<(u64, f64)> {
        if self.nodes.is_empty() || k == 0 {
            return Vec::new();
        }
        let Some(ep) = self.entry_point else {
            return Vec::new();
        };
        let ep_dist = Self::cosine_distance(
            query,
            self.vectors.get(&ep).expect("entry point has vector"),
        );
        let mut current_ep: Vec<(u64, f64)> = vec![(ep, ep_dist)];

        // Greedy descent to level 1
        for lc in (1..=self.max_level).rev() {
            let found = self.search_layer(query, &current_ep, 1, lc);
            let best = found.into_sorted_vec().into_iter().next();
            if let Some((OrderedF64(d), best_id)) = best {
                current_ep = vec![(best_id, d)];
            }
        }

        // Full search at level 0
        let found = self.search_layer(query, &current_ep, ef.max(k), 0);
        let mut results: Vec<(u64, f64)> = found
            .into_iter()
            .map(|(OrderedF64(dist), id)| (id, 1.0 - dist))
            .collect();
        results.sort_by(|a, b| b.1.total_cmp(&a.1));
        results.truncate(k);
        results
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn synthetic_vector(seed: u64, dim: usize) -> Vec<f32> {
        let mut state = seed.wrapping_mul(6364136223846793005).wrapping_add(1);
        let mut out = Vec::with_capacity(dim);
        for _ in 0..dim {
            state = state
                .wrapping_mul(6364136223846793005)
                .wrapping_add(1442695040888963407);
            let v = ((state >> 40) as f32) / ((1u64 << 24) as f32);
            out.push((v * 2.0) - 1.0);
        }
        out
    }

    #[test]
    fn hnsw_search_empty_returns_empty() {
        let graph = HnswGraph::new(16, 32, 200);
        let query = vec![1.0_f32, 0.0, 0.0, 0.0];
        assert!(graph.search(&query, 5, 64).is_empty());
    }

    #[test]
    fn hnsw_search_respects_k() {
        let mut graph = HnswGraph::new(16, 32, 200);
        for i in 0..50u64 {
            graph.insert(i, synthetic_vector(i, 4), i);
        }
        let query = synthetic_vector(999, 4);
        let results = graph.search(&query, 3, 64);
        assert_eq!(results.len(), 3);
    }

    #[test]
    fn hnsw_insert_and_search_returns_nearest() {
        let dim = 4;
        let mut graph = HnswGraph::new(16, 32, 200);
        let mut vecs: Vec<(u64, Vec<f32>)> = Vec::new();

        for i in 0..100u64 {
            let v = synthetic_vector(i * 7 + 13, dim);
            graph.insert(i, v.clone(), i);
            vecs.push((i, v));
        }

        // Build centroid
        let mut centroid = vec![0.0_f32; dim];
        for (_, v) in &vecs {
            for (c, x) in centroid.iter_mut().zip(v.iter()) {
                *c += x;
            }
        }
        for c in centroid.iter_mut() {
            *c /= vecs.len() as f32;
        }

        // Find the true nearest by brute force
        let true_nearest = vecs
            .iter()
            .map(|(id, v)| {
                let d = OrderedF64(HnswGraph::cosine_distance(&centroid, v));
                (d, *id)
            })
            .min()
            .map(|(_, id)| id)
            .unwrap();

        let results = graph.search(&centroid, 5, 64);
        assert!(!results.is_empty(), "search returned no results");
        let returned_ids: Vec<u64> = results.iter().map(|(id, _)| *id).collect();
        assert!(
            returned_ids.contains(&true_nearest),
            "true nearest {} not in top-5: {:?}",
            true_nearest,
            returned_ids
        );
    }

    #[test]
    fn hnsw_repeated_search_is_deterministic_and_unique() {
        let mut graph = HnswGraph::new(16, 32, 200);
        for i in 0..128u64 {
            graph.insert(i, synthetic_vector(i * 11 + 5, 8), i);
        }
        let query = synthetic_vector(777, 8);
        let first = graph.search(&query, 16, 64);
        let second = graph.search(&query, 16, 64);

        assert_eq!(first, second, "repeated HNSW search drifted");
        let ids: std::collections::HashSet<u64> = first.iter().map(|(id, _)| *id).collect();
        assert_eq!(ids.len(), first.len(), "HNSW search returned duplicates");
    }
}