pgm-rs 0.1.0

A PGM index implementation for sorted u64 keys
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

## PGM-RS
---

A implementation of the PGM based u64 key indexes described in https://pgm.di.unipi.it/docs/cpp-reference/ in rust with zero copy serialization support. Currently only little endian architectures are supported.

## Examples


#### Standard Copy Version 
```
// Build index from sorted list of u64
let keys: Vec<u64> = (0..10000).step_by(7).collect();
let pgm = PGMIndex::build(&keys, 64).unwrap();

// Serialize index to bytes 
let bytes = pgm.to_bytes().expect("serialize failed");

// Deserialize index from bytes to 
let restored = PGMIndex::from_bytes(&bytes).expect("full deserialize failed");

let key = 9876;
let (lo, hi) = restored.search(key);

// Search original list for index ranges the value may be contained in. 
let found = keys[lo..=hi].binary_search(&key).ok();
```


#### Zero Copy Version 
```
// Build index from sorted list of u64
let keys: Vec<u64> = (0..10000).step_by(7).collect();
let pgm = PGMIndex::build(&keys, 64).unwrap();

// Serialize index to bytes 
let bytes = pgm.to_bytes().expect("serialize failed");

let archived = PGMIndex::as_archived(&bytes).expect("zero-copy deserialize failed");
let key = 1000;
let (lo, hi) = archived.search(key);

let key = 9876;
let (lo, hi) = restored.search(key);

// Search original list for index ranges the value may be contained in. 
let found = keys[lo..=hi].binary_search(&key).ok();
```