granne 0.5.2

Graph-based Retrieval of Approximate Nearest Neighbors
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
use super::{CompressedVariableWidthSliceVector, FixedWidthSliceVector, VariableWidthSliceVector};
use crate::io::write_as_bytes;
use std::convert::TryFrom;
use std::io::{Read, Result, Seek, SeekFrom, Write};
use stream_vbyte::{decode, encode, Scalar};

#[derive(Clone)]
pub struct MultiSetVector<'a> {
    data: CompressedVariableWidthSliceVector<'a, u8>,
}

const MIN_NUMBERS_TO_ENCODE: usize = 4;

impl<'a> MultiSetVector<'a> {
    pub fn new() -> Self {
        Self {
            data: CompressedVariableWidthSliceVector::new(),
        }
    }

    pub unsafe fn from_file(file: &std::fs::File) -> std::io::Result<Self> {
        Ok(Self {
            data: CompressedVariableWidthSliceVector::from_file(file)?,
        })
    }

    pub fn from_bytes(buffer: &'a [u8]) -> Self {
        Self {
            data: CompressedVariableWidthSliceVector::from_bytes(buffer),
        }
    }

    pub fn len(self: &Self) -> usize {
        self.data.len()
    }

    pub fn is_empty(self: &Self) -> bool {
        self.len() == 0
    }

    pub fn push(self: &mut Self, data: &[u32]) {
        let mut data = data.to_vec();

        data.sort();

        self.push_sorted(data);
    }

    pub fn push_sorted(self: &mut Self, data: Vec<u32>) {
        self.data.push(&set_encode(data));
    }
    /*
        pub fn extend_from_multi_set_vector(self: &mut Self, other: &Self) {
            self.data.extend_from_slice_vector(&other.data);
        }
    */
    pub fn get(self: &Self, idx: usize) -> Vec<u32> {
        let mut decoded_nums = Vec::new();

        self.get_into(idx, &mut decoded_nums);

        decoded_nums
    }

    pub fn get_into(self: &Self, idx: usize, res: &mut Vec<u32>) {
        let encoded_data = self.data.get(idx);

        decode_into(&encoded_data, res);
    }

    pub fn write<B: Write>(self: &Self, buffer: &mut B) -> Result<usize> {
        self.data.write(buffer)
    }

    pub fn borrow<'b>(self: &'a Self) -> MultiSetVector<'b>
    where
        'a: 'b,
    {
        Self {
            data: self.data.borrow(),
        }
    }

    pub fn into_owned(self: Self) -> MultiSetVector<'static> {
        MultiSetVector {
            data: self.data.into_owned(),
        }
    }
}

fn decode_into(encoded_data: &[u8], decoded_nums: &mut Vec<u32>) {
    let count = encoded_data[0] as usize;
    decoded_nums.clear();
    let encoded_data = &encoded_data[1..];

    if encoded_data.len() != count * ::std::mem::size_of::<u32>() {
        decoded_nums.resize(std::cmp::max(MIN_NUMBERS_TO_ENCODE, count), 0);

        //let bytes_decoded = decode::<stream_vbyte::x86::Ssse3>(encoded_data, decoded_nums.len(),
        // decoded_nums);
        let bytes_decoded = decode::<Scalar>(encoded_data, decoded_nums.len(), decoded_nums);

        debug_assert_eq!(encoded_data.len(), bytes_decoded);

        decoded_nums.resize(count, 0);
    } else {
        let mut buf = [0x0; ::std::mem::size_of::<u32>()];
        for num in encoded_data.chunks_exact(::std::mem::size_of::<u32>()).take(count) {
            buf.copy_from_slice(num);
            decoded_nums.push(u32::from_le_bytes(buf));
        }
    }

    delta_decode(decoded_nums);
}

fn set_encode(mut data: Vec<u32>) -> Vec<u8> {
    debug_assert!(data.len() < u8::max_value() as usize);
    if data.len() >= u8::max_value() as usize {
        data.resize(u8::max_value() as usize, 0)
    }

    delta_encode(&mut data);
    let count = data.len();

    if data.len() < MIN_NUMBERS_TO_ENCODE {
        data.resize(MIN_NUMBERS_TO_ENCODE, 0);
    }

    let mut encoded_data = Vec::new();
    const MAX_REQUIRED_SIZE_PER_NUM: usize = 5;
    encoded_data.resize(MAX_REQUIRED_SIZE_PER_NUM * data.len(), 0x0);

    let encoded_len = encode::<Scalar>(data.as_slice(), encoded_data.as_mut_slice());
    encoded_data.resize(encoded_len, 0x0);

    // only use compression if it makes the data smaller
    if encoded_data.len() >= ::std::mem::size_of::<u32>() * count {
        encoded_data.clear();
        for d in data.iter().take(count) {
            encoded_data.extend_from_slice(&d.to_le_bytes());
        }
    }

    encoded_data.insert(0, count as u8);

    encoded_data
}

#[inline(always)]
fn delta_encode(data: &mut [u32]) {
    for i in (1..data.len()).rev() {
        data[i] -= data[i - 1];
    }
}

#[inline(always)]
fn delta_decode(data: &mut [u32]) {
    for i in 1..data.len() {
        data[i] += data[i - 1];
    }
}

impl<'a, T: 'a + Clone> FixedWidthSliceVector<'a, T>
where
    u32: TryFrom<T>,
    <u32 as std::convert::TryFrom<T>>::Error: std::fmt::Debug,
{
    pub fn write_as_multi_set_vector<B, P>(self: &Self, buffer: &mut B, mut predicate: P) -> Result<usize>
    where
        B: Write + Seek,
        P: FnMut(&T) -> bool,
    {
        let initial_pos = buffer.seek(SeekFrom::Current(0))?;

        let bytes_for_offsets =
            (1 + self.len() / super::offsets::OFFSETS_PER_CHUNK) * ::std::mem::size_of::<super::offsets::Chunk>();

        buffer.write_all(&(bytes_for_offsets as u64).to_le_bytes())?;

        let mut offset_pos = buffer.seek(SeekFrom::Current(0))?;
        let mut offsets = super::Offsets::new();
        offsets.push(0);

        // write values
        buffer.seek(SeekFrom::Start(offset_pos + bytes_for_offsets as u64))?;
        let mut slice_buffer: Vec<u32> = Vec::new();
        let mut total_len: usize = 0;
        if !self.is_empty() {
            for slice in self.iter() {
                slice_buffer.clear();
                for val in slice {
                    if predicate(val) {
                        slice_buffer.push(u32::try_from(val.clone()).unwrap());
                    }
                }

                slice_buffer.sort();

                let encoded = set_encode(slice_buffer.clone());
                write_as_bytes(encoded.as_slice(), buffer)?;

                total_len += encoded.len();
                offsets.push(total_len);
            }
        }

        let value_pos = buffer.seek(SeekFrom::Current(0))?;

        // write offsets
        buffer.seek(SeekFrom::Start(offset_pos))?;
        let offsets_bytes_written = offsets.write(buffer)?;

        assert_eq!(offsets_bytes_written, bytes_for_offsets);

        buffer.seek(SeekFrom::Start(value_pos))?;

        let bytes_written = (value_pos - initial_pos) as usize;

        Ok(bytes_written)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs::File;
    use tempfile;

    #[test]
    fn test_delta_encode() {
        let mut data = vec![1, 2, 2, 4];

        delta_encode(&mut data);

        assert_eq!(vec![1, 1, 0, 2], data);
    }

    #[test]
    fn delta_encode_decode() {
        let data = vec![123, 345, 555, 555, 6999, 7000];
        let mut code = data.clone();

        delta_encode(&mut code);
        delta_decode(&mut code);

        assert_eq!(data, code);
    }

    #[test]
    fn push_and_get() {
        let mut vec = MultiSetVector::new();

        let slice: Vec<u32> = (0..10).collect();

        vec.push(&slice);

        assert_eq!(1, vec.len());
        assert_eq!(slice, vec.get(0));
    }

    #[test]
    fn push_and_get_empty() {
        let mut vec = MultiSetVector::new();

        vec.push(&[]);

        assert_eq!(1, vec.len());
        assert_eq!(Vec::<u32>::new(), vec.get(0));
    }

    #[test]
    // this tests the case where the size of the encoded data has the same size as the original (2 *
    // 4 bytes)
    fn push_and_get_4_bytes_per_number() {
        let mut vec = MultiSetVector::new();

        let exp = vec![37717, 660380];
        vec.push(&exp);

        assert_eq!(1, vec.len());
        assert_eq!(exp, vec.get(0));
    }

    #[test]
    fn push_and_get_one() {
        let mut vec = MultiSetVector::new();

        vec.push(&[5]);

        assert_eq!(1, vec.len());
        assert_eq!(vec![5], vec.get(0));
    }

    #[test]
    fn push_and_get_duplicates() {
        let mut vec = MultiSetVector::new();

        vec.push(&[5, 5]);

        assert_eq!(1, vec.len());
        assert_eq!(vec![5, 5], vec.get(0));
    }

    #[test]
    fn push_multiple_and_get() {
        let mut vec = MultiSetVector::new();

        for i in 0..20 {
            let slice: Vec<u32> = (i..20).collect();

            vec.push(&slice);

            assert_eq!((i + 1) as usize, vec.len());
            assert_eq!(slice, vec.get(i as usize));
        }
    }

    #[test]
    fn push_unsorted() {
        let mut vec = MultiSetVector::new();

        for i in 0..20 {
            let mut slice: Vec<u32> = (i..20).map(|i| (7 * i) % 15).collect();

            vec.push(&slice);
            slice.sort();

            assert_eq!((i + 1) as usize, vec.len());
            assert_eq!(slice, vec.get(i as usize));
        }
    }

    #[test]
    fn write_fixed_width_vector_as_multi_set_vector() {
        let width = 7;
        let mut vec = FixedWidthSliceVector::new();
        for i in 0..120 {
            let data: Vec<u32> = (2 * i + 3..).take(width).collect();
            vec.push(&data);
        }

        let mut file: File = tempfile::tempfile().unwrap();
        let bytes_written = vec.write_as_multi_set_vector(&mut file, |_| true).unwrap();

        file.seek(SeekFrom::Start(0)).unwrap();

        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer).unwrap();

        let loaded_vec = MultiSetVector::from_bytes(&buffer);

        assert_eq!(vec.len(), loaded_vec.len());

        for i in 0..vec.len() {
            assert_eq!(vec.get(i), loaded_vec.get(i).as_slice());
        }
    }

    #[test]
    fn write_fixed_width_vector_as_multi_set_vector_predicate() {
        let width = 7;
        let mut vec = FixedWidthSliceVector::new();
        for i in 0..522 {
            let data: Vec<u32> = (2 * i + 3..).take(width).collect();
            vec.push(&data);
        }

        let mut file: File = tempfile::tempfile().unwrap();
        vec.write_as_multi_set_vector(&mut file, |x| x % 3 == 0).unwrap();
        file.seek(SeekFrom::Start(0)).unwrap();

        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer).unwrap();

        let loaded_vec = MultiSetVector::from_bytes(&buffer);

        assert_eq!(vec.len(), loaded_vec.len());

        for i in 0..vec.len() {
            let vec_slice: Vec<_> = vec.get(i).iter().filter(|&x| x % 3 == 0).map(|x| *x).collect();
            assert_eq!(vec_slice, loaded_vec.get(i));
        }
    }

    #[test]
    fn write_fixed_width_vector_as_multi_set_vector_empty() {
        let vec = FixedWidthSliceVector::<u16>::new();

        let mut file: File = tempfile::tempfile().unwrap();
        vec.write_as_multi_set_vector(&mut file, |_| true).unwrap();
        file.seek(SeekFrom::Start(0)).unwrap();

        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer).unwrap();

        let loaded_vec = MultiSetVector::from_bytes(&buffer);

        assert_eq!(0, loaded_vec.len());
    }

    #[test]
    fn write_fixed_width_vector_as_multi_set_vector_empty_slices() {
        let width = 1;
        let mut vec = FixedWidthSliceVector::<u32>::new();

        for _ in 0..1000 {
            vec.push(&[0]);
        }

        let mut file: File = tempfile::tempfile().unwrap();
        vec.write_as_multi_set_vector(&mut file, |&x| x > 0).unwrap();
        file.seek(SeekFrom::Start(0)).unwrap();

        let mut buffer = Vec::new();
        file.read_to_end(&mut buffer).unwrap();

        let loaded_vec = MultiSetVector::from_bytes(&buffer);

        assert_eq!(vec.len(), loaded_vec.len());

        for i in 0..loaded_vec.len() {
            assert!(loaded_vec.get(i).is_empty());
        }
    }
}