velesdb-core 1.14.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

//! Unified scored result type for vector search and graph traversal.
//!
//! `ScoredResult` replaces scattered `(u64, f32)` tuple patterns across search
//! paths, providing a named, self-documenting type with bidirectional conversions.

use crate::sparse_index::types::ScoredDoc;

/// A search result pairing an item identifier with a relevance score.
///
/// Used as the canonical return type across vector search, sparse search,
/// and hybrid fusion pipelines.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct ScoredResult {
    /// Unique identifier of the matched item.
    pub id: u64,
    /// Relevance score (interpretation depends on metric: higher may be better
    /// for similarity, lower for distance).
    pub score: f32,
}

impl ScoredResult {
    /// Creates a new scored result.
    #[must_use]
    #[inline]
    pub fn new(id: u64, score: f32) -> Self {
        Self { id, score }
    }
}

// --- Tuple conversions ---

impl From<(u64, f32)> for ScoredResult {
    #[inline]
    fn from((id, score): (u64, f32)) -> Self {
        Self { id, score }
    }
}

impl From<ScoredResult> for (u64, f32) {
    #[inline]
    fn from(sr: ScoredResult) -> Self {
        (sr.id, sr.score)
    }
}

// --- ScoredDoc conversions ---

impl From<ScoredDoc> for ScoredResult {
    #[inline]
    fn from(sd: ScoredDoc) -> Self {
        Self {
            id: sd.doc_id,
            score: sd.score,
        }
    }
}

impl From<ScoredResult> for ScoredDoc {
    #[inline]
    fn from(sr: ScoredResult) -> Self {
        Self {
            doc_id: sr.id,
            score: sr.score,
        }
    }
}

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

    #[test]
    fn test_new() {
        let sr = ScoredResult::new(42, 0.95);
        assert_eq!(sr.id, 42);
        assert!((sr.score - 0.95).abs() < f32::EPSILON);
    }

    #[test]
    fn test_from_tuple() {
        let sr: ScoredResult = (10, 0.5).into();
        assert_eq!(sr.id, 10);
        assert!((sr.score - 0.5).abs() < f32::EPSILON);
    }

    #[test]
    fn test_into_tuple() {
        let sr = ScoredResult::new(7, 0.3);
        let (id, score): (u64, f32) = sr.into();
        assert_eq!(id, 7);
        assert!((score - 0.3).abs() < f32::EPSILON);
    }

    #[test]
    fn test_from_scored_doc() {
        let sd = ScoredDoc {
            doc_id: 99,
            score: 1.5,
        };
        let sr: ScoredResult = sd.into();
        assert_eq!(sr.id, 99);
        assert!((sr.score - 1.5).abs() < f32::EPSILON);
    }

    #[test]
    fn test_into_scored_doc() {
        let sr = ScoredResult::new(55, 2.0);
        let sd: ScoredDoc = sr.into();
        assert_eq!(sd.doc_id, 55);
        assert!((sd.score - 2.0).abs() < f32::EPSILON);
    }

    #[test]
    fn test_vec_conversion() {
        let tuples: Vec<(u64, f32)> = vec![(1, 0.1), (2, 0.2), (3, 0.3)];
        let results: Vec<ScoredResult> = tuples.into_iter().map(ScoredResult::from).collect();
        assert_eq!(results.len(), 3);
        assert_eq!(results[0].id, 1);

        let back: Vec<(u64, f32)> = results.into_iter().map(Into::into).collect();
        assert_eq!(back.len(), 3);
        assert_eq!(back[2].0, 3);
    }
}