feox-ann 0.1.0

Dependency-free HNSW approximate nearest neighbor index with deterministic, reproducible builds
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

#[derive(Debug, Clone)]
pub struct AnnConfig {
    pub dimensions: usize,
    pub max_neighbors: usize,
    pub max_base_neighbors: usize,
    pub ef_construction: usize,
    pub ef_search: usize,
    pub max_level: usize,
}

impl AnnConfig {
    pub fn for_dimensions(dimensions: usize) -> Self {
        Self {
            dimensions,
            max_neighbors: 24,
            max_base_neighbors: 24,
            ef_construction: 160,
            ef_search: 64,
            max_level: 16,
        }
    }
}

#[derive(Clone, Copy)]
pub struct AnnQuery<'a> {
    pub vector: &'a [f32],
    pub top_k: usize,
    pub ef_search: Option<usize>,
    pub filter: Option<&'a dyn AnnFilter>,
}

#[derive(Debug, Clone, PartialEq)]
pub struct AnnCandidate {
    pub id: String,
    pub score: f32,
}

pub trait AnnFilter {
    fn accept(&self, id: &str) -> bool;
}

impl<F> AnnFilter for F
where
    F: Fn(&str) -> bool,
{
    fn accept(&self, id: &str) -> bool {
        self(id)
    }
}

#[derive(Debug, thiserror::Error)]
pub enum AnnError {
    #[error("invalid ANN config: {0}")]
    InvalidConfig(String),
    #[error("invalid ANN vector: {0}")]
    InvalidVector(String),
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),
    #[error("corrupted index snapshot: {0}")]
    Corrupted(String),
}