shodh-redb 0.3.0

Multi-modal embedded database - vectors, blobs, TTL, merge operators, and causal tracking built on ACID B-trees
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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
use alloc::collections::BinaryHeap;
use alloc::vec::Vec;
use core::cmp::Ordering as CmpOrdering;

use crate::TableDefinition;
use crate::error::StorageError;
use crate::probe_select::DiversityConfig;
use crate::storage_traits::{ReadTable, StorageRead, StorageWrite, WriteTable};
use crate::vector_ops::{DistanceMetric, Neighbor, l2_normalize};

use crate::ivfpq::adc::AdcTable;
use crate::ivfpq::types::PostingKey;

use super::cluster::TableNames;
use super::config::FractalSearchParams;
use super::index::{FractalIndex, ReadOnlyFractalIndex};
use super::types::{ClusterMeta, HierarchyKey};

/// Safely read a little-endian `f32` from `data` at `offset`.
/// Returns `0.0` if the slice is out of bounds or not exactly 4 bytes.
fn read_f32_le(data: &[u8], offset: usize) -> f32 {
    data.get(offset..offset + 4)
        .and_then(|s| s.try_into().ok())
        .map_or(0.0, f32::from_le_bytes)
}

// ---------------------------------------------------------------------------
// CandidateHeap -- fixed-capacity max-heap for top-K selection
// ---------------------------------------------------------------------------

struct CandidateEntry {
    vector_id: u64,
    distance: f32,
}

impl PartialEq for CandidateEntry {
    fn eq(&self, other: &Self) -> bool {
        self.distance == other.distance
    }
}

impl Eq for CandidateEntry {}

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

impl Ord for CandidateEntry {
    fn cmp(&self, other: &Self) -> CmpOrdering {
        // Max-heap: worst (largest) distance at top for eviction
        self.distance.total_cmp(&other.distance)
    }
}

struct CandidateHeap {
    capacity: usize,
    heap: BinaryHeap<CandidateEntry>,
}

impl CandidateHeap {
    fn new(capacity: usize) -> Self {
        Self {
            capacity,
            heap: BinaryHeap::with_capacity(capacity + 1),
        }
    }

    fn push(&mut self, vector_id: u64, distance: f32) {
        if self.heap.len() < self.capacity {
            self.heap.push(CandidateEntry {
                vector_id,
                distance,
            });
        } else if let Some(worst) = self.heap.peek()
            && distance < worst.distance
        {
            self.heap.pop();
            self.heap.push(CandidateEntry {
                vector_id,
                distance,
            });
        }
    }

    fn into_sorted(self, k: usize) -> Vec<Neighbor<u64>> {
        let mut entries: Vec<_> = self.heap.into_vec();
        entries.sort_by(|a, b| a.distance.total_cmp(&b.distance));
        entries
            .into_iter()
            .take(k)
            .map(|e| Neighbor {
                key: e.vector_id,
                distance: e.distance,
            })
            .collect()
    }
}

// ---------------------------------------------------------------------------
// Search implementation -- write transaction path
// ---------------------------------------------------------------------------

pub(crate) fn search_write<T: StorageWrite>(
    idx: &mut FractalIndex<'_, T>,
    query: &[f32],
    params: &FractalSearchParams,
) -> crate::Result<Vec<Neighbor<u64>>> {
    let dim = idx.config.dim as usize;
    if query.len() != dim {
        return Err(StorageError::Corrupted(alloc::format!(
            "fractal: search query dim mismatch: expected {dim}, got {}",
            query.len(),
        )));
    }

    let q = if idx.config.metric == DistanceMetric::Cosine {
        // Zero-norm query in cosine space is undefined (division by zero
        // in the distance computation). Return empty results rather than
        // producing arbitrary rankings.
        if crate::vector_ops::l2_norm(query) == 0.0 {
            return Ok(Vec::new());
        }
        let mut v = query.to_vec();
        l2_normalize(&mut v);
        v
    } else {
        query.to_vec()
    };

    let codebooks = idx.codebooks.as_ref().ok_or_else(|| {
        StorageError::Corrupted(alloc::string::String::from(
            "fractal: search called on index without codebooks",
        ))
    })?;
    let adc = AdcTable::build(&q, codebooks, idx.config.metric);
    let nprobe = params.nprobe.max(1);
    let heap_cap = if params.rerank {
        params.candidates
    } else {
        params.k
    };
    let mut heap = CandidateHeap::new(heap_cap);

    // Collect leaf clusters to scan via beam search
    let leaves = beam_search_leaves_write(
        idx.txn,
        &idx.names,
        &idx.config,
        idx.config.root_cluster_id,
        &q,
        nprobe,
        params.min_hlc,
        params.diversity,
    )?;

    // Scan posting lists and buffers of selected leaves
    let postings_def = TableDefinition::<PostingKey, &[u8]>::new(&idx.names.postings);
    let buffer_def = TableDefinition::<PostingKey, &[u8]>::new(&idx.names.buffer);

    let ptbl = idx.txn.open_storage_table(postings_def)?;
    let btbl = idx.txn.open_storage_table(buffer_def)?;

    for leaf_id in &leaves {
        // Scan posting list with ADC
        let start = PostingKey::cluster_start(*leaf_id);
        let end = PostingKey::cluster_end(*leaf_id);
        let range = ptbl.st_range(Some(&start), Some(&end), true, true)?;
        for entry in range {
            let (key, val) = entry?;
            let vid = key.value().vector_id;
            let pq_codes = val.value();
            let dist = adc.approximate_distance(pq_codes);
            heap.push(vid, dist);
        }

        // Scan buffer with exact distance
        let brange = btbl.st_range(Some(&start), Some(&end), true, true)?;
        for entry in brange {
            let (key, val) = entry?;
            let vid = key.value().vector_id;
            let bytes = val.value();
            if bytes.len() < dim * 4 {
                continue;
            }
            let vec: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
            let dist = idx.config.metric.compute(&q, &vec);
            heap.push(vid, dist);
        }
    }

    drop(ptbl);
    drop(btbl);

    // Rerank with raw vectors if available
    if params.rerank && idx.config.store_raw_vectors {
        let candidates = heap.into_sorted(params.candidates);
        let vectors_def = TableDefinition::<u64, &[u8]>::new(&idx.names.vectors);
        let vtbl = idx.txn.open_storage_table(vectors_def)?;

        let mut reranked: Vec<Neighbor<u64>> = Vec::with_capacity(candidates.len());
        for c in &candidates {
            if let Some(g) = vtbl.st_get(&c.key)? {
                let bytes = g.value();
                if bytes.len() < dim * 4 {
                    reranked.push(Neighbor {
                        key: c.key,
                        distance: c.distance,
                    });
                    continue;
                }
                let vec: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
                let dist = idx.config.metric.compute(&q, &vec);
                reranked.push(Neighbor {
                    key: c.key,
                    distance: dist,
                });
            } else {
                reranked.push(Neighbor {
                    key: c.key,
                    distance: c.distance,
                });
            }
        }
        reranked.sort_by(|a, b| a.distance.total_cmp(&b.distance));
        reranked.truncate(params.k);
        Ok(reranked)
    } else {
        Ok(heap.into_sorted(params.k))
    }
}

// ---------------------------------------------------------------------------
// Search implementation -- read transaction path
// ---------------------------------------------------------------------------

pub(crate) fn search_read<R: StorageRead>(
    idx: &ReadOnlyFractalIndex,
    txn: &R,
    query: &[f32],
    params: &FractalSearchParams,
) -> crate::Result<Vec<Neighbor<u64>>> {
    let dim = idx.config.dim as usize;
    if query.len() != dim {
        return Err(StorageError::Corrupted(alloc::format!(
            "fractal: search query dim mismatch: expected {dim}, got {}",
            query.len(),
        )));
    }

    let q = if idx.config.metric == DistanceMetric::Cosine {
        // Zero-norm query in cosine space is undefined (division by zero
        // in the distance computation). Return empty results rather than
        // producing arbitrary rankings.
        if crate::vector_ops::l2_norm(query) == 0.0 {
            return Ok(Vec::new());
        }
        let mut v = query.to_vec();
        l2_normalize(&mut v);
        v
    } else {
        query.to_vec()
    };

    let adc = AdcTable::build(&q, &idx.codebooks, idx.config.metric);
    let nprobe = params.nprobe.max(1);
    let heap_cap = if params.rerank {
        params.candidates
    } else {
        params.k
    };
    let mut heap = CandidateHeap::new(heap_cap);

    let leaves = beam_search_leaves_read(
        txn,
        &idx.names,
        &idx.config,
        idx.config.root_cluster_id,
        &q,
        nprobe,
        params.min_hlc,
        params.diversity,
    )?;

    let postings_def = TableDefinition::<PostingKey, &[u8]>::new(&idx.names.postings);
    let buffer_def = TableDefinition::<PostingKey, &[u8]>::new(&idx.names.buffer);

    let ptbl = txn.open_storage_table(postings_def)?;
    let btbl = txn.open_storage_table(buffer_def)?;

    for leaf_id in &leaves {
        let start = PostingKey::cluster_start(*leaf_id);
        let end = PostingKey::cluster_end(*leaf_id);
        let range = ptbl.st_range(Some(&start), Some(&end), true, true)?;
        for entry in range {
            let (key, val) = entry?;
            let vid = key.value().vector_id;
            let pq_codes = val.value();
            let dist = adc.approximate_distance(pq_codes);
            heap.push(vid, dist);
        }

        let brange = btbl.st_range(Some(&start), Some(&end), true, true)?;
        for entry in brange {
            let (key, val) = entry?;
            let vid = key.value().vector_id;
            let bytes = val.value();
            if bytes.len() < dim * 4 {
                continue;
            }
            let vec: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
            let dist = idx.config.metric.compute(&q, &vec);
            heap.push(vid, dist);
        }
    }

    drop(ptbl);
    drop(btbl);

    if params.rerank && idx.config.store_raw_vectors {
        let candidates = heap.into_sorted(params.candidates);
        let vectors_def = TableDefinition::<u64, &[u8]>::new(&idx.names.vectors);
        let vtbl = txn.open_storage_table(vectors_def)?;

        let mut reranked: Vec<Neighbor<u64>> = Vec::with_capacity(candidates.len());
        for c in &candidates {
            if let Some(g) = vtbl.st_get(&c.key)? {
                let bytes = g.value();
                if bytes.len() < dim * 4 {
                    reranked.push(Neighbor {
                        key: c.key,
                        distance: c.distance,
                    });
                    continue;
                }
                let vec: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
                let dist = idx.config.metric.compute(&q, &vec);
                reranked.push(Neighbor {
                    key: c.key,
                    distance: dist,
                });
            } else {
                reranked.push(Neighbor {
                    key: c.key,
                    distance: c.distance,
                });
            }
        }
        reranked.sort_by(|a, b| a.distance.total_cmp(&b.distance));
        reranked.truncate(params.k);
        Ok(reranked)
    } else {
        Ok(heap.into_sorted(params.k))
    }
}

// ---------------------------------------------------------------------------
// Beam search helpers
// ---------------------------------------------------------------------------

/// Beam search: walk the cluster tree from root to leaves, selecting the
/// best `nprobe` children at each internal level.
#[allow(clippy::too_many_arguments)]
fn beam_search_leaves_write<T: StorageWrite>(
    txn: &T,
    names: &TableNames,
    config: &super::config::FractalIndexConfig,
    root: u32,
    query: &[f32],
    nprobe: u32,
    min_hlc: u64,
    diversity: DiversityConfig,
) -> crate::Result<Vec<u32>> {
    let dim = config.dim as usize;
    let clusters_def = TableDefinition::<u32, &[u8]>::new(&names.clusters);
    let centroids_def = TableDefinition::<u32, &[u8]>::new(&names.centroids);
    let hier_def = TableDefinition::<HierarchyKey, ()>::new(&names.hierarchy);

    let mut current_level = alloc::vec![root];
    let mut leaves: Vec<u32> = Vec::new();
    // Guard against infinite traversal due to corrupted hierarchy.
    // Use twice the configured max_depth as a generous bound.
    let max_levels = (config.max_depth as usize).saturating_mul(2).max(64);
    let mut level_count: usize = 0;

    loop {
        level_count += 1;
        if level_count > max_levels {
            break;
        }

        let mut next_level: Vec<(u32, f32)> = Vec::new();
        let mut next_centroids: Vec<f32> = Vec::new();
        let collect_centroids = diversity.enabled();

        for &node_id in &current_level {
            let meta = {
                let ctbl = txn.open_storage_table(clusters_def)?;
                match ctbl.st_get(&node_id)? {
                    Some(g) => ClusterMeta::from_bytes(g.value()),
                    None => continue,
                }
            };

            if meta.is_leaf() {
                // Apply temporal filter
                if min_hlc > 0 && meta.newest_hlc() > 0 && meta.newest_hlc() < min_hlc {
                    continue;
                }
                leaves.push(node_id);
                continue;
            }

            // Internal: collect children with distances
            let htbl = txn.open_storage_table(hier_def)?;
            let ctbl = txn.open_storage_table(centroids_def)?;
            let cltbl = txn.open_storage_table(clusters_def)?;

            let hstart = HierarchyKey::children_start(node_id);
            let hend = HierarchyKey::children_end(node_id);
            let range = htbl.st_range(Some(&hstart), Some(&hend), true, true)?;

            for entry in range {
                let (key, _) = entry?;
                let child_id = key.value().child_id;

                // Temporal filter on child
                if min_hlc > 0
                    && let Some(cg) = cltbl.st_get(&child_id)?
                {
                    let child_meta = ClusterMeta::from_bytes(cg.value());
                    if child_meta.newest_hlc() > 0 && child_meta.newest_hlc() < min_hlc {
                        continue;
                    }
                }

                if let Some(cg) = ctbl.st_get(&child_id)? {
                    let bytes = cg.value();
                    if bytes.len() < dim * 4 {
                        continue;
                    }
                    let centroid: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
                    let dist = config.metric.compute(query, &centroid);
                    next_level.push((child_id, dist));
                    if collect_centroids {
                        next_centroids.extend_from_slice(&centroid);
                    }
                }
            }
        }

        if next_level.is_empty() {
            break;
        }

        let nprobe_usize = nprobe as usize;

        if collect_centroids && next_level.len() > nprobe_usize {
            // Sort with index tracking so we can reorder centroids in lockstep
            let mut indexed: Vec<(usize, u32, f32)> = next_level
                .iter()
                .enumerate()
                .map(|(i, &(id, d))| (i, id, d))
                .collect();
            indexed.sort_by(|a, b| a.2.total_cmp(&b.2));

            let sorted_candidates: Vec<(u32, f32)> =
                indexed.iter().map(|&(_, id, d)| (id, d)).collect();
            let mut sorted_centroids: Vec<f32> = Vec::with_capacity(indexed.len() * dim);
            for &(orig_idx, _, _) in &indexed {
                sorted_centroids
                    .extend_from_slice(&next_centroids[orig_idx * dim..(orig_idx + 1) * dim]);
            }

            let selected = crate::probe_select::select_diverse_probes(
                &sorted_candidates,
                &sorted_centroids,
                dim,
                nprobe_usize,
                diversity,
                config.metric,
            );
            current_level = selected.iter().map(|(id, _)| *id).collect();
        } else {
            // Fast path: pure distance ranking
            next_level.sort_by(|a, b| a.1.total_cmp(&b.1));
            if next_level.len() > nprobe_usize {
                next_level.truncate(nprobe_usize);
            }
            current_level = next_level.iter().map(|(id, _)| *id).collect();
        }
    }

    Ok(leaves)
}

/// Beam search for read transactions (same logic, different table access).
#[allow(clippy::too_many_arguments)]
fn beam_search_leaves_read<R: StorageRead>(
    txn: &R,
    names: &TableNames,
    config: &super::config::FractalIndexConfig,
    root: u32,
    query: &[f32],
    nprobe: u32,
    min_hlc: u64,
    diversity: DiversityConfig,
) -> crate::Result<Vec<u32>> {
    let dim = config.dim as usize;
    let clusters_def = TableDefinition::<u32, &[u8]>::new(&names.clusters);
    let centroids_def = TableDefinition::<u32, &[u8]>::new(&names.centroids);
    let hier_def = TableDefinition::<HierarchyKey, ()>::new(&names.hierarchy);

    let mut current_level = alloc::vec![root];
    let mut leaves: Vec<u32> = Vec::new();
    // Guard against infinite traversal due to corrupted hierarchy.
    let max_levels = (config.max_depth as usize).saturating_mul(2).max(64);
    let mut level_count: usize = 0;

    loop {
        level_count += 1;
        if level_count > max_levels {
            break;
        }

        let mut next_level: Vec<(u32, f32)> = Vec::new();
        let mut next_centroids: Vec<f32> = Vec::new();
        let collect_centroids = diversity.enabled();

        for &node_id in &current_level {
            let meta = {
                let ctbl = txn.open_storage_table(clusters_def)?;
                match ctbl.st_get(&node_id)? {
                    Some(g) => ClusterMeta::from_bytes(g.value()),
                    None => continue,
                }
            };

            if meta.is_leaf() {
                if min_hlc > 0 && meta.newest_hlc() > 0 && meta.newest_hlc() < min_hlc {
                    continue;
                }
                leaves.push(node_id);
                continue;
            }

            let htbl = txn.open_storage_table(hier_def)?;
            let ctbl = txn.open_storage_table(centroids_def)?;
            let cltbl = txn.open_storage_table(clusters_def)?;

            let hstart = HierarchyKey::children_start(node_id);
            let hend = HierarchyKey::children_end(node_id);
            let range = htbl.st_range(Some(&hstart), Some(&hend), true, true)?;

            for entry in range {
                let (key, _) = entry?;
                let child_id = key.value().child_id;

                if min_hlc > 0
                    && let Some(cg) = cltbl.st_get(&child_id)?
                {
                    let child_meta = ClusterMeta::from_bytes(cg.value());
                    if child_meta.newest_hlc() > 0 && child_meta.newest_hlc() < min_hlc {
                        continue;
                    }
                }

                if let Some(cg) = ctbl.st_get(&child_id)? {
                    let bytes = cg.value();
                    if bytes.len() < dim * 4 {
                        continue;
                    }
                    let centroid: Vec<f32> = (0..dim).map(|i| read_f32_le(bytes, i * 4)).collect();
                    let dist = config.metric.compute(query, &centroid);
                    next_level.push((child_id, dist));
                    if collect_centroids {
                        next_centroids.extend_from_slice(&centroid);
                    }
                }
            }
        }

        if next_level.is_empty() {
            break;
        }

        let nprobe_usize = nprobe as usize;

        if collect_centroids && next_level.len() > nprobe_usize {
            let mut indexed: Vec<(usize, u32, f32)> = next_level
                .iter()
                .enumerate()
                .map(|(i, &(id, d))| (i, id, d))
                .collect();
            indexed.sort_by(|a, b| a.2.total_cmp(&b.2));

            let sorted_candidates: Vec<(u32, f32)> =
                indexed.iter().map(|&(_, id, d)| (id, d)).collect();
            let mut sorted_centroids: Vec<f32> = Vec::with_capacity(indexed.len() * dim);
            for &(orig_idx, _, _) in &indexed {
                sorted_centroids
                    .extend_from_slice(&next_centroids[orig_idx * dim..(orig_idx + 1) * dim]);
            }

            let selected = crate::probe_select::select_diverse_probes(
                &sorted_candidates,
                &sorted_centroids,
                dim,
                nprobe_usize,
                diversity,
                config.metric,
            );
            current_level = selected.iter().map(|(id, _)| *id).collect();
        } else {
            next_level.sort_by(|a, b| a.1.total_cmp(&b.1));
            if next_level.len() > nprobe_usize {
                next_level.truncate(nprobe_usize);
            }
            current_level = next_level.iter().map(|(id, _)| *id).collect();
        }
    }

    Ok(leaves)
}