tegdb 0.5.0

The name TegridyDB (short for TegDB) is inspired by the Tegridy Farm in South Park and tries to correct some of the wrong database implementations, such as null support, implicit conversion support, etc.
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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
use crate::Result;
use std::collections::{HashMap, HashSet};

/// HNSW (Hierarchical Navigable Small World) index for approximate nearest neighbor search
pub struct HNSWIndex {
    /// Maximum number of connections per layer
    max_connections: usize,
    /// Maximum number of connections for the top layer
    max_connections_top: usize,
    /// Number of layers in the hierarchy
    num_layers: usize,
    /// Current maximum layer
    max_layer: usize,
    /// Entry point (highest layer node)
    entry_point: Option<usize>,
    /// Nodes organized by layer: layer -> node_id -> neighbors
    layers: Vec<HashMap<usize, Vec<usize>>>,
    /// Vector data: node_id -> vector
    vectors: HashMap<usize, Vec<f64>>,
    /// Layer assignment for each node
    node_layers: HashMap<usize, usize>,
}

impl HNSWIndex {
    /// Create a new HNSW index
    pub fn new(max_connections: usize, max_connections_top: usize) -> Self {
        Self {
            max_connections,
            max_connections_top,
            num_layers: 16, // Default number of layers
            max_layer: 0,
            entry_point: None,
            layers: vec![HashMap::new(); 16],
            vectors: HashMap::new(),
            node_layers: HashMap::new(),
        }
    }

    /// Insert a vector into the index
    pub fn insert(&mut self, node_id: usize, vector: Vec<f64>) -> Result<()> {
        // Assign layer to the new node
        let layer = self.assign_layer();
        self.node_layers.insert(node_id, layer);
        self.vectors.insert(node_id, vector.clone());

        // Update max layer if needed
        if layer > self.max_layer {
            self.max_layer = layer;
        }

        // If this is the first node, set it as entry point
        if self.entry_point.is_none() {
            self.entry_point = Some(node_id);
            return Ok(());
        }

        // Find the entry point
        let entry_point = self.entry_point.unwrap();
        let entry_vector = self.vectors.get(&entry_point).unwrap();

        // Search for nearest neighbors starting from the top layer
        let mut current_ep = entry_point;
        let mut current_dist = cosine_distance(&vector, entry_vector);

        // Search from top layer down to layer + 1
        for layer_idx in (layer + 1..=self.max_layer).rev() {
            let layer_results = self.search_layer(&vector, current_ep, layer_idx, 1)?;
            if let Some((new_ep, new_dist)) = layer_results.first().copied() {
                if new_dist < current_dist {
                    current_ep = new_ep;
                    current_dist = new_dist;
                }
            }
        }

        // Search and connect at each layer from min(layer, max_layer) down to 0
        for layer_idx in (0..=layer.min(self.max_layer)).rev() {
            let layer_neighbors =
                self.search_layer(&vector, current_ep, layer_idx, self.max_connections)?;
            let neighbors =
                self.select_neighbors(&vector, &layer_neighbors, self.max_connections)?;

            // Connect the new node to its neighbors
            self.connect_node(node_id, &neighbors, layer_idx)?;

            // Connect neighbors to the new node
            for &neighbor_id in &neighbors {
                self.connect_node(neighbor_id, &[node_id], layer_idx)?;
            }

            current_ep = neighbors[0];
        }

        // Update entry point if the new node is at a higher layer
        if layer > *self.node_layers.get(&entry_point).unwrap_or(&0) {
            self.entry_point = Some(node_id);
        }

        Ok(())
    }

    /// Search for k nearest neighbors
    pub fn search(&self, query_vector: &[f64], k: usize) -> Result<Vec<(usize, f64)>> {
        if self.entry_point.is_none() {
            return Ok(Vec::new());
        }

        let entry_point = self.entry_point.unwrap();
        let entry_vector = self.vectors.get(&entry_point).unwrap();
        let mut current_dist = cosine_distance(query_vector, entry_vector);
        let mut current_ep = entry_point;

        // Search from top layer down to layer 0
        for layer_idx in (0..=self.max_layer).rev() {
            let layer_results = self.search_layer(query_vector, current_ep, layer_idx, 1)?;
            if let Some((new_ep, new_dist)) = layer_results.first().copied() {
                if new_dist < current_dist {
                    current_ep = new_ep;
                    current_dist = new_dist;
                }
            }
        }

        // Search at layer 0 with more candidates
        let candidates = self.search_layer(query_vector, current_ep, 0, k * 2)?;

        // Sort by distance and return top k
        let mut results: Vec<(usize, f64)> = candidates.into_iter().collect();
        results.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());
        results.truncate(k);

        Ok(results)
    }

    /// Search within a specific layer
    fn search_layer(
        &self,
        query_vector: &[f64],
        entry_point: usize,
        layer: usize,
        ef: usize,
    ) -> Result<Vec<(usize, f64)>> {
        let mut candidates = HashSet::new();
        let mut visited = HashSet::new();
        let mut distances = HashMap::new();

        candidates.insert(entry_point);
        distances.insert(
            entry_point,
            cosine_distance(query_vector, self.vectors.get(&entry_point).unwrap()),
        );

        while !candidates.is_empty() {
            // Find the closest candidate
            let current = *candidates
                .iter()
                .min_by(|a, b| {
                    distances
                        .get(a)
                        .unwrap()
                        .partial_cmp(distances.get(b).unwrap())
                        .unwrap()
                })
                .unwrap();

            candidates.remove(&current);
            visited.insert(current);

            // Check if we can improve
            if candidates.len() >= ef {
                let furthest_candidate = candidates
                    .iter()
                    .max_by(|a, b| {
                        distances
                            .get(a)
                            .unwrap()
                            .partial_cmp(distances.get(b).unwrap())
                            .unwrap()
                    })
                    .unwrap();
                if distances.get(&current).unwrap() > distances.get(furthest_candidate).unwrap() {
                    break;
                }
            }

            // Explore neighbors
            if let Some(neighbors) = self.layers[layer].get(&current) {
                for &neighbor in neighbors {
                    if !visited.contains(&neighbor) {
                        let dist =
                            cosine_distance(query_vector, self.vectors.get(&neighbor).unwrap());
                        candidates.insert(neighbor);
                        distances.insert(neighbor, dist);
                    }
                }
            }
        }

        let mut results: Vec<(usize, f64)> = visited
            .into_iter()
            .map(|id| (id, *distances.get(&id).unwrap()))
            .collect();
        results.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());
        results.truncate(ef);

        Ok(results)
    }

    /// Select neighbors using the HNSW selection algorithm
    fn select_neighbors(
        &self,
        _query_vector: &[f64],
        candidates: &[(usize, f64)],
        m: usize,
    ) -> Result<Vec<usize>> {
        let mut selected = Vec::new();
        let mut candidates = candidates.to_vec();

        while selected.len() < m && !candidates.is_empty() {
            // Find the closest candidate
            let (closest_id, _) = candidates.remove(0);
            selected.push(closest_id);

            // Remove candidates that are closer to the selected candidate than to the query
            candidates.retain(|(id, dist_to_query)| {
                let dist_to_selected = cosine_distance(
                    self.vectors.get(id).unwrap(),
                    self.vectors.get(&closest_id).unwrap(),
                );
                dist_to_selected > *dist_to_query
            });
        }

        Ok(selected)
    }

    /// Connect a node to its neighbors at a specific layer
    fn connect_node(&mut self, node_id: usize, neighbors: &[usize], layer: usize) -> Result<()> {
        let max_conn = if layer == 0 {
            self.max_connections
        } else {
            self.max_connections_top
        };

        let mut current_neighbors = self.layers[layer]
            .get(&node_id)
            .cloned()
            .unwrap_or_default();
        current_neighbors.extend_from_slice(neighbors);

        // Limit connections
        if current_neighbors.len() > max_conn {
            // Simple truncation - in practice, you'd want more sophisticated selection
            current_neighbors.truncate(max_conn);
        }

        self.layers[layer].insert(node_id, current_neighbors);
        Ok(())
    }

    /// Assign a layer to a new node using the layer assignment algorithm
    fn assign_layer(&self) -> usize {
        let mut layer = 0;
        let mut rng = fastrand::Rng::new();

        while layer < self.num_layers - 1 && rng.f64() < 0.5 {
            layer += 1;
        }

        layer
    }

    /// Remove a vector from the index
    pub fn remove(&mut self, node_id: usize) -> Result<()> {
        if let Some(layer) = self.node_layers.remove(&node_id) {
            // Remove from layers
            for layer_idx in 0..=layer {
                if let Some(neighbors) = self.layers[layer_idx].remove(&node_id) {
                    // Remove this node from all its neighbors' neighbor lists
                    for neighbor_id in neighbors {
                        if let Some(neighbor_neighbors) =
                            self.layers[layer_idx].get_mut(&neighbor_id)
                        {
                            neighbor_neighbors.retain(|&id| id != node_id);
                        }
                    }
                }
            }

            // Remove vector data
            self.vectors.remove(&node_id);

            // Update entry point if needed
            if self.entry_point == Some(node_id) {
                self.entry_point = self.find_new_entry_point();
            }
        }

        Ok(())
    }

    /// Find a new entry point after removing the current one
    fn find_new_entry_point(&self) -> Option<usize> {
        // Find the node with the highest layer
        self.node_layers
            .iter()
            .max_by_key(|(_, &layer)| layer)
            .map(|(&id, _)| id)
    }

    /// Get the number of vectors in the index
    pub fn len(&self) -> usize {
        self.vectors.len()
    }

    /// Check if the index is empty
    pub fn is_empty(&self) -> bool {
        self.vectors.is_empty()
    }
}

/// Calculate cosine distance between two vectors
fn cosine_distance(a: &[f64], b: &[f64]) -> f64 {
    if a.len() != b.len() {
        return f64::INFINITY;
    }

    let mut dot_product = 0.0;
    let mut norm_a = 0.0;
    let mut norm_b = 0.0;

    for (x, y) in a.iter().zip(b.iter()) {
        dot_product += x * y;
        norm_a += x * x;
        norm_b += y * y;
    }

    if norm_a == 0.0 || norm_b == 0.0 {
        return 1.0; // Maximum distance for zero vectors
    }

    let cosine_similarity = dot_product / (norm_a.sqrt() * norm_b.sqrt());
    1.0 - cosine_similarity // Convert to distance
}

/// IVF (Inverted File Index) for clustering-based search
pub struct IVFIndex {
    /// Number of clusters
    num_clusters: usize,
    /// Cluster centroids
    centroids: Vec<Vec<f64>>,
    /// Cluster assignments: cluster_id -> vector_ids
    clusters: Vec<Vec<usize>>,
    /// Vector data: vector_id -> vector
    vectors: HashMap<usize, Vec<f64>>,
    /// Vector to cluster mapping
    vector_to_cluster: HashMap<usize, usize>,
}

impl IVFIndex {
    /// Create a new IVF index
    pub fn new(num_clusters: usize) -> Self {
        Self {
            num_clusters,
            centroids: Vec::new(),
            clusters: vec![Vec::new(); num_clusters],
            vectors: HashMap::new(),
            vector_to_cluster: HashMap::new(),
        }
    }

    /// Build the index from a set of vectors
    pub fn build(&mut self, vectors: Vec<(usize, Vec<f64>)>) -> Result<()> {
        if vectors.is_empty() {
            return Ok(());
        }

        // Store vectors first
        for (vector_id, vector) in &vectors {
            self.vectors.insert(*vector_id, vector.clone());
        }

        // Initialize centroids randomly
        self.initialize_centroids(&vectors)?;

        // K-means clustering
        for _ in 0..10 {
            // Max iterations
            self.assign_to_clusters(&vectors)?;
            self.update_centroids()?;
        }

        // Final assignment
        self.assign_to_clusters(&vectors)?;

        Ok(())
    }

    /// Initialize centroids randomly
    fn initialize_centroids(&mut self, vectors: &[(usize, Vec<f64>)]) -> Result<()> {
        self.centroids.clear();
        let _dimension = vectors[0].1.len();

        for _ in 0..self.num_clusters {
            let random_idx = fastrand::usize(..vectors.len());
            self.centroids.push(vectors[random_idx].1.clone());
        }

        Ok(())
    }

    /// Assign vectors to clusters
    fn assign_to_clusters(&mut self, vectors: &[(usize, Vec<f64>)]) -> Result<()> {
        // Clear clusters
        for cluster in &mut self.clusters {
            cluster.clear();
        }

        // Assign each vector to nearest centroid
        for (vector_id, vector) in vectors {
            let mut min_dist = f64::INFINITY;
            let mut best_cluster = 0;

            for (cluster_id, centroid) in self.centroids.iter().enumerate() {
                let dist = euclidean_distance(vector, centroid);
                if dist < min_dist {
                    min_dist = dist;
                    best_cluster = cluster_id;
                }
            }

            self.clusters[best_cluster].push(*vector_id);
            self.vector_to_cluster.insert(*vector_id, best_cluster);
        }

        Ok(())
    }

    /// Update centroids based on current cluster assignments
    fn update_centroids(&mut self) -> Result<()> {
        for (cluster_id, cluster) in self.clusters.iter().enumerate() {
            if cluster.is_empty() {
                continue;
            }

            let dimension = self.centroids[cluster_id].len();
            let mut new_centroid = vec![0.0; dimension];

            for &vector_id in cluster {
                if let Some(vector) = self.vectors.get(&vector_id) {
                    for (i, &val) in vector.iter().enumerate() {
                        new_centroid[i] += val;
                    }
                }
            }

            // Average
            let cluster_size = cluster.len() as f64;
            for val in &mut new_centroid {
                *val /= cluster_size;
            }

            self.centroids[cluster_id] = new_centroid;
        }

        Ok(())
    }

    /// Search for k nearest neighbors
    pub fn search(&self, query_vector: &[f64], k: usize) -> Result<Vec<(usize, f64)>> {
        // Find the closest centroid
        let mut min_dist = f64::INFINITY;
        let mut best_cluster = 0;

        for (cluster_id, centroid) in self.centroids.iter().enumerate() {
            let dist = euclidean_distance(query_vector, centroid);
            if dist < min_dist {
                min_dist = dist;
                best_cluster = cluster_id;
            }
        }

        // Search within the best cluster
        let mut results = Vec::new();
        for &vector_id in &self.clusters[best_cluster] {
            if let Some(vector) = self.vectors.get(&vector_id) {
                let dist = euclidean_distance(query_vector, vector);
                results.push((vector_id, dist));
            }
        }

        // Sort by distance and return top k
        results.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());
        results.truncate(k);

        Ok(results)
    }

    /// Insert a vector into the index
    pub fn insert(&mut self, vector_id: usize, vector: Vec<f64>) -> Result<()> {
        self.vectors.insert(vector_id, vector.clone());

        // Find closest centroid
        let mut min_dist = f64::INFINITY;
        let mut best_cluster = 0;

        for (cluster_id, centroid) in self.centroids.iter().enumerate() {
            let dist = euclidean_distance(&vector, centroid);
            if dist < min_dist {
                min_dist = dist;
                best_cluster = cluster_id;
            }
        }

        // Assign to cluster
        self.clusters[best_cluster].push(vector_id);
        self.vector_to_cluster.insert(vector_id, best_cluster);

        Ok(())
    }
}

/// LSH (Locality Sensitive Hashing) for high-dimensional similarity search
pub struct LSHIndex {
    /// Number of hash tables
    num_tables: usize,
    /// Number of hash functions per table
    num_functions: usize,
    /// Hash tables: table_id -> hash_value -> vector_ids
    hash_tables: Vec<HashMap<u64, Vec<usize>>>,
    /// Vector data: vector_id -> vector
    vectors: HashMap<usize, Vec<f64>>,
    /// Random projections for hash functions
    projections: Vec<Vec<f64>>,
    /// Random offsets for hash functions
    offsets: Vec<f64>,
}

impl LSHIndex {
    /// Create a new LSH index
    pub fn new(num_tables: usize, num_functions: usize, dimension: usize) -> Self {
        let mut rng = fastrand::Rng::new();
        let mut projections = Vec::new();
        let mut offsets = Vec::new();

        // Generate random projections and offsets
        for _ in 0..num_tables * num_functions {
            let mut projection = Vec::new();
            for _ in 0..dimension {
                projection.push(rng.f64() * 2.0 - 1.0); // Random values in [-1, 1]
            }
            projections.push(projection);
            offsets.push(rng.f64() * 4.0); // Random offset
        }

        Self {
            num_tables,
            num_functions,
            hash_tables: vec![HashMap::new(); num_tables],
            vectors: HashMap::new(),
            projections,
            offsets,
        }
    }

    /// Insert a vector into the index
    pub fn insert(&mut self, vector_id: usize, vector: Vec<f64>) -> Result<()> {
        self.vectors.insert(vector_id, vector.clone());

        // Compute hash values for all tables
        for table_id in 0..self.num_tables {
            let hash_value = self.compute_hash(&vector, table_id);
            self.hash_tables[table_id]
                .entry(hash_value)
                .or_default()
                .push(vector_id);
        }

        Ok(())
    }

    /// Search for similar vectors
    pub fn search(&self, query_vector: &[f64], k: usize) -> Result<Vec<(usize, f64)>> {
        let mut candidates = HashSet::new();

        // Collect candidates from all hash tables
        for table_id in 0..self.num_tables {
            let hash_value = self.compute_hash(query_vector, table_id);
            if let Some(vector_ids) = self.hash_tables[table_id].get(&hash_value) {
                candidates.extend(vector_ids);
            }
        }

        // Compute actual distances for candidates
        let mut results = Vec::new();
        for &vector_id in &candidates {
            if let Some(vector) = self.vectors.get(&vector_id) {
                let dist = cosine_distance(query_vector, vector);
                results.push((vector_id, dist));
            }
        }

        // Sort by distance and return top k
        results.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());
        results.truncate(k);

        Ok(results)
    }

    /// Compute hash value for a vector in a specific table
    fn compute_hash(&self, vector: &[f64], table_id: usize) -> u64 {
        let mut hash_value = 0u64;

        for func_id in 0..self.num_functions {
            let idx = table_id * self.num_functions + func_id;
            let projection = &self.projections[idx];
            let offset = self.offsets[idx];

            // Compute dot product with random projection
            let mut dot_product = 0.0;
            for (x, y) in vector.iter().zip(projection.iter()) {
                dot_product += x * y;
            }

            // Add offset and quantize
            let quantized = ((dot_product + offset) / 4.0) as u64;
            hash_value = hash_value.wrapping_mul(31).wrapping_add(quantized);
        }

        hash_value
    }

    /// Get the number of vectors in the index
    pub fn len(&self) -> usize {
        self.vectors.len()
    }

    /// Check if the index is empty
    pub fn is_empty(&self) -> bool {
        self.vectors.is_empty()
    }
}

/// Calculate Euclidean distance between two vectors
fn euclidean_distance(a: &[f64], b: &[f64]) -> f64 {
    if a.len() != b.len() {
        return f64::INFINITY;
    }

    let mut sum = 0.0;
    for (x, y) in a.iter().zip(b.iter()) {
        let diff = x - y;
        sum += diff * diff;
    }

    sum.sqrt()
}

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

    #[test]
    fn test_hnsw_basic() {
        let mut index = HNSWIndex::new(16, 32);

        // Insert some test vectors
        index.insert(1, vec![1.0, 0.0, 0.0]).unwrap();
        index.insert(2, vec![0.0, 1.0, 0.0]).unwrap();
        index.insert(3, vec![0.0, 0.0, 1.0]).unwrap();

        // Search
        let results = index.search(&[0.8, 0.2, 0.0], 2).unwrap();
        assert_eq!(results.len(), 2);
        assert_eq!(results[0].0, 1); // Should find vector 1 first
    }

    #[test]
    fn test_ivf_basic() {
        let mut index = IVFIndex::new(2);

        let vectors = vec![
            (1, vec![1.0, 0.0]),
            (2, vec![0.0, 1.0]),
            (3, vec![0.9, 0.1]),
            (4, vec![0.1, 0.9]),
        ];

        index.build(vectors).unwrap();

        // Search
        let results = index.search(&[0.8, 0.2], 2).unwrap();
        assert_eq!(results.len(), 2);
    }
}