vectune 0.1.1

A lightweight VectorDB with Incremental Indexing, based on FreshVamana.
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

/// Traits that the Point type should implement for use by vectune::Builder.
///
/// # Examples
///
/// ```ignore
/// #[derive(Serialize, Deserialize, Clone, Debug)]
/// struct Point(Vec<f32>);
/// impl PointInterface for Point {
///     ...
/// }
/// ```
pub trait PointInterface: Clone + Sync {
  /// A function that returns the distance between two Points. Typically, the Euclidean distance is used.
  ///
  /// # Examples
  ///
  /// ```ignore
  /// fn distance(&self, other: &Self) -> f32 {
  ///     self.0
  ///         .iter()
  ///         .zip(other.0.iter())
  ///         .map(|(a, b)| {
  ///             let c = a - b;
  ///             c * c
  ///         })
  ///         .sum::<f32>()
  ///         .sqrt()
  /// }
  /// ```
  fn distance(&self, other: &Self) -> f32;

  /// The number of dimensions of a vector.
  fn dim() -> u32;

  /// Addition of two Points. Used by Builder to find the centroid.
  ///
  ///　# Examples
  ///
  /// ```ignore
  /// fn add(&self, other: &Self) -> Self {
  ///     Point::from_f32_vec(
  ///         self.to_f32_vec()
  ///             .into_iter()
  ///             .zip(other.to_f32_vec().into_iter())
  ///             .map(|(x, y)| x + y)
  ///             .collect(),
  ///     )
  /// }
  /// ```
  fn add(&self, other: &Self) -> Self;

  /// Division of a Point. Used by Builder to find the centroid.
  ///
  ///　# Examples
  ///
  /// ```ignore
  /// fn div(&self, divisor: &usize) -> Self {
  ///     Point::from_f32_vec(
  ///         self.to_f32_vec()
  ///             .into_iter()
  ///             .map(|v| v / *divisor as f32)
  ///             .collect(),
  ///     )
  /// }
  /// ```
  fn div(&self, divisor: &usize) -> Self;
}


/// Traits that should be implemented for searching, inserting, and deleting after indexing.
///
/// # Exapmles
///
/// ```ignore
/// 
/// struct Graph<P>
/// where
///     P: VPoint,
/// {
///     nodes: Vec<(P, Vec<u32>)>,
///     backlinks: Vec<Vec<u32>>,
///     cemetery: Vec<u32>,
///     centroid: u32,
/// }
/// 
/// impl<P> VGraph<P> for Graph<P>
/// where
///     P: VPoint,
/// {
///     fn alloc(&mut self, point: P) -> u32 {
///         self.nodes.push((point, vec![]));
///         self.backlinks.push(vec![]);
///         (self.nodes.len() - 1) as u32
///     }
/// 
///     fn free(&mut self, _id: &u32) {
///         // todo!()
///     }
/// 
///     fn cemetery(&self) -> Vec<u32> {
///         self.cemetery.clone()
///     }
/// 
///     fn clear_cemetery(&mut self) {
///         self.cemetery = Vec::new();
///     }
/// 
///     fn backlink(&self, id: &u32) -> Vec<u32> {
///         self.backlinks[*id as usize].clone()
///     }
/// 
///     fn get(&mut self, id: &u32) -> (P, Vec<u32>) {
///         let node = &self.nodes[*id as usize];
///         node.clone()
///     }
/// 
///     fn size_l(&self) -> usize {
///         125
///     }
/// 
///     fn size_r(&self) -> usize {
///         70
///     }
/// 
///     fn size_a(&self) -> f32 {
///         2.0
///     }
/// 
///     fn start_id(&self) -> u32 {
///         self.centroid
///     }
/// 
///     fn overwirte_out_edges(&mut self, id: &u32, edges: Vec<u32>) {
///         for out_i in &self.nodes[*id as usize].1 {
///             let backlinks = &mut self.backlink(out_i);
///             backlinks.retain(|out_i| out_i != id)
///         }
/// 
///         for out_i in &edges {
///             let backlinks = &mut self.backlink(out_i);
///             backlinks.push(*id);
///             backlinks.sort();
///             backlinks.dedup();
///         }
/// 
///         self.nodes[*id as usize].1 = edges;
///     }
/// }
/// ```
pub trait GraphInterface<P> {
  fn alloc(&mut self, point: P) -> u32;
  fn free(&mut self, id: &u32);
  fn cemetery(&self) -> Vec<u32>;
  fn clear_cemetery(&mut self);
  fn backlink(&self, id: &u32) -> Vec<u32>;
  fn get(&mut self, id: &u32) -> (P, Vec<u32>);
  fn size_l(&self) -> usize;
  fn size_r(&self) -> usize;
  fn size_a(&self) -> f32;
  fn start_id(&self) -> u32;
  fn overwirte_out_edges(&mut self, id: &u32, edges: Vec<u32>); // backlinkを処理する必要がある。
}