scirs2-metrics 0.4.2

Machine Learning evaluation metrics module for SciRS2 (scirs2-metrics)
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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
//! Information Retrieval Metrics
//!
//! Standalone functions for evaluating information retrieval systems.
//! These metrics measure the quality of ranked result lists returned
//! by search engines, recommendation systems, and similar IR systems.
//!
//! # Metrics
//!
//! - **Mean Reciprocal Rank (MRR)**: Average of reciprocal ranks of first relevant result
//! - **Normalized Discounted Cumulative Gain (NDCG)**: Measures ranking quality with position discount
//! - **Mean Average Precision at K (MAP@K)**: Mean of average precisions across queries
//! - **Precision@K**: Fraction of relevant documents in top-K results
//! - **Recall@K**: Fraction of total relevant documents found in top-K results
//! - **Hit Rate**: Fraction of queries where at least one relevant result appears in top-K
//!
//! # Examples
//!
//! ```
//! use scirs2_metrics::information_retrieval::{
//!     mean_reciprocal_rank, ndcg, precision_at_k, recall_at_k, hit_rate,
//! };
//!
//! // Binary relevance labels for 3 queries (1.0 = relevant, 0.0 = not)
//! let relevance = vec![
//!     vec![0.0, 1.0, 0.0, 0.0, 1.0],
//!     vec![1.0, 0.0, 0.0, 1.0, 0.0],
//!     vec![0.0, 0.0, 1.0, 0.0, 0.0],
//! ];
//!
//! let mrr = mean_reciprocal_rank(&relevance).expect("Failed");
//! let ndcg_val = ndcg(&relevance, 5).expect("Failed");
//! let p_at_3 = precision_at_k(&relevance, 3).expect("Failed");
//! let r_at_3 = recall_at_k(&relevance, 3).expect("Failed");
//! let hr = hit_rate(&relevance, 3).expect("Failed");
//! ```

use crate::error::{MetricsError, Result};

/// Computes Mean Reciprocal Rank (MRR) across multiple queries.
///
/// For each query, the reciprocal rank is 1/rank where rank is the position
/// of the first relevant document (1-indexed). If no relevant document exists,
/// the reciprocal rank is 0.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, a vector of relevance scores in ranked order.
///   A value > 0.0 indicates relevance.
///
/// # Returns
///
/// The mean reciprocal rank across all queries, in [0, 1].
///
/// # Errors
///
/// Returns error if the input is empty.
pub fn mean_reciprocal_rank(ranked_relevance: &[Vec<f64>]) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }

    let mut rr_sum = 0.0;
    for query_rel in ranked_relevance {
        let mut found = false;
        for (pos, &rel) in query_rel.iter().enumerate() {
            if rel > 0.0 {
                rr_sum += 1.0 / (pos as f64 + 1.0);
                found = true;
                break;
            }
        }
        if !found {
            // No relevant document: reciprocal rank is 0
        }
    }

    Ok(rr_sum / ranked_relevance.len() as f64)
}

/// Computes Discounted Cumulative Gain (DCG) for a single ranked list at position k.
///
/// DCG = sum_{i=1}^{k} (2^{rel_i} - 1) / log2(i + 1)
fn dcg_at_k(relevance: &[f64], k: usize) -> f64 {
    let limit = k.min(relevance.len());
    let mut dcg = 0.0;
    for i in 0..limit {
        let gain = (2.0_f64).powf(relevance[i]) - 1.0;
        let discount = (i as f64 + 2.0).log2(); // log2(i+2) since i is 0-indexed
        dcg += gain / discount;
    }
    dcg
}

/// Computes Normalized Discounted Cumulative Gain (NDCG) across multiple queries.
///
/// NDCG normalizes DCG by the ideal DCG (IDCG), which is the DCG obtained
/// with an ideal ranking (sorted by relevance in descending order).
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, a vector of relevance scores in ranked order.
/// * `k` - The cut-off position. Only the top-k results are considered.
///
/// # Returns
///
/// The mean NDCG across all queries, in [0, 1].
///
/// # Errors
///
/// Returns error if input is empty or k is 0.
pub fn ndcg(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let mut ndcg_sum = 0.0;
    let mut valid_queries = 0;

    for query_rel in ranked_relevance {
        let dcg = dcg_at_k(query_rel, k);

        // Compute ideal DCG: sort relevance in descending order
        let mut ideal_rel = query_rel.clone();
        ideal_rel.sort_by(|a, b| b.partial_cmp(a).unwrap_or(std::cmp::Ordering::Equal));
        let idcg = dcg_at_k(&ideal_rel, k);

        if idcg > 0.0 {
            ndcg_sum += dcg / idcg;
            valid_queries += 1;
        } else {
            // No relevant documents for this query; NDCG is defined as 0 or skipped
            // We include it as 0.0 for consistency
            valid_queries += 1;
        }
    }

    if valid_queries == 0 {
        return Ok(0.0);
    }

    Ok(ndcg_sum / valid_queries as f64)
}

/// Computes NDCG for a single query (not averaged).
///
/// This is useful when you want per-query NDCG values.
///
/// # Arguments
///
/// * `relevance` - Relevance scores in ranked order for a single query.
/// * `k` - The cut-off position.
///
/// # Returns
///
/// The NDCG value for the single query, in [0, 1].
pub fn ndcg_single(relevance: &[f64], k: usize) -> Result<f64> {
    if relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let dcg = dcg_at_k(relevance, k);

    let mut ideal_rel: Vec<f64> = relevance.to_vec();
    ideal_rel.sort_by(|a, b| b.partial_cmp(a).unwrap_or(std::cmp::Ordering::Equal));
    let idcg = dcg_at_k(&ideal_rel, k);

    if idcg <= 0.0 {
        return Ok(0.0);
    }

    Ok(dcg / idcg)
}

/// Computes Mean Average Precision at K (MAP@K) across multiple queries.
///
/// Average Precision (AP) is the average of precision values at each relevant
/// position in the ranked list. MAP is the mean of AP values across queries.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores (>0 = relevant) in ranked order.
/// * `k` - The cut-off position. Only the top-k results are considered.
///
/// # Returns
///
/// The MAP@K value in [0, 1].
///
/// # Errors
///
/// Returns error if input is empty or k is 0.
pub fn map_at_k(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let mut ap_sum = 0.0;

    for query_rel in ranked_relevance {
        let limit = k.min(query_rel.len());
        let mut relevant_count = 0.0;
        let mut precision_sum = 0.0;

        for i in 0..limit {
            if query_rel[i] > 0.0 {
                relevant_count += 1.0;
                precision_sum += relevant_count / (i as f64 + 1.0);
            }
        }

        // Total relevant documents (could be beyond k)
        let total_relevant: f64 = query_rel.iter().filter(|&&r| r > 0.0).count() as f64;

        if total_relevant > 0.0 {
            ap_sum += precision_sum / total_relevant;
        }
    }

    Ok(ap_sum / ranked_relevance.len() as f64)
}

/// Computes Mean Average Precision across all positions (no cutoff).
///
/// This is equivalent to MAP@K where K equals the list length.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
///
/// # Returns
///
/// The MAP value in [0, 1].
pub fn mean_average_precision(ranked_relevance: &[Vec<f64>]) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }

    // Use the maximum list length as k
    let max_k = ranked_relevance.iter().map(|q| q.len()).max().unwrap_or(0);

    if max_k == 0 {
        return Err(MetricsError::InvalidInput(
            "All query result lists are empty".to_string(),
        ));
    }

    map_at_k(ranked_relevance, max_k)
}

/// Computes Precision@K averaged across multiple queries.
///
/// Precision@K is the fraction of relevant documents in the top-K results.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
/// * `k` - The cut-off position.
///
/// # Returns
///
/// The mean Precision@K in [0, 1].
///
/// # Errors
///
/// Returns error if input is empty or k is 0.
pub fn precision_at_k(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let mut prec_sum = 0.0;

    for query_rel in ranked_relevance {
        let limit = k.min(query_rel.len());
        let relevant_in_top_k = query_rel[..limit].iter().filter(|&&r| r > 0.0).count();
        prec_sum += relevant_in_top_k as f64 / k as f64;
    }

    Ok(prec_sum / ranked_relevance.len() as f64)
}

/// Computes Recall@K averaged across multiple queries.
///
/// Recall@K is the fraction of total relevant documents found in the top-K results.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
///   The full list should contain all candidate documents (relevant and non-relevant).
/// * `k` - The cut-off position.
///
/// # Returns
///
/// The mean Recall@K in [0, 1].
///
/// # Errors
///
/// Returns error if input is empty or k is 0.
pub fn recall_at_k(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let mut recall_sum = 0.0;
    let mut valid_queries = 0;

    for query_rel in ranked_relevance {
        let total_relevant: usize = query_rel.iter().filter(|&&r| r > 0.0).count();
        if total_relevant == 0 {
            // Skip queries with no relevant documents
            continue;
        }

        let limit = k.min(query_rel.len());
        let relevant_in_top_k = query_rel[..limit].iter().filter(|&&r| r > 0.0).count();
        recall_sum += relevant_in_top_k as f64 / total_relevant as f64;
        valid_queries += 1;
    }

    if valid_queries == 0 {
        return Ok(0.0);
    }

    Ok(recall_sum / valid_queries as f64)
}

/// Computes Hit Rate at K across multiple queries.
///
/// Hit Rate@K measures the fraction of queries for which at least one relevant
/// document appears in the top-K results.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
/// * `k` - The cut-off position.
///
/// # Returns
///
/// The hit rate in [0, 1].
///
/// # Errors
///
/// Returns error if input is empty or k is 0.
pub fn hit_rate(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }
    if k == 0 {
        return Err(MetricsError::InvalidInput(
            "k must be greater than 0".to_string(),
        ));
    }

    let mut hits = 0;

    for query_rel in ranked_relevance {
        let limit = k.min(query_rel.len());
        let has_relevant = query_rel[..limit].iter().any(|&r| r > 0.0);
        if has_relevant {
            hits += 1;
        }
    }

    Ok(hits as f64 / ranked_relevance.len() as f64)
}

/// Computes R-Precision for each query and returns the mean.
///
/// R-Precision is Precision@R where R is the number of relevant documents
/// for that query. It equals the fraction of relevant documents found in
/// the top-R positions.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
///
/// # Returns
///
/// The mean R-Precision in [0, 1].
pub fn r_precision(ranked_relevance: &[Vec<f64>]) -> Result<f64> {
    if ranked_relevance.is_empty() {
        return Err(MetricsError::InvalidInput(
            "ranked_relevance must not be empty".to_string(),
        ));
    }

    let mut rp_sum = 0.0;
    let mut valid_queries = 0;

    for query_rel in ranked_relevance {
        let total_relevant: usize = query_rel.iter().filter(|&&r| r > 0.0).count();
        if total_relevant == 0 {
            continue;
        }

        let limit = total_relevant.min(query_rel.len());
        let relevant_in_top_r = query_rel[..limit].iter().filter(|&&r| r > 0.0).count();
        rp_sum += relevant_in_top_r as f64 / total_relevant as f64;
        valid_queries += 1;
    }

    if valid_queries == 0 {
        return Ok(0.0);
    }

    Ok(rp_sum / valid_queries as f64)
}

/// Computes the F1@K score, the harmonic mean of Precision@K and Recall@K.
///
/// # Arguments
///
/// * `ranked_relevance` - For each query, binary relevance scores in ranked order.
/// * `k` - The cut-off position.
///
/// # Returns
///
/// The mean F1@K in [0, 1].
pub fn f1_at_k(ranked_relevance: &[Vec<f64>], k: usize) -> Result<f64> {
    let p = precision_at_k(ranked_relevance, k)?;
    let r = recall_at_k(ranked_relevance, k)?;

    if p + r <= 0.0 {
        return Ok(0.0);
    }

    Ok(2.0 * p * r / (p + r))
}

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

    // ---- MRR tests ----

    #[test]
    fn test_mrr_perfect_ranking() {
        // First result is always relevant
        let rel = vec![vec![1.0, 0.0, 0.0], vec![1.0, 0.0, 0.0]];
        let mrr = mean_reciprocal_rank(&rel).expect("should succeed");
        assert!((mrr - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_mrr_second_position() {
        // Relevant at position 2 for all queries
        let rel = vec![vec![0.0, 1.0, 0.0], vec![0.0, 1.0, 0.0]];
        let mrr = mean_reciprocal_rank(&rel).expect("should succeed");
        assert!((mrr - 0.5).abs() < 1e-10);
    }

    #[test]
    fn test_mrr_no_relevant() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let mrr = mean_reciprocal_rank(&rel).expect("should succeed");
        assert!((mrr - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_mrr_mixed() {
        // Query 1: relevant at position 1 -> RR=1.0
        // Query 2: relevant at position 3 -> RR=1/3
        let rel = vec![vec![1.0, 0.0, 0.0], vec![0.0, 0.0, 1.0]];
        let mrr = mean_reciprocal_rank(&rel).expect("should succeed");
        let expected = (1.0 + 1.0 / 3.0) / 2.0;
        assert!((mrr - expected).abs() < 1e-10);
    }

    #[test]
    fn test_mrr_empty_input() {
        let rel: Vec<Vec<f64>> = vec![];
        assert!(mean_reciprocal_rank(&rel).is_err());
    }

    // ---- NDCG tests ----

    #[test]
    fn test_ndcg_perfect_binary() {
        // All relevant docs at top
        let rel = vec![vec![1.0, 1.0, 0.0, 0.0]];
        let val = ndcg(&rel, 4).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_ndcg_reversed_binary() {
        // Relevant docs at bottom -> lower NDCG
        let rel = vec![vec![0.0, 0.0, 1.0, 1.0]];
        let val = ndcg(&rel, 4).expect("should succeed");
        assert!(val < 1.0);
        assert!(val > 0.0);
    }

    #[test]
    fn test_ndcg_graded_relevance() {
        // Perfect ranking for graded relevance: 3, 2, 1, 0
        let rel = vec![vec![3.0, 2.0, 1.0, 0.0]];
        let val = ndcg(&rel, 4).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_ndcg_single_perfect() {
        let val = ndcg_single(&[3.0, 2.0, 1.0, 0.0], 4).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_ndcg_no_relevant() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = ndcg(&rel, 3).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_ndcg_k_zero() {
        let rel = vec![vec![1.0, 0.0]];
        assert!(ndcg(&rel, 0).is_err());
    }

    // ---- MAP@K tests ----

    #[test]
    fn test_map_at_k_perfect() {
        // Two relevant docs at positions 1 and 2
        let rel = vec![vec![1.0, 1.0, 0.0, 0.0]];
        let val = map_at_k(&rel, 4).expect("should succeed");
        // AP = (1/1 + 2/2) / 2 = 1.0
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_map_at_k_spread() {
        // Relevant at positions 1 and 3
        let rel = vec![vec![1.0, 0.0, 1.0, 0.0]];
        let val = map_at_k(&rel, 4).expect("should succeed");
        // AP = (1/1 + 2/3) / 2 = (1.0 + 0.6667) / 2 = 0.8333
        assert!((val - 5.0 / 6.0).abs() < 1e-10);
    }

    #[test]
    fn test_map_at_k_no_relevant() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = map_at_k(&rel, 3).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_map_at_k_cutoff() {
        // Relevant at position 4, but k=2
        let rel = vec![vec![0.0, 0.0, 0.0, 1.0]];
        let val = map_at_k(&rel, 2).expect("should succeed");
        // No relevant in top-2, but total_relevant=1, so AP=0/1=0
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_map_at_k_empty_input() {
        let rel: Vec<Vec<f64>> = vec![];
        assert!(map_at_k(&rel, 3).is_err());
    }

    #[test]
    fn test_mean_average_precision() {
        let rel = vec![vec![1.0, 0.0, 1.0, 0.0], vec![0.0, 1.0, 0.0, 1.0]];
        let val = mean_average_precision(&rel).expect("should succeed");
        assert!(val > 0.0 && val <= 1.0);
    }

    // ---- Precision@K tests ----

    #[test]
    fn test_precision_at_k_all_relevant() {
        let rel = vec![vec![1.0, 1.0, 1.0]];
        let val = precision_at_k(&rel, 3).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_precision_at_k_none_relevant() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = precision_at_k(&rel, 3).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_precision_at_k_partial() {
        // 2 out of 3 relevant in top-3
        let rel = vec![vec![1.0, 0.0, 1.0, 0.0]];
        let val = precision_at_k(&rel, 3).expect("should succeed");
        assert!((val - 2.0 / 3.0).abs() < 1e-10);
    }

    #[test]
    fn test_precision_at_k_larger_than_list() {
        // k=5 but only 3 results
        let rel = vec![vec![1.0, 1.0, 0.0]];
        let val = precision_at_k(&rel, 5).expect("should succeed");
        // 2 relevant out of 5 (k)
        assert!((val - 2.0 / 5.0).abs() < 1e-10);
    }

    #[test]
    fn test_precision_at_k_multiple_queries() {
        let rel = vec![
            vec![1.0, 1.0, 0.0], // P@2 = 2/2 = 1.0
            vec![0.0, 0.0, 1.0], // P@2 = 0/2 = 0.0
        ];
        let val = precision_at_k(&rel, 2).expect("should succeed");
        assert!((val - 0.5).abs() < 1e-10);
    }

    // ---- Recall@K tests ----

    #[test]
    fn test_recall_at_k_all_found() {
        // 2 relevant total, both in top-3
        let rel = vec![vec![1.0, 0.0, 1.0, 0.0]];
        let val = recall_at_k(&rel, 3).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_recall_at_k_partial() {
        // 3 relevant total, 1 in top-2
        let rel = vec![vec![1.0, 0.0, 1.0, 1.0]];
        let val = recall_at_k(&rel, 2).expect("should succeed");
        assert!((val - 1.0 / 3.0).abs() < 1e-10);
    }

    #[test]
    fn test_recall_at_k_none_found() {
        // 2 relevant, but none in top-2
        let rel = vec![vec![0.0, 0.0, 1.0, 1.0]];
        let val = recall_at_k(&rel, 2).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_recall_at_k_no_relevant_docs() {
        // No relevant documents at all
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = recall_at_k(&rel, 3).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_recall_at_k_multiple_queries() {
        let rel = vec![
            vec![1.0, 0.0, 1.0], // 2 relevant, 1 in top-1 -> recall=0.5
            vec![0.0, 1.0, 0.0], // 1 relevant, 0 in top-1 -> recall=0.0
        ];
        let val = recall_at_k(&rel, 1).expect("should succeed");
        assert!((val - 0.25).abs() < 1e-10);
    }

    // ---- Hit Rate tests ----

    #[test]
    fn test_hit_rate_all_hit() {
        let rel = vec![vec![1.0, 0.0, 0.0], vec![0.0, 1.0, 0.0]];
        let val = hit_rate(&rel, 2).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_hit_rate_no_hit() {
        let rel = vec![vec![0.0, 0.0, 1.0], vec![0.0, 0.0, 1.0]];
        let val = hit_rate(&rel, 2).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_hit_rate_partial() {
        let rel = vec![
            vec![1.0, 0.0, 0.0], // hit in top-1
            vec![0.0, 0.0, 1.0], // no hit in top-1
        ];
        let val = hit_rate(&rel, 1).expect("should succeed");
        assert!((val - 0.5).abs() < 1e-10);
    }

    #[test]
    fn test_hit_rate_k_larger_than_list() {
        let rel = vec![vec![0.0, 1.0]];
        let val = hit_rate(&rel, 10).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_hit_rate_empty() {
        let rel: Vec<Vec<f64>> = vec![];
        assert!(hit_rate(&rel, 3).is_err());
    }

    // ---- R-Precision tests ----

    #[test]
    fn test_r_precision_perfect() {
        // 2 relevant, both in top-2
        let rel = vec![vec![1.0, 1.0, 0.0, 0.0]];
        let val = r_precision(&rel).expect("should succeed");
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_r_precision_half() {
        // 2 relevant, 1 in top-2
        let rel = vec![vec![1.0, 0.0, 1.0, 0.0]];
        let val = r_precision(&rel).expect("should succeed");
        assert!((val - 0.5).abs() < 1e-10);
    }

    #[test]
    fn test_r_precision_none_at_top() {
        // 1 relevant, not in top-1
        let rel = vec![vec![0.0, 1.0]];
        let val = r_precision(&rel).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_r_precision_no_relevant() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = r_precision(&rel).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    // ---- F1@K tests ----

    #[test]
    fn test_f1_at_k_perfect() {
        // All 2 relevant in top-2
        let rel = vec![vec![1.0, 1.0, 0.0]];
        let val = f1_at_k(&rel, 2).expect("should succeed");
        // P@2 = 1.0, R@2 = 1.0 -> F1 = 1.0
        assert!((val - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_f1_at_k_zero() {
        let rel = vec![vec![0.0, 0.0, 0.0]];
        let val = f1_at_k(&rel, 2).expect("should succeed");
        assert!((val - 0.0).abs() < 1e-10);
    }

    #[test]
    fn test_f1_at_k_mixed() {
        // 2 relevant total, 1 in top-2
        let rel = vec![vec![1.0, 0.0, 1.0]];
        let val = f1_at_k(&rel, 2).expect("should succeed");
        // P@2 = 1/2 = 0.5, R@2 = 1/2 = 0.5 -> F1 = 0.5
        assert!((val - 0.5).abs() < 1e-10);
    }

    #[test]
    fn test_f1_at_k_k_zero() {
        let rel = vec![vec![1.0, 0.0]];
        assert!(f1_at_k(&rel, 0).is_err());
    }
}