velesdb-core 1.14.1

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
//! Tests for `FusionStrategy` implementations.

use super::strategy::FusionStrategy;

// =============================================================================
// Test helpers
// =============================================================================

/// Creates sample search results for testing.
/// Each inner Vec represents results from one query: `Vec<(doc_id, score)>`
fn sample_results() -> Vec<Vec<(u64, f32)>> {
    vec![
        // Query 1 results
        vec![(1, 0.95), (2, 0.85), (3, 0.75), (4, 0.65)],
        // Query 2 results
        vec![(2, 0.90), (1, 0.80), (5, 0.70), (3, 0.60)],
        // Query 3 results
        vec![(1, 0.92), (3, 0.82), (2, 0.72), (6, 0.62)],
    ]
}

/// Results where documents appear in different subsets of queries.
fn partial_overlap_results() -> Vec<Vec<(u64, f32)>> {
    vec![
        vec![(1, 0.9), (2, 0.8)],   // Doc 1, 2
        vec![(2, 0.85), (3, 0.75)], // Doc 2, 3
        vec![(3, 0.8), (4, 0.7)],   // Doc 3, 4
    ]
}

/// Single query results (edge case).
fn single_query_results() -> Vec<Vec<(u64, f32)>> {
    vec![vec![(1, 0.95), (2, 0.85), (3, 0.75)]]
}

/// Empty results (edge case).
fn empty_results() -> Vec<Vec<(u64, f32)>> {
    vec![]
}

/// Results with empty queries.
fn results_with_empty_query() -> Vec<Vec<(u64, f32)>> {
    vec![
        vec![(1, 0.9), (2, 0.8)],
        vec![], // Empty query
        vec![(1, 0.85), (3, 0.75)],
    ]
}

// =============================================================================
// AC1: FusionStrategy::Average tests
// =============================================================================

#[test]
fn test_average_basic() {
    let strategy = FusionStrategy::Average;
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // Doc 1 appears in all 3 queries: (0.95 + 0.80 + 0.92) / 3 = 0.89
    // Doc 2 appears in all 3 queries: (0.85 + 0.90 + 0.72) / 3 = 0.823...
    // Doc 3 appears in all 3 queries: (0.75 + 0.60 + 0.82) / 3 = 0.723...

    assert!(!fused.is_empty());

    // Check doc 1 is present and has correct average
    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    assert!(
        (doc1.1 - 0.89).abs() < 0.01,
        "Doc 1 avg should be ~0.89, got {}",
        doc1.1
    );

    // Results should be sorted by score descending
    for i in 1..fused.len() {
        assert!(
            fused[i - 1].1 >= fused[i].1,
            "Results should be sorted descending"
        );
    }
}

#[test]
fn test_average_partial_overlap() {
    let strategy = FusionStrategy::Average;
    let results = partial_overlap_results();

    let fused = strategy.fuse(results).unwrap();

    // Doc 1: only in query 1 → 0.9 / 1 = 0.9
    // Doc 2: in query 1 and 2 → (0.8 + 0.85) / 2 = 0.825
    // Doc 3: in query 2 and 3 → (0.75 + 0.8) / 2 = 0.775
    // Doc 4: only in query 3 → 0.7 / 1 = 0.7

    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    assert!((doc1.1 - 0.9).abs() < 0.01);

    let doc2 = fused.iter().find(|(id, _)| *id == 2).unwrap();
    assert!((doc2.1 - 0.825).abs() < 0.01);
}

#[test]
fn test_average_single_query() {
    let strategy = FusionStrategy::Average;
    let results = single_query_results();

    let fused = strategy.fuse(results).unwrap();

    // Single query: average = original scores
    assert_eq!(fused.len(), 3);
    assert!((fused[0].1 - 0.95).abs() < 0.001);
}

#[test]
fn test_average_empty_input() {
    let strategy = FusionStrategy::Average;
    let results = empty_results();

    let fused = strategy.fuse(results).unwrap();
    assert!(fused.is_empty());
}

#[test]
fn test_average_with_empty_query() {
    let strategy = FusionStrategy::Average;
    let results = results_with_empty_query();

    let fused = strategy.fuse(results).unwrap();

    // Should handle empty queries gracefully
    assert!(!fused.is_empty());
}

// =============================================================================
// AC2: FusionStrategy::Maximum tests
// =============================================================================

#[test]
fn test_maximum_basic() {
    let strategy = FusionStrategy::Maximum;
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // Doc 1: max(0.95, 0.80, 0.92) = 0.95
    // Doc 2: max(0.85, 0.90, 0.72) = 0.90
    // Doc 3: max(0.75, 0.60, 0.82) = 0.82

    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    assert!(
        (doc1.1 - 0.95).abs() < 0.001,
        "Doc 1 max should be 0.95, got {}",
        doc1.1
    );

    let doc2 = fused.iter().find(|(id, _)| *id == 2).unwrap();
    assert!(
        (doc2.1 - 0.90).abs() < 0.001,
        "Doc 2 max should be 0.90, got {}",
        doc2.1
    );

    // Sorted descending
    for i in 1..fused.len() {
        assert!(fused[i - 1].1 >= fused[i].1);
    }
}

#[test]
fn test_maximum_partial_overlap() {
    let strategy = FusionStrategy::Maximum;
    let results = partial_overlap_results();

    let fused = strategy.fuse(results).unwrap();

    // Doc 2: max(0.8, 0.85) = 0.85
    let doc2 = fused.iter().find(|(id, _)| *id == 2).unwrap();
    assert!((doc2.1 - 0.85).abs() < 0.001);
}

#[test]
fn test_maximum_single_query() {
    let strategy = FusionStrategy::Maximum;
    let results = single_query_results();

    let fused = strategy.fuse(results).unwrap();

    // Single query: max = original scores
    assert_eq!(fused.len(), 3);
    assert!((fused[0].1 - 0.95).abs() < 0.001);
}

// =============================================================================
// AC3: FusionStrategy::RRF tests
// =============================================================================

#[test]
fn test_rrf_basic() {
    let strategy = FusionStrategy::RRF { k: 60 };
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // RRF formula: score = Σ 1/(k + rank)
    // Doc 1: rank 1 in Q1, rank 2 in Q2, rank 1 in Q3
    //        1/(60+1) + 1/(60+2) + 1/(60+1) = 0.01639 + 0.01613 + 0.01639 = 0.04891

    assert!(!fused.is_empty());

    // Doc 1 should have high score (appears high in all queries)
    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    assert!(
        doc1.1 > 0.04,
        "Doc 1 RRF score should be > 0.04, got {}",
        doc1.1
    );

    // Sorted descending
    for i in 1..fused.len() {
        assert!(fused[i - 1].1 >= fused[i].1);
    }
}

#[test]
fn test_rrf_k_parameter() {
    let results = sample_results();

    // Lower k = more weight to top ranks
    let strategy_low_k = FusionStrategy::RRF { k: 1 };
    let strategy_high_k = FusionStrategy::RRF { k: 100 };

    let fused_low = strategy_low_k.fuse(results.clone()).unwrap();
    let fused_high = strategy_high_k.fuse(results).unwrap();

    // With lower k, scores should be higher overall
    let doc1_low = fused_low.iter().find(|(id, _)| *id == 1).unwrap();
    let doc1_high = fused_high.iter().find(|(id, _)| *id == 1).unwrap();

    assert!(
        doc1_low.1 > doc1_high.1,
        "Lower k should yield higher scores"
    );
}

#[test]
fn test_rrf_default_k() {
    // Default k=60 is standard in literature
    let strategy = FusionStrategy::rrf_default();

    match strategy {
        FusionStrategy::RRF { k } => assert_eq!(k, 60),
        _ => panic!("Expected RRF variant"),
    }
}

#[test]
fn test_rrf_single_query() {
    let strategy = FusionStrategy::RRF { k: 60 };
    let results = single_query_results();

    let fused = strategy.fuse(results).unwrap();

    // Single query: RRF based on single ranking
    assert_eq!(fused.len(), 3);

    // First doc should have highest RRF score
    assert!(fused[0].1 > fused[1].1);
}

// =============================================================================
// AC4: FusionStrategy::Weighted tests
// =============================================================================

#[test]
fn test_weighted_basic() {
    let strategy = FusionStrategy::Weighted {
        avg_weight: 0.6,
        max_weight: 0.3,
        hit_weight: 0.1,
    };
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // Doc 1: avg=0.89, max=0.95, hits=3/3=1.0
    // score = 0.6*0.89 + 0.3*0.95 + 0.1*1.0 = 0.534 + 0.285 + 0.1 = 0.919

    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    assert!(
        (doc1.1 - 0.919).abs() < 0.02,
        "Doc 1 weighted should be ~0.919, got {}",
        doc1.1
    );

    // Sorted descending
    for i in 1..fused.len() {
        assert!(fused[i - 1].1 >= fused[i].1);
    }
}

#[test]
fn test_weighted_partial_overlap() {
    let strategy = FusionStrategy::Weighted {
        avg_weight: 0.6,
        max_weight: 0.3,
        hit_weight: 0.1,
    };
    let results = partial_overlap_results(); // 3 queries

    let fused = strategy.fuse(results).unwrap();

    // Doc 1: avg=0.9, max=0.9, hits=1/3=0.333
    // score = 0.6*0.9 + 0.3*0.9 + 0.1*0.333 = 0.54 + 0.27 + 0.0333 = 0.8433

    // Doc 2: avg=0.825, max=0.85, hits=2/3=0.667
    // score = 0.6*0.825 + 0.3*0.85 + 0.1*0.667 = 0.495 + 0.255 + 0.0667 = 0.8167

    let doc1 = fused.iter().find(|(id, _)| *id == 1).unwrap();
    let doc2 = fused.iter().find(|(id, _)| *id == 2).unwrap();

    // Doc 1 should rank higher due to higher avg/max despite lower hit count
    assert!(doc1.1 > doc2.1);
}

#[test]
fn test_weighted_validation_sum_to_one() {
    // Weights must sum to 1.0
    let result = FusionStrategy::weighted(0.5, 0.3, 0.1);
    assert!(result.is_err(), "Weights summing to 0.9 should fail");

    let result = FusionStrategy::weighted(0.6, 0.3, 0.1);
    assert!(result.is_ok(), "Weights summing to 1.0 should succeed");

    let result = FusionStrategy::weighted(0.5, 0.5, 0.1);
    assert!(result.is_err(), "Weights summing to 1.1 should fail");
}

#[test]
fn test_weighted_validation_non_negative() {
    let result = FusionStrategy::weighted(-0.1, 0.6, 0.5);
    assert!(result.is_err(), "Negative weights should fail");
}

#[test]
fn test_weighted_zero_hit_weight() {
    // hit_weight = 0 is valid (only use avg and max)
    let strategy = FusionStrategy::Weighted {
        avg_weight: 0.7,
        max_weight: 0.3,
        hit_weight: 0.0,
    };
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();
    assert!(!fused.is_empty());
}

// =============================================================================
// Edge cases and error handling
// =============================================================================

#[test]
fn test_fuse_preserves_all_documents() {
    let strategy = FusionStrategy::Average;
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // All unique doc IDs should be present: 1, 2, 3, 4, 5, 6
    let ids: std::collections::HashSet<u64> = fused.iter().map(|(id, _)| *id).collect();
    assert!(ids.contains(&1));
    assert!(ids.contains(&2));
    assert!(ids.contains(&3));
    assert!(ids.contains(&4));
    assert!(ids.contains(&5));
    assert!(ids.contains(&6));
}

#[test]
fn test_fuse_handles_duplicate_ids_in_same_query() {
    let strategy = FusionStrategy::Average;
    let results = vec![
        vec![(1, 0.9), (1, 0.8), (2, 0.7)], // Doc 1 appears twice (should take best)
    ];

    let fused = strategy.fuse(results).unwrap();

    // Doc 1 should appear once with the best score
    let doc1_count = fused.iter().filter(|(id, _)| *id == 1).count();
    assert_eq!(doc1_count, 1, "Doc 1 should appear exactly once");
}

#[test]
fn test_fuse_score_bounds() {
    let strategy = FusionStrategy::Average;
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    // All scores should be in [0, 1] range for Average
    for (_, score) in &fused {
        assert!(
            *score >= 0.0 && *score <= 1.0,
            "Score {score} out of bounds"
        );
    }
}

#[test]
fn test_rrf_scores_are_positive() {
    let strategy = FusionStrategy::RRF { k: 60 };
    let results = sample_results();

    let fused = strategy.fuse(results).unwrap();

    for (_, score) in &fused {
        assert!(*score > 0.0, "RRF score should be positive");
    }
}

// =============================================================================
// AC5: FusionStrategy::RelativeScore tests
// =============================================================================

#[test]
fn test_rsf_normalization() {
    // Test min-max normalization on known inputs
    let strategy = FusionStrategy::relative_score(0.5, 0.5).unwrap();

    // Dense: scores 1.0, 2.0, 3.0 -> normalized 0.0, 0.5, 1.0
    // Sparse: scores 10.0, 20.0 -> normalized 0.0, 1.0
    let results = vec![
        vec![(1, 1.0_f32), (2, 2.0), (3, 3.0)], // dense
        vec![(2, 10.0_f32), (4, 20.0)],         // sparse
    ];

    let fused = strategy.fuse(results).unwrap();

    // doc 3: dense_norm=1.0, sparse=missing(0) -> 0.5*1.0 + 0.5*0.0 = 0.5
    // doc 4: dense=missing(0), sparse_norm=1.0 -> 0.5*0.0 + 0.5*1.0 = 0.5
    // doc 2: dense_norm=0.5, sparse_norm=0.0 -> 0.5*0.5 + 0.5*0.0 = 0.25
    // doc 1: dense_norm=0.0, sparse=missing(0) -> 0.0
    let find = |id: u64| fused.iter().find(|(i, _)| *i == id).unwrap().1;
    assert!((find(3) - 0.5).abs() < 1e-5);
    assert!((find(4) - 0.5).abs() < 1e-5);
    assert!((find(2) - 0.25).abs() < 1e-5);
    assert!((find(1) - 0.0).abs() < 1e-5);
}

#[test]
fn test_rsf_normalization_equal_scores() {
    // Edge case: all scores equal -> all get 0.5
    let strategy = FusionStrategy::relative_score(0.5, 0.5).unwrap();
    let results = vec![
        vec![(1, 5.0_f32), (2, 5.0), (3, 5.0)],
        vec![(1, 3.0_f32), (4, 3.0)],
    ];

    let fused = strategy.fuse(results).unwrap();
    let find = |id: u64| fused.iter().find(|(i, _)| *i == id).unwrap().1;

    // Dense all 0.5, sparse all 0.5
    // doc 1: 0.5*0.5 + 0.5*0.5 = 0.5
    // doc 2: 0.5*0.5 + 0.5*0.0 = 0.25
    // doc 4: 0.5*0.0 + 0.5*0.5 = 0.25
    assert!((find(1) - 0.5).abs() < 1e-5);
    assert!((find(2) - 0.25).abs() < 1e-5);
    assert!((find(4) - 0.25).abs() < 1e-5);
}

#[test]
fn test_rsf_fuse_two_branches() {
    // Weighted combination: dense=0.7, sparse=0.3
    let strategy = FusionStrategy::relative_score(0.7, 0.3).unwrap();
    let results = vec![
        vec![(1, 10.0_f32), (2, 8.0), (3, 6.0)], // dense
        vec![(3, 5.0_f32), (4, 3.0), (1, 1.0)],  // sparse
    ];

    let fused = strategy.fuse(results).unwrap();

    // Dense norm: 1->1.0, 2->0.5, 3->0.0
    // Sparse norm: 3->1.0, 4->0.5, 1->0.0
    // doc 1: 0.7*1.0 + 0.3*0.0 = 0.7
    // doc 3: 0.7*0.0 + 0.3*1.0 = 0.3
    // doc 2: 0.7*0.5 + 0.3*0.0 = 0.35
    // doc 4: 0.7*0.0 + 0.3*0.5 = 0.15
    assert_eq!(fused[0].0, 1); // 0.7
    assert_eq!(fused[1].0, 2); // 0.35
    assert_eq!(fused[2].0, 3); // 0.3
    assert_eq!(fused[3].0, 4); // 0.15
}

#[test]
fn test_rsf_single_branch_empty() {
    // Dense empty -> only sparse results pass through
    let strategy = FusionStrategy::relative_score(0.5, 0.5).unwrap();
    let results = vec![
        vec![],                                 // empty dense
        vec![(1, 5.0_f32), (2, 3.0), (3, 1.0)], // sparse
    ];

    let fused = strategy.fuse(results).unwrap();
    assert_eq!(fused.len(), 3);
    // All sparse-only: dense is 0.0
    // Sparse norm: 1->1.0, 2->0.5, 3->0.0
    // doc 1: 0.5*0.0 + 0.5*1.0 = 0.5
    // doc 2: 0.5*0.0 + 0.5*0.5 = 0.25
    // doc 3: 0.5*0.0 + 0.5*0.0 = 0.0
    assert_eq!(fused[0].0, 1);
    assert!((fused[0].1 - 0.5).abs() < 1e-5);
}

#[test]
fn test_rsf_validation_negative_weight() {
    let result = FusionStrategy::relative_score(-0.1, 1.1);
    assert!(result.is_err());
}

#[test]
fn test_rsf_validation_sum_not_one() {
    let result = FusionStrategy::relative_score(0.3, 0.3);
    assert!(result.is_err());
}

#[test]
fn test_rsf_ignores_extra_branches_beyond_two() {
    // M-7: fuse_relative_score silently drops branches beyond index 1.
    // The result must be identical to passing only the first two branches.
    let strategy = FusionStrategy::relative_score(0.6, 0.4).unwrap();

    let two_branches = vec![
        vec![(1_u64, 10.0_f32), (2, 8.0)], // dense
        vec![(2_u64, 5.0_f32), (3, 3.0)],  // sparse
    ];
    let three_branches = vec![
        vec![(1_u64, 10.0_f32), (2, 8.0)], // dense
        vec![(2_u64, 5.0_f32), (3, 3.0)],  // sparse
        vec![(4_u64, 99.0_f32)],           // extra (must be ignored)
    ];

    let fused_two = strategy.fuse(two_branches).unwrap();
    let fused_three = strategy.fuse(three_branches).unwrap();

    // Extra branch doc 4 must NOT appear in the results.
    assert!(
        !fused_three.iter().any(|(id, _)| *id == 4),
        "doc 4 from the extra branch must be absent from RSF output"
    );

    // Scores for the shared documents must be identical.
    for (id, score) in &fused_two {
        let matching = fused_three.iter().find(|(i, _)| i == id);
        assert!(
            matching.is_some(),
            "doc {id} must appear in three-branch result"
        );
        let (_, score_three) = matching.unwrap();
        assert!(
            (score - score_three).abs() < 1e-5,
            "score for doc {id} must not change when an extra branch is present"
        );
    }
}