ruvector-core 2.2.0

High-performance Rust vector database core with HNSW indexing
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
//! # Topological Data Analysis (TDA)
//!
//! Basic topological analysis for embedding quality assessment.
//! Detects mode collapse, degeneracy, and topological structure.

use crate::error::{Result, RuvectorError};
use ndarray::Array2;
use serde::{Deserialize, Serialize};

/// Topological analyzer for embeddings
pub struct TopologicalAnalyzer {
    /// k for k-nearest neighbors graph
    k_neighbors: usize,
    /// Distance threshold for edge creation
    epsilon: f32,
}

impl TopologicalAnalyzer {
    /// Create a new topological analyzer
    pub fn new(k_neighbors: usize, epsilon: f32) -> Self {
        Self {
            k_neighbors,
            epsilon,
        }
    }

    /// Analyze embedding quality
    pub fn analyze(&self, embeddings: &[Vec<f32>]) -> Result<EmbeddingQuality> {
        if embeddings.is_empty() {
            return Err(RuvectorError::InvalidInput("Empty embeddings".into()));
        }

        let n = embeddings.len();
        let dim = embeddings[0].len();

        // Build k-NN graph
        let graph = self.build_knn_graph(embeddings);

        // Compute topological features
        let connected_components = self.count_connected_components(&graph, n);
        let clustering_coefficient = self.compute_clustering_coefficient(&graph);
        let degree_stats = self.compute_degree_statistics(&graph, n);

        // Detect mode collapse
        let mode_collapse_score = self.detect_mode_collapse(embeddings);

        // Compute embedding spread
        let spread = self.compute_spread(embeddings);

        // Detect degeneracy (vectors collapsing to a lower-dimensional manifold)
        let degeneracy_score = self.detect_degeneracy(embeddings);

        // Compute persistence features (simplified)
        let persistence_score = self.compute_persistence(&graph, embeddings);

        // Overall quality score (0-1, higher is better)
        let quality_score = self.compute_quality_score(
            mode_collapse_score,
            degeneracy_score,
            connected_components,
            clustering_coefficient,
            spread,
        );

        Ok(EmbeddingQuality {
            dimensions: dim,
            num_vectors: n,
            connected_components,
            clustering_coefficient,
            avg_degree: degree_stats.0,
            degree_std: degree_stats.1,
            mode_collapse_score,
            degeneracy_score,
            spread,
            persistence_score,
            quality_score,
        })
    }

    fn build_knn_graph(&self, embeddings: &[Vec<f32>]) -> Vec<Vec<usize>> {
        let n = embeddings.len();
        let mut graph = vec![Vec::new(); n];

        for i in 0..n {
            let mut distances: Vec<(usize, f32)> = (0..n)
                .filter(|&j| i != j)
                .map(|j| {
                    let dist = euclidean_distance(&embeddings[i], &embeddings[j]);
                    (j, dist)
                })
                .collect();

            distances.sort_by(|a, b| a.1.partial_cmp(&b.1).unwrap());

            // Add k nearest neighbors
            for (j, dist) in distances.iter().take(self.k_neighbors) {
                if *dist <= self.epsilon {
                    graph[i].push(*j);
                }
            }
        }

        graph
    }

    fn count_connected_components(&self, graph: &[Vec<usize>], n: usize) -> usize {
        let mut visited = vec![false; n];
        let mut components = 0;

        for i in 0..n {
            if !visited[i] {
                components += 1;
                self.dfs(i, graph, &mut visited);
            }
        }

        components
    }

    #[allow(clippy::only_used_in_recursion)]
    fn dfs(&self, node: usize, graph: &[Vec<usize>], visited: &mut [bool]) {
        visited[node] = true;
        for &neighbor in &graph[node] {
            if !visited[neighbor] {
                self.dfs(neighbor, graph, visited);
            }
        }
    }

    fn compute_clustering_coefficient(&self, graph: &[Vec<usize>]) -> f32 {
        let mut total_coeff = 0.0;
        let mut count = 0;

        for neighbors in graph {
            if neighbors.len() < 2 {
                continue;
            }

            let k = neighbors.len();
            let mut triangles = 0;

            // Count triangles
            for i in 0..k {
                for j in i + 1..k {
                    let ni = neighbors[i];
                    let nj = neighbors[j];

                    if graph[ni].contains(&nj) {
                        triangles += 1;
                    }
                }
            }

            let possible_triangles = k * (k - 1) / 2;
            if possible_triangles > 0 {
                total_coeff += triangles as f32 / possible_triangles as f32;
                count += 1;
            }
        }

        if count > 0 {
            total_coeff / count as f32
        } else {
            0.0
        }
    }

    fn compute_degree_statistics(&self, graph: &[Vec<usize>], n: usize) -> (f32, f32) {
        let degrees: Vec<f32> = graph
            .iter()
            .map(|neighbors| neighbors.len() as f32)
            .collect();

        let avg = degrees.iter().sum::<f32>() / n as f32;
        let variance = degrees.iter().map(|&d| (d - avg).powi(2)).sum::<f32>() / n as f32;
        let std = variance.sqrt();

        (avg, std)
    }

    fn detect_mode_collapse(&self, embeddings: &[Vec<f32>]) -> f32 {
        // Compute pairwise distances
        let n = embeddings.len();
        let mut distances = Vec::new();

        for i in 0..n {
            for j in i + 1..n {
                let dist = euclidean_distance(&embeddings[i], &embeddings[j]);
                distances.push(dist);
            }
        }

        if distances.is_empty() {
            return 0.0;
        }

        // Compute coefficient of variation
        let mean = distances.iter().sum::<f32>() / distances.len() as f32;
        let variance =
            distances.iter().map(|&d| (d - mean).powi(2)).sum::<f32>() / distances.len() as f32;
        let std = variance.sqrt();

        // High CV indicates good separation, low CV indicates collapse
        let cv = if mean > 0.0 { std / mean } else { 0.0 };

        // Normalize to 0-1, where 0 is collapsed, 1 is good
        (cv * 2.0).min(1.0)
    }

    fn compute_spread(&self, embeddings: &[Vec<f32>]) -> f32 {
        if embeddings.is_empty() {
            return 0.0;
        }

        let dim = embeddings[0].len();

        // Compute mean
        let mut mean = vec![0.0; dim];
        for emb in embeddings {
            for (i, &val) in emb.iter().enumerate() {
                mean[i] += val;
            }
        }
        for val in mean.iter_mut() {
            *val /= embeddings.len() as f32;
        }

        // Compute average distance from mean
        let mut total_dist = 0.0;
        for emb in embeddings {
            let dist = euclidean_distance(emb, &mean);
            total_dist += dist;
        }

        total_dist / embeddings.len() as f32
    }

    fn detect_degeneracy(&self, embeddings: &[Vec<f32>]) -> f32 {
        if embeddings.is_empty() || embeddings[0].is_empty() {
            return 1.0; // Fully degenerate
        }

        let n = embeddings.len();
        let dim = embeddings[0].len();

        if n < dim {
            return 0.0; // Cannot determine
        }

        // Compute covariance matrix
        let cov = self.compute_covariance_matrix(embeddings);

        // Estimate rank by counting significant singular values
        let singular_values = self.approximate_singular_values(&cov);

        let significant = singular_values.iter().filter(|&&sv| sv > 1e-6).count();

        // Degeneracy score: 0 = full rank, 1 = rank-1 (collapsed)
        1.0 - (significant as f32 / dim as f32)
    }

    fn compute_covariance_matrix(&self, embeddings: &[Vec<f32>]) -> Array2<f32> {
        let n = embeddings.len();
        let dim = embeddings[0].len();

        // Compute mean
        let mut mean = vec![0.0; dim];
        for emb in embeddings {
            for (i, &val) in emb.iter().enumerate() {
                mean[i] += val;
            }
        }
        for val in mean.iter_mut() {
            *val /= n as f32;
        }

        // Compute covariance
        let mut cov = Array2::zeros((dim, dim));
        for emb in embeddings {
            for i in 0..dim {
                for j in 0..dim {
                    cov[[i, j]] += (emb[i] - mean[i]) * (emb[j] - mean[j]);
                }
            }
        }

        cov.mapv(|x| x / (n - 1) as f32);
        cov
    }

    fn approximate_singular_values(&self, matrix: &Array2<f32>) -> Vec<f32> {
        // Power iteration for largest singular values (simplified)
        let dim = matrix.nrows();
        let mut values = Vec::new();

        // Just return diagonal for approximation
        for i in 0..dim {
            values.push(matrix[[i, i]].abs());
        }

        values.sort_by(|a, b| b.partial_cmp(a).unwrap());
        values
    }

    fn compute_persistence(&self, _graph: &[Vec<usize>], embeddings: &[Vec<f32>]) -> f32 {
        // Simplified persistence: measure how graph structure changes with distance threshold
        let scales = vec![0.1, 0.5, 1.0, 2.0, 5.0];
        let mut component_counts = Vec::new();

        for &scale in &scales {
            let scaled_analyzer = TopologicalAnalyzer::new(self.k_neighbors, scale);
            let scaled_graph = scaled_analyzer.build_knn_graph(embeddings);
            let components =
                scaled_analyzer.count_connected_components(&scaled_graph, embeddings.len());
            component_counts.push(components);
        }

        // Persistence is the variation in component count across scales
        let max_components = *component_counts.iter().max().unwrap_or(&1);
        let min_components = *component_counts.iter().min().unwrap_or(&1);

        (max_components - min_components) as f32 / max_components as f32
    }

    fn compute_quality_score(
        &self,
        mode_collapse: f32,
        degeneracy: f32,
        components: usize,
        clustering: f32,
        spread: f32,
    ) -> f32 {
        // Weighted combination of metrics
        let collapse_score = mode_collapse; // Higher is better
        let degeneracy_score = 1.0 - degeneracy; // Lower degeneracy is better
        let component_score = if components == 1 { 1.0 } else { 0.5 }; // Single component is good
        let clustering_score = clustering; // Higher clustering is good
        let spread_score = (spread / 10.0).min(1.0); // Reasonable spread

        (collapse_score * 0.3
            + degeneracy_score * 0.3
            + component_score * 0.2
            + clustering_score * 0.1
            + spread_score * 0.1)
            .clamp(0.0, 1.0)
    }
}

/// Embedding quality metrics
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EmbeddingQuality {
    /// Embedding dimensions
    pub dimensions: usize,
    /// Number of vectors
    pub num_vectors: usize,
    /// Number of connected components
    pub connected_components: usize,
    /// Clustering coefficient (0-1)
    pub clustering_coefficient: f32,
    /// Average node degree
    pub avg_degree: f32,
    /// Degree standard deviation
    pub degree_std: f32,
    /// Mode collapse score (0=collapsed, 1=good)
    pub mode_collapse_score: f32,
    /// Degeneracy score (0=full rank, 1=degenerate)
    pub degeneracy_score: f32,
    /// Average spread from centroid
    pub spread: f32,
    /// Topological persistence score
    pub persistence_score: f32,
    /// Overall quality (0-1, higher is better)
    pub quality_score: f32,
}

impl EmbeddingQuality {
    /// Check if embeddings show signs of mode collapse
    pub fn has_mode_collapse(&self) -> bool {
        self.mode_collapse_score < 0.3
    }

    /// Check if embeddings are degenerate
    pub fn is_degenerate(&self) -> bool {
        self.degeneracy_score > 0.7
    }

    /// Check if embeddings are well-structured
    pub fn is_good_quality(&self) -> bool {
        self.quality_score > 0.7
    }

    /// Get quality assessment
    pub fn assessment(&self) -> &str {
        if self.quality_score > 0.8 {
            "Excellent"
        } else if self.quality_score > 0.6 {
            "Good"
        } else if self.quality_score > 0.4 {
            "Fair"
        } else {
            "Poor"
        }
    }
}

fn euclidean_distance(a: &[f32], b: &[f32]) -> f32 {
    a.iter()
        .zip(b.iter())
        .map(|(x, y)| (x - y).powi(2))
        .sum::<f32>()
        .sqrt()
}

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

    #[test]
    fn test_embedding_analysis() {
        let analyzer = TopologicalAnalyzer::new(3, 5.0);

        // Create well-separated embeddings
        let embeddings = vec![
            vec![0.0, 0.0],
            vec![0.1, 0.1],
            vec![0.2, 0.2],
            vec![5.0, 5.0],
            vec![5.1, 5.1],
        ];

        let quality = analyzer.analyze(&embeddings).unwrap();

        assert_eq!(quality.dimensions, 2);
        assert_eq!(quality.num_vectors, 5);
        assert!(quality.quality_score > 0.0);
    }

    #[test]
    fn test_mode_collapse_detection() {
        let analyzer = TopologicalAnalyzer::new(2, 10.0);

        // Well-separated embeddings (high CV should give high score)
        let good = vec![vec![0.0, 0.0], vec![5.0, 5.0], vec![10.0, 10.0]];
        let score_good = analyzer.detect_mode_collapse(&good);

        // Collapsed embeddings (all identical, CV = 0)
        let collapsed = vec![vec![1.0, 1.0], vec![1.0, 1.0], vec![1.0, 1.0]];
        let score_collapsed = analyzer.detect_mode_collapse(&collapsed);

        // Identical vectors should have score 0 (distances all same = CV 0)
        assert_eq!(score_collapsed, 0.0);

        // Well-separated should have higher score
        assert!(score_good > score_collapsed);
    }

    #[test]
    fn test_connected_components() {
        let analyzer = TopologicalAnalyzer::new(1, 1.0);

        // Two separate clusters
        let embeddings = vec![
            vec![0.0, 0.0],
            vec![0.5, 0.5],
            vec![10.0, 10.0],
            vec![10.5, 10.5],
        ];

        let graph = analyzer.build_knn_graph(&embeddings);
        let components = analyzer.count_connected_components(&graph, embeddings.len());

        assert!(components >= 2); // Should have at least 2 components
    }

    #[test]
    fn test_quality_assessment() {
        let quality = EmbeddingQuality {
            dimensions: 128,
            num_vectors: 1000,
            connected_components: 1,
            clustering_coefficient: 0.6,
            avg_degree: 5.0,
            degree_std: 1.2,
            mode_collapse_score: 0.8,
            degeneracy_score: 0.2,
            spread: 3.5,
            persistence_score: 0.4,
            quality_score: 0.75,
        };

        assert!(!quality.has_mode_collapse());
        assert!(!quality.is_degenerate());
        assert!(quality.is_good_quality());
        assert_eq!(quality.assessment(), "Good");
    }
}