holographic-memory 0.6.0

A high-performance Holographic Memory System (HMS) implementing Vector Symbolic Architectures (VSA).
Documentation
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
// Copyright 2024-2026 WritersLogic Contributors
// SPDX-License-Identifier: AGPL-3.0-or-later

use std::collections::BinaryHeap;
use std::sync::atomic::{AtomicU64, Ordering as AtomicOrdering};

use anyhow::Result;
use fxhash::{FxHashMap, FxHasher};
use parking_lot::RwLock;
use rayon::prelude::*;
use std::hash::Hasher;

use crate::core::entangled::EntangledHVec;
use crate::core::hopfield::{hopfield_query, HopfieldConfig};
use crate::core::index::inverted::{Accumulator, SparseInvertedIndex};
use crate::core::ivf::IVFIndex;
use crate::core::nsg::NSGIndex;
use crate::core::types::{QueryExplanation, RetrievalResult};

use super::router;

/// Per-shard state: vectors, registry, and indices.
/// Lock ordering within a shard: vectors -> ivf -> nsg.
pub(crate) struct Shard {
    pub vectors: RwLock<FxHashMap<String, EntangledHVec>>,
    pub registry: RwLock<Vec<String>>,
    slots: RwLock<FxHashMap<String, u32>>,
    free_slots: parking_lot::Mutex<Vec<u32>>,
    pub inverted: RwLock<SparseInvertedIndex>,
    pub accumulator: parking_lot::Mutex<Accumulator>,
    pub nsg: RwLock<Option<NSGIndex>>,
    pub ivf: RwLock<Option<IVFIndex>>,
    pub vector_count: AtomicU64,
}

impl Shard {
    pub fn new(dimensions: usize) -> Self {
        let m = (dimensions / 256).max(1);
        Self {
            vectors: RwLock::new(FxHashMap::default()),
            registry: RwLock::new(Vec::new()),
            slots: RwLock::new(FxHashMap::default()),
            free_slots: parking_lot::Mutex::new(Vec::new()),
            inverted: RwLock::new(SparseInvertedIndex::new(dimensions, m)),
            accumulator: parking_lot::Mutex::new(Accumulator::new(1024)),
            nsg: RwLock::new(None),
            ivf: RwLock::new(None),
            vector_count: AtomicU64::new(0),
        }
    }

    pub fn insert(&self, id: String, vector: EntangledHVec, _dimensions: usize) -> Result<()> {
        let mut vectors = self.vectors.write();
        let mut registry = self.registry.write();
        let mut slots = self.slots.write();
        let mut inverted = self.inverted.write();
        let old = vectors.insert(id.clone(), vector.clone());
        let slot = if let Some(&slot) = slots.get(&id) {
            if let Some(old) = &old {
                inverted.remove_doc(slot, old.indices());
            }
            slot
        } else if let Some(slot) = self.free_slots.lock().pop() {
            registry[slot as usize] = id.clone();
            slot
        } else {
            registry.push(id.clone());
            (registry.len() - 1) as u32
        };
        slots.insert(id.clone(), slot);
        inverted.add_doc(slot, vector.indices());
        self.vector_count
            .store(vectors.len() as u64, AtomicOrdering::Release);
        drop(inverted);
        drop(slots);
        drop(registry);
        drop(vectors);
        if old.is_some() {
            *self.ivf.write() = None;
            *self.nsg.write() = None;
        } else {
            let mut ivf = self.ivf.write();
            if let Some(index) = ivf.as_mut() {
                if let Err(error) = index.insert(&id, &vector) {
                    tracing::warn!(%error, "IVF invalidated after failed online insertion");
                    *ivf = None;
                }
            }
            let mut nsg = self.nsg.write();
            if let Some(index) = nsg.as_mut() {
                if let Err(error) = index.insert(&id, &vector) {
                    tracing::warn!(%error, "NSG invalidated after failed online insertion");
                    *nsg = None;
                }
            }
        }
        Ok(())
    }

    pub fn remove(&self, id: &str, _dimensions: usize) -> Result<bool> {
        let mut vectors = self.vectors.write();
        let Some(old) = vectors.remove(id) else {
            return Ok(false);
        };
        let mut registry = self.registry.write();
        if let Some(slot) = self.slots.write().remove(id) {
            self.inverted.write().remove_doc(slot, old.indices());
            registry[slot as usize].clear();
            self.free_slots.lock().push(slot);
        }
        self.vector_count
            .store(vectors.len() as u64, AtomicOrdering::Release);
        *self.ivf.write() = None;
        *self.nsg.write() = None;
        Ok(true)
    }

    pub fn rebuild_inverted_index(&self, dimensions: usize) -> Result<()> {
        let vectors = self.vectors.read();
        let registry = self.registry.read();
        let mut slots = self.slots.write();
        slots.clear();
        self.free_slots.lock().clear();
        let mut inv = self.inverted.write();

        *inv = SparseInvertedIndex::new(dimensions, (dimensions / 256).max(1));

        for (i, id) in registry.iter().enumerate() {
            if let Some(vec) = vectors.get(id) {
                slots.insert(id.clone(), i as u32);
                inv.add_doc(i as u32, &vec.indices);
            }
        }
        inv.finalize();

        let mut acc = self.accumulator.lock();
        *acc = Accumulator::new(registry.len().max(1024));

        Ok(())
    }

    pub fn load_all_vectors(&self) -> (Vec<String>, Vec<EntangledHVec>) {
        let vectors = self.vectors.read();
        let registry = self.registry.read();
        let mut ids = Vec::with_capacity(registry.len());
        let mut out_vectors = Vec::with_capacity(registry.len());

        for id in registry.iter() {
            if let Some(vec) = vectors.get(id) {
                ids.push(id.clone());
                out_vectors.push(vec.clone());
            }
        }

        (ids, out_vectors)
    }

    pub fn query(
        &self,
        query_vec: &EntangledHVec,
        k: u32,
        dimensions: usize,
    ) -> Vec<RetrievalResult> {
        let n = self.vector_count.load(AtomicOrdering::SeqCst) as usize;

        let planner =
            router::QueryPlanner::new(self.nsg_trained(), n > 0, self.ivf_trained(), n, dimensions);
        let plan = planner.plan(query_vec, k);

        let vectors = self.vectors.read();

        match plan.route {
            router::IndexRoute::NSG => {
                if let Some(ref nsg) = *self.nsg.read() {
                    let results: Vec<RetrievalResult> = nsg
                        .query(query_vec, k as usize, plan.ef_search)
                        .into_iter()
                        .filter(|r| vectors.contains_key(&r.id))
                        .collect();
                    if !results.is_empty() {
                        return results;
                    }
                }
            }
            router::IndexRoute::Inverted => {
                let mut acc = self.accumulator.lock();
                let results = self
                    .inverted
                    .read()
                    .query(&query_vec.indices, k as usize, &mut acc);

                let reg = self.registry.read();
                let mapped: Vec<RetrievalResult> = results
                    .into_iter()
                    .filter_map(|r| {
                        let doc_id: u32 = r.id.parse().ok()?;
                        let id_str = reg.get(doc_id as usize)?;
                        if vectors.contains_key(id_str) {
                            Some(RetrievalResult {
                                id: id_str.clone(),
                                similarity: r.similarity,
                            })
                        } else {
                            None
                        }
                    })
                    .collect();

                if !mapped.is_empty() {
                    return mapped;
                }
            }
            router::IndexRoute::IVF => {
                if let Some(ref ivf) = *self.ivf.read() {
                    if let Ok(candidates) = ivf.query(query_vec, k as usize, plan.n_probe) {
                        let reranked =
                            Self::rerank_by_exact_similarity(&vectors, query_vec, &candidates);
                        if !reranked.is_empty() {
                            return reranked;
                        }
                    }
                }
            }
            router::IndexRoute::Hopfield => {
                let patterns: Vec<(String, EntangledHVec)> = vectors
                    .iter()
                    .map(|(id, vec)| (id.clone(), vec.clone()))
                    .collect();
                let config = HopfieldConfig::default();
                let results = hopfield_query(query_vec, &patterns, &config, k as usize);
                if !results.is_empty() {
                    return results;
                }
            }
            router::IndexRoute::BruteForce => {
                return Self::brute_force_scan(&vectors, query_vec, k as usize);
            }
        }

        Self::brute_force_scan(&vectors, query_vec, k as usize)
    }

    fn rerank_by_exact_similarity(
        vectors: &FxHashMap<String, EntangledHVec>,
        query_vec: &EntangledHVec,
        candidates: &[RetrievalResult],
    ) -> Vec<RetrievalResult> {
        let mut results: Vec<RetrievalResult> = candidates
            .iter()
            .filter_map(|c| {
                let vec = vectors.get(&c.id)?;
                Some(RetrievalResult {
                    id: c.id.clone(),
                    similarity: query_vec.similarity(vec),
                })
            })
            .collect();

        results.sort_unstable_by(|a, b| {
            b.similarity
                .partial_cmp(&a.similarity)
                .unwrap_or(std::cmp::Ordering::Equal)
        });
        results
    }

    fn brute_force_scan(
        vectors: &FxHashMap<String, EntangledHVec>,
        query_vec: &EntangledHVec,
        k: usize,
    ) -> Vec<RetrievalResult> {
        let mut heap: BinaryHeap<RetrievalResult> = BinaryHeap::with_capacity(k + 1);

        for (id, vec) in vectors.iter() {
            let sim = query_vec.similarity(vec);

            if heap.len() < k {
                heap.push(RetrievalResult {
                    similarity: sim,
                    id: id.clone(),
                });
            } else if let Some(top) = heap.peek() {
                if sim > top.similarity {
                    heap.pop();
                    heap.push(RetrievalResult {
                        similarity: sim,
                        id: id.clone(),
                    });
                }
            }
        }

        let mut results = heap.into_sorted_vec();
        results.reverse();
        results
    }

    pub fn nsg_trained(&self) -> bool {
        self.nsg.read().as_ref().is_some_and(|nsg| nsg.is_trained())
    }

    pub fn ivf_trained(&self) -> bool {
        self.ivf.read().as_ref().is_some_and(|ivf| ivf.is_trained())
    }

    pub fn count(&self) -> u64 {
        self.vector_count.load(AtomicOrdering::SeqCst)
    }
}

/// Multi-shard coordinator. Distributes vectors by consistent hash of ID.
pub(crate) struct ShardManager {
    pub shards: Vec<Shard>,
}

impl ShardManager {
    pub fn new(shard_count: usize, dimensions: usize) -> Self {
        assert!(shard_count >= 2, "ShardManager requires at least 2 shards");
        let shards = (0..shard_count).map(|_| Shard::new(dimensions)).collect();
        Self { shards }
    }

    pub fn shard_for(&self, id: &str) -> usize {
        let mut hasher = FxHasher::default();
        hasher.write(id.as_bytes());
        (hasher.finish() as usize) % self.shards.len()
    }

    pub fn shard(&self, id: &str) -> &Shard {
        &self.shards[self.shard_for(id)]
    }

    pub fn query(
        &self,
        query_vec: &EntangledHVec,
        k: u32,
        dimensions: usize,
    ) -> Vec<RetrievalResult> {
        let per_shard: Vec<Vec<RetrievalResult>> = self
            .shards
            .par_iter()
            .map(|shard| shard.query(query_vec, k, dimensions))
            .collect();

        let mut heap: BinaryHeap<RetrievalResult> = BinaryHeap::with_capacity(k as usize + 1);
        for results in per_shard {
            for r in results {
                heap.push(r);
                if heap.len() > k as usize {
                    heap.pop();
                }
            }
        }
        let mut merged = heap.into_sorted_vec();
        merged.reverse();
        merged
    }

    pub fn total_count(&self) -> u64 {
        self.shards.iter().map(|s| s.count()).sum()
    }

    pub fn nsg_trained(&self) -> bool {
        self.shards.iter().all(|s| s.nsg_trained())
    }

    pub fn ivf_trained(&self) -> bool {
        self.shards.iter().all(|s| s.ivf_trained())
    }
}

/// Wrapper that transparently handles single vs multi-shard operation.
pub(crate) enum ShardSet {
    Single(Box<Shard>),
    Multi(ShardManager),
}

impl ShardSet {
    pub fn insert(&self, id: String, vector: EntangledHVec, dimensions: usize) -> Result<()> {
        match self {
            ShardSet::Single(shard) => shard.insert(id, vector, dimensions),
            ShardSet::Multi(mgr) => mgr.shard(&id).insert(id, vector, dimensions),
        }
    }

    pub fn remove(&self, id: &str, dimensions: usize) -> Result<bool> {
        match self {
            ShardSet::Single(shard) => shard.remove(id, dimensions),
            ShardSet::Multi(mgr) => mgr.shard(id).remove(id, dimensions),
        }
    }

    pub fn query(
        &self,
        query_vec: &EntangledHVec,
        k: u32,
        dimensions: usize,
    ) -> Vec<RetrievalResult> {
        match self {
            ShardSet::Single(shard) => shard.query(query_vec, k, dimensions),
            ShardSet::Multi(mgr) => mgr.query(query_vec, k, dimensions),
        }
    }

    pub fn explain_query(
        &self,
        query_vec: &EntangledHVec,
        k: u32,
        dimensions: usize,
    ) -> QueryExplanation {
        let count = self.count() as usize;
        let nsg = self.nsg_trained();
        let ivf = self.ivf_trained();
        let plan =
            router::QueryPlanner::new(nsg, count > 0, ivf, count, dimensions).plan(query_vec, k);
        QueryExplanation {
            route: plan.route.as_str().to_string(),
            vector_count: count.min(u32::MAX as usize) as u32,
            query_nonzero_dimensions: query_vec.indices.len().min(u32::MAX as usize) as u32,
            requested_results: k,
            ef_search: plan.ef_search as u32,
            n_probe: plan.n_probe as u32,
            nsg_available: nsg,
            ivf_available: ivf,
            rationale: plan.rationale.to_string(),
        }
    }

    pub fn count(&self) -> u64 {
        match self {
            ShardSet::Single(shard) => shard.count(),
            ShardSet::Multi(mgr) => mgr.total_count(),
        }
    }

    pub fn nsg_trained(&self) -> bool {
        match self {
            ShardSet::Single(shard) => shard.nsg_trained(),
            ShardSet::Multi(mgr) => mgr.nsg_trained(),
        }
    }

    pub fn ivf_trained(&self) -> bool {
        match self {
            ShardSet::Single(shard) => shard.ivf_trained(),
            ShardSet::Multi(mgr) => mgr.ivf_trained(),
        }
    }

    pub fn get_vector(&self, id: &str) -> Option<EntangledHVec> {
        match self {
            ShardSet::Single(shard) => shard.vectors.read().get(id).cloned(),
            ShardSet::Multi(mgr) => mgr.shard(id).vectors.read().get(id).cloned(),
        }
    }

    pub fn for_each_shard<F: FnMut(&Shard)>(&self, mut f: F) {
        match self {
            ShardSet::Single(shard) => f(shard),
            ShardSet::Multi(mgr) => {
                for shard in &mgr.shards {
                    f(shard);
                }
            }
        }
    }

    pub fn collect_all_patterns(&self) -> Vec<(String, EntangledHVec)> {
        let mut patterns = Vec::new();
        self.for_each_shard(|shard| {
            let vectors = shard.vectors.read();
            patterns.extend(vectors.iter().map(|(id, vec)| (id.clone(), vec.clone())));
        });
        patterns
    }

    pub fn try_for_each_shard<F: FnMut(&Shard) -> Result<()>>(&self, mut f: F) -> Result<()> {
        match self {
            ShardSet::Single(shard) => f(shard),
            ShardSet::Multi(mgr) => {
                for shard in &mgr.shards {
                    f(shard)?;
                }
                Ok(())
            }
        }
    }

    /// Number of shards backing this set (1 for the single-shard case).
    pub fn shard_count(&self) -> usize {
        match self {
            ShardSet::Single(_) => 1,
            ShardSet::Multi(mgr) => mgr.shards.len(),
        }
    }

    /// Like `try_for_each_shard`, but also passes each shard's index so callers
    /// can address per-shard on-disk artifacts.
    pub fn try_for_each_shard_indexed<F: FnMut(usize, &Shard) -> Result<()>>(
        &self,
        mut f: F,
    ) -> Result<()> {
        match self {
            ShardSet::Single(shard) => f(0, shard),
            ShardSet::Multi(mgr) => {
                for (i, shard) in mgr.shards.iter().enumerate() {
                    f(i, shard)?;
                }
                Ok(())
            }
        }
    }
}