weavatrix-search-vector 0.3.1

Persistent, mutable, bounded vector candidate search for Rust and Weavatrix
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

mod batch;
mod graph_build;
mod graph_helpers;
mod graph_insert;
mod graph_search;
mod index_build;
mod index_search;
mod policy;
mod routing;
mod scratch;

use crate::config::IndexConfig;
use crate::vector::{Candidate, RoutingCandidate, VectorStore};
use std::cmp::Reverse;
use std::collections::BinaryHeap;
use std::sync::Arc;

pub use policy::{FilterSearchPolicy, SearchPolicy};

pub(super) const MAX_LEVEL: usize = 32;

/// Immutable deterministic HNSW candidate index.
#[derive(Debug)]
pub struct VectorIndex {
    pub(super) config: IndexConfig,
    pub(super) vectors: Arc<VectorStore>,
    pub(super) graphs: Vec<Graph>,
    pub(super) routing: RoutingIndex,
}

#[derive(Debug)]
pub(crate) struct RoutingIndex {
    pub(crate) entries: Vec<(u16, u32)>,
}

#[derive(Debug)]
pub(crate) struct NodeLinks {
    pub(crate) layers: Vec<Vec<u32>>,
}

#[derive(Debug)]
pub(crate) struct Graph {
    pub(crate) entry: Option<usize>,
    pub(crate) max_level: usize,
    pub(crate) nodes: Vec<NodeLinks>,
}

pub(super) struct InsertionPlan {
    pub(super) index: usize,
    pub(super) level: usize,
    pub(super) links: Vec<(usize, Vec<usize>)>,
}

pub(super) struct SearchScratch {
    pub(super) marks: Vec<u32>,
    pub(super) generation: u32,
    pub(super) candidates: BinaryHeap<Reverse<Candidate>>,
    pub(super) results: BinaryHeap<Candidate>,
    pub(super) routing_probes: Vec<u16>,
    pub(super) routing_probe_heap: BinaryHeap<Reverse<RoutingCandidate>>,
    pub(super) routing_nodes: Vec<u32>,
    pub(super) merged: Vec<Candidate>,
}