velesdb-core 1.13.2

High-performance vector database engine written in Rust
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
//! Tests for `gpu_backend` module
//!
//! GPU tests must run serially to avoid deadlocks on shared GPU resources.
//! Each test creates a new wgpu instance which can conflict with parallel execution.

use std::sync::Arc;

use super::gpu_backend::*;
use serial_test::serial;

#[test]
#[serial(gpu)]
fn test_gpu_available_check() {
    // Should not panic
    let _ = GpuAccelerator::is_available();
}

#[test]
#[serial(gpu)]
fn test_gpu_accelerator_creation() {
    // May return None if no GPU available (CI environment)
    let gpu = GpuAccelerator::new();
    if gpu.is_some() {
        println!("GPU available for testing");
    } else {
        println!("No GPU available, skipping GPU tests");
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_empty_input() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu
            .batch_cosine_similarity(&[], &[1.0, 0.0, 0.0], 3)
            .unwrap();
        assert!(results.is_empty());
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_identical_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Query and vector are identical -> similarity should be 1.0
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![1.0, 0.0, 0.0]; // One vector

        let results = gpu.batch_cosine_similarity(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(
            (results[0] - 1.0).abs() < 0.01,
            "Expected ~1.0, got {}",
            results[0]
        );
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_orthogonal_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![0.0, 1.0, 0.0]; // Orthogonal

        let results = gpu.batch_cosine_similarity(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(results[0].abs() < 0.01, "Expected ~0.0, got {}", results[0]);
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_multiple_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 0.0, 0.0];
        // 3 vectors of dimension 3
        let vectors = vec![
            1.0, 0.0, 0.0, // Identical -> 1.0
            0.0, 1.0, 0.0, // Orthogonal -> 0.0
            -1.0, 0.0, 0.0, // Opposite -> -1.0
        ];

        let results = gpu.batch_cosine_similarity(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 3);
        assert!((results[0] - 1.0).abs() < 0.01, "Expected ~1.0");
        assert!(results[1].abs() < 0.01, "Expected ~0.0");
        assert!((results[2] + 1.0).abs() < 0.01, "Expected ~-1.0");
    }
}

// =========================================================================
// Euclidean Distance Tests
// =========================================================================

#[test]
#[serial(gpu)]
fn test_batch_euclidean_empty_input() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu
            .batch_euclidean_distance(&[], &[1.0, 0.0, 0.0], 3)
            .unwrap();
        assert!(results.is_empty());
    }
}

#[test]
#[serial(gpu)]
fn test_batch_euclidean_identical_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 2.0, 3.0];
        let vectors = vec![1.0, 2.0, 3.0];

        let results = gpu.batch_euclidean_distance(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(results[0].abs() < 0.01, "Expected ~0.0, got {}", results[0]);
    }
}

#[test]
#[serial(gpu)]
fn test_batch_euclidean_known_distance() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![0.0, 0.0, 0.0];
        let vectors = vec![3.0, 4.0, 0.0]; // Distance should be 5.0

        let results = gpu.batch_euclidean_distance(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(
            (results[0] - 5.0).abs() < 0.01,
            "Expected ~5.0, got {}",
            results[0]
        );
    }
}

// =========================================================================
// Dot Product Tests
// =========================================================================

#[test]
#[serial(gpu)]
fn test_batch_dot_product_empty_input() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu.batch_dot_product(&[], &[1.0, 0.0, 0.0], 3).unwrap();
        assert!(results.is_empty());
    }
}

#[test]
#[serial(gpu)]
fn test_batch_dot_product_orthogonal() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![0.0, 1.0, 0.0];

        let results = gpu.batch_dot_product(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(results[0].abs() < 0.01, "Expected ~0.0, got {}", results[0]);
    }
}

#[test]
#[serial(gpu)]
fn test_batch_dot_product_parallel() {
    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![2.0, 3.0, 4.0];
        let vectors = vec![2.0, 3.0, 4.0]; // Dot = 4+9+16 = 29

        let results = gpu.batch_dot_product(&vectors, &query, 3).unwrap();

        assert_eq!(results.len(), 1);
        assert!(
            (results[0] - 29.0).abs() < 0.01,
            "Expected ~29.0, got {}",
            results[0]
        );
    }
}

// =========================================================================
// Plan 04-09 Task 2: Parameter validation errors
// =========================================================================

#[test]
#[serial(gpu)]
fn test_batch_cosine_zero_dimension() {
    if let Some(gpu) = GpuAccelerator::new() {
        // dimension=0 should return empty (early exit in batch_cosine_similarity)
        let results = gpu.batch_cosine_similarity(&[1.0, 2.0, 3.0], &[1.0], 0);
        let values = results.expect("zero-dimension cosine must return Ok(empty)");
        assert!(values.is_empty(), "Zero dimension should return empty");
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_dimension_mismatch() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Query is 2D but vectors declared as 3D — should not panic
        // The GPU processes whatever data is there; result may be wrong but no crash
        let query = vec![1.0, 0.0];
        let vectors = vec![1.0, 0.0, 0.0]; // 1 vector of dim 3
        let results = gpu.batch_cosine_similarity(&vectors, &query, 3);
        // Should produce 1 result (vectors.len() / dimension = 1)
        let values = results.expect("dimension mismatch should not panic");
        assert_eq!(values.len(), 1);
    }
}

#[test]
#[serial(gpu)]
fn test_batch_euclidean_empty_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu
            .batch_euclidean_distance(&[], &[1.0, 2.0, 3.0], 3)
            .unwrap();
        assert!(results.is_empty(), "Empty vectors should return empty");
    }
}

#[test]
#[serial(gpu)]
fn test_batch_dot_product_single_element() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Edge case: dimension=1
        let query = vec![3.0];
        let vectors = vec![4.0];
        let results = gpu.batch_dot_product(&vectors, &query, 1).unwrap();
        assert_eq!(results.len(), 1);
        assert!(
            (results[0] - 12.0).abs() < 0.01,
            "Expected 3*4=12, got {}",
            results[0]
        );
    }
}

#[test]
#[serial(gpu)]
fn test_batch_cosine_large_batch() {
    if let Some(gpu) = GpuAccelerator::new() {
        // 1000+ vectors of dimension 8
        let dim = 8;
        let num_vectors = 1024;
        let query: Vec<f32> = vec![1.0; dim];
        let vectors: Vec<f32> = vec![1.0; dim * num_vectors];

        let results = gpu.batch_cosine_similarity(&vectors, &query, dim);
        let values = results.expect("large cosine batch should succeed");
        assert_eq!(values.len(), num_vectors);
        // All identical vectors → similarity should be ~1.0
        for (i, &r) in values.iter().enumerate() {
            assert!((r - 1.0).abs() < 0.05, "Vector {i}: expected ~1.0, got {r}");
        }
    }
}

// =========================================================================
// Plan 04-09 Task 3: Edge-case inputs (no-panic guarantee)
// =========================================================================

#[test]
#[serial(gpu)]
fn test_gpu_no_panic_on_edge_inputs() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Each case: (vectors, query, dimension)
        let cases: Vec<(&[f32], &[f32], usize)> = vec![
            (&[], &[], 0),
            (&[1.0], &[1.0], 1),
            (&[f32::NAN], &[1.0], 1),
            (&[f32::INFINITY], &[1.0], 1),
            (&[f32::NEG_INFINITY], &[1.0], 1),
            (&[0.0; 1024], &[0.0; 8], 8), // 128 zero vectors of dim 8
        ];

        for (vectors, query, dim) in cases {
            // None of these should panic
            let _ = gpu.batch_cosine_similarity(vectors, query, dim);
            let _ = gpu.batch_euclidean_distance(vectors, query, dim);
            let _ = gpu.batch_dot_product(vectors, query, dim);
        }
    }
}

#[test]
#[serial(gpu)]
fn test_gpu_cosine_zero_norm_vectors() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Zero vector has norm 0 — GPU shader guards against division by zero
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![0.0, 0.0, 0.0]; // Zero vector

        let results = gpu.batch_cosine_similarity(&vectors, &query, 3);
        let values = results.expect("zero-norm cosine should return Ok");
        assert_eq!(values.len(), 1);
        // Should return 0.0 (shader checks denom > 0.0)
        assert!(
            values[0].is_finite(),
            "Zero-norm cosine should be finite, got {}",
            values[0]
        );
    }
}

#[test]
#[serial(gpu)]
fn test_gpu_euclidean_zero_dimension() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu.batch_euclidean_distance(&[1.0], &[1.0], 0).unwrap();
        assert!(results.is_empty(), "Zero dimension should return empty");
    }
}

#[test]
#[serial(gpu)]
fn test_gpu_dot_product_zero_dimension() {
    if let Some(gpu) = GpuAccelerator::new() {
        let results = gpu.batch_dot_product(&[1.0], &[1.0], 0).unwrap();
        assert!(results.is_empty(), "Zero dimension should return empty");
    }
}

// =========================================================================
// GPU-vs-SIMD correctness tests (Phase 1)
// =========================================================================

#[test]
#[serial(gpu)]
fn test_batch_euclidean_gpu_matches_simd() {
    if let Some(gpu) = GpuAccelerator::new() {
        let dim = 4;
        let query = vec![1.0, 0.0, 0.0, 0.0];
        let vectors = vec![
            0.0, 1.0, 0.0, 0.0, // vec 0
            1.0, 0.0, 0.0, 0.0, // vec 1 (identical to query)
            2.0, 0.0, 0.0, 0.0, // vec 2
        ];

        let gpu_results = gpu
            .batch_euclidean_distance(&vectors, &query, dim)
            .expect("GPU euclidean must succeed");

        let simd_results: Vec<f32> = (0..3)
            .map(|i| {
                let v = &vectors[i * dim..(i + 1) * dim];
                crate::simd_native::euclidean_native(&query, v)
            })
            .collect();

        for (gpu_val, simd_val) in gpu_results.iter().zip(simd_results.iter()) {
            assert!(
                (gpu_val - simd_val).abs() < 1e-5,
                "GPU={gpu_val} vs SIMD={simd_val}"
            );
        }
    }
}

#[test]
#[serial(gpu)]
fn test_batch_dot_product_gpu_matches_simd() {
    if let Some(gpu) = GpuAccelerator::new() {
        let dim = 4;
        let query = vec![1.0, 0.0, 0.0, 0.0];
        let vectors = vec![
            0.0, 1.0, 0.0, 0.0, // vec 0
            1.0, 0.0, 0.0, 0.0, // vec 1 (identical to query)
            2.0, 0.0, 0.0, 0.0, // vec 2
        ];

        let gpu_results = gpu
            .batch_dot_product(&vectors, &query, dim)
            .expect("GPU dot product must succeed");

        let simd_results: Vec<f32> = (0..3)
            .map(|i| {
                let v = &vectors[i * dim..(i + 1) * dim];
                crate::simd_native::dot_product_native(&query, v)
            })
            .collect();

        for (gpu_val, simd_val) in gpu_results.iter().zip(simd_results.iter()) {
            assert!(
                (gpu_val - simd_val).abs() < 1e-5,
                "GPU={gpu_val} vs SIMD={simd_val}"
            );
        }
    }
}

// =========================================================================
// Multi-pipeline compilation tests
// =========================================================================

/// Verifies that `GpuAccelerator::new()` compiles all three compute pipelines
/// (cosine, euclidean, dot_product) without error. Construction would fail
/// if any WGSL shader had a syntax error or entry-point mismatch.
#[test]
#[serial(gpu)]
fn test_gpu_has_all_pipelines() {
    if let Some(gpu) = GpuAccelerator::new() {
        // Exercise each pipeline through its public method to confirm compilation.
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![1.0, 0.0, 0.0];

        let cosine = gpu.batch_cosine_similarity(&vectors, &query, 3);
        assert!(cosine.is_ok(), "cosine pipeline must produce results");

        let euclidean = gpu.batch_euclidean_distance(&vectors, &query, 3);
        assert!(euclidean.is_ok(), "euclidean pipeline must produce results");

        let dot = gpu.batch_dot_product(&vectors, &query, 3);
        assert!(dot.is_ok(), "dot_product pipeline must produce results");
    }
}

// =========================================================================
// batch_distance_for_metric unified dispatch tests
// =========================================================================

#[test]
#[serial(gpu)]
fn test_batch_distance_for_metric_cosine() {
    use crate::distance::DistanceMetric;

    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![1.0, 0.0, 0.0];

        let result = gpu.batch_distance_for_metric(DistanceMetric::Cosine, &vectors, &query, 3);
        let values = result.expect("Cosine must return Some").unwrap();
        assert_eq!(values.len(), 1);
        assert!((values[0] - 1.0).abs() < 0.01, "Identical vectors -> ~1.0");
    }
}

#[test]
#[serial(gpu)]
fn test_batch_distance_for_metric_euclidean() {
    use crate::distance::DistanceMetric;

    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![0.0, 0.0, 0.0];
        let vectors = vec![3.0, 4.0, 0.0];

        let result = gpu.batch_distance_for_metric(DistanceMetric::Euclidean, &vectors, &query, 3);
        let values = result.expect("Euclidean must return Some").unwrap();
        assert_eq!(values.len(), 1);
        assert!(
            (values[0] - 5.0).abs() < 0.01,
            "Expected ~5.0, got {}",
            values[0]
        );
    }
}

#[test]
#[serial(gpu)]
fn test_batch_distance_for_metric_dot_product() {
    use crate::distance::DistanceMetric;

    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![2.0, 3.0, 4.0];
        let vectors = vec![2.0, 3.0, 4.0]; // 4+9+16 = 29

        let result = gpu.batch_distance_for_metric(DistanceMetric::DotProduct, &vectors, &query, 3);
        let values = result.expect("DotProduct must return Some").unwrap();
        assert_eq!(values.len(), 1);
        assert!(
            (values[0] - 29.0).abs() < 0.01,
            "Expected ~29.0, got {}",
            values[0]
        );
    }
}

#[test]
#[serial(gpu)]
fn test_batch_distance_for_metric_unsupported_returns_none() {
    use crate::distance::DistanceMetric;

    if let Some(gpu) = GpuAccelerator::new() {
        let query = vec![1.0, 0.0, 0.0];
        let vectors = vec![1.0, 0.0, 0.0];

        assert!(
            gpu.batch_distance_for_metric(DistanceMetric::Hamming, &vectors, &query, 3)
                .is_none(),
            "Hamming must return None (no GPU pipeline)"
        );
        assert!(
            gpu.batch_distance_for_metric(DistanceMetric::Jaccard, &vectors, &query, 3)
                .is_none(),
            "Jaccard must return None (no GPU pipeline)"
        );
    }
}

// =========================================================================
// Singleton tests
// =========================================================================

/// Verifies that `GpuAccelerator::global()` does not panic when called
/// from inside a tokio async runtime (i.e., `pollster::block_on` must
/// not nest inside tokio's reactor).
#[test]
#[serial(gpu)]
#[cfg(feature = "persistence")]
fn test_gpu_global_async_safe() {
    let rt = tokio::runtime::Runtime::new().expect("invariant: tokio runtime must init");
    // If init_device() uses pollster::block_on directly, this will panic.
    // After the async-safety fix, it delegates to a background thread.
    rt.block_on(async {
        let _gpu = GpuAccelerator::global();
        // No assertion on Some/None — GPU may not be available.
        // Absence of panic is the test.
    });
}

#[test]
#[serial(gpu)]
fn test_gpu_global_thread_safe() {
    let handle_a = std::thread::spawn(GpuAccelerator::global);
    let handle_b = std::thread::spawn(GpuAccelerator::global);

    let result_a = handle_a.join().expect("thread A must not panic");
    let result_b = handle_b.join().expect("thread B must not panic");

    match (&result_a, &result_b) {
        (Some(a), Some(b)) => {
            assert!(
                Arc::ptr_eq(a, b),
                "global() from different threads must return the same Arc instance"
            );
        }
        (None, None) => {
            // No GPU available on either thread — consistent.
        }
        _ => panic!("global() returned inconsistent results across threads"),
    }
}

// =========================================================================
// GPU rerank threshold tests (Phase 2)
// =========================================================================

#[test]
fn test_should_rerank_gpu_threshold() {
    // Below threshold: 100 * 128 = 12_800 < 262_144
    assert!(!GpuAccelerator::should_rerank_gpu(100, 128));

    // Below threshold (was above old 65K): 200 * 768 = 153_600 < 262_144
    assert!(!GpuAccelerator::should_rerank_gpu(200, 768));

    // Above threshold: 400 * 1536 = 614_400 > 262_144
    assert!(GpuAccelerator::should_rerank_gpu(400, 1536));

    // Exactly at threshold: 2048 * 128 = 262_144 (not strictly greater)
    assert!(!GpuAccelerator::should_rerank_gpu(2048, 128));

    // Just above threshold: 2049 * 128 = 262_272 > 262_144
    assert!(GpuAccelerator::should_rerank_gpu(2049, 128));
}

#[test]
#[serial(gpu)]
fn test_gpu_global_returns_same_arc() {
    let first = GpuAccelerator::global();
    let second = GpuAccelerator::global();

    match (&first, &second) {
        (Some(a), Some(b)) => {
            assert!(
                Arc::ptr_eq(a, b),
                "global() must return the same Arc instance"
            );
        }
        (None, None) => {
            // No GPU available — both must be None
        }
        _ => panic!("global() returned inconsistent results (one Some, one None)"),
    }
}