Xorfilter 0.1.3

No alloc membership approximation
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

<h4 align="center">Statically allocated membership approximation.</h4> 

# Xorfilter

A `no_std`, no alloc crate for membership approximation.

## Quick Start 

#### 0.1.0
```rust

const N: usize = 100000;
let mut keys = [0; N];

for i in 0..N {
    keys[i] = splitmix64(i as u64);
}

let x: XorFilter<u8, N> = XorFilter::new(keys);

for i in 0..N {
    x.contains(keys[i]);
}

```
## Status

No Docs    
    - Blocking on `const_evaluatable_checked`  
No serialization  
    - Blocking on Serde 

## Why Xorfilter

[Xorf](https://crates.io/crates/xorf) needs `alloc` for `Vec`, which is
limiting in various `no_std` environments.

## Limitations

Xor Filters are not designed to work with duplicate values. [1]

Xorfilters could benefit from some features in const generics that are not yet in nightly. We did not want to wait for const generic xor filters, so that is the reason behind why there are some uses of `const fn` and `Sized`. 

## Reference

[1] [Xor Filters: Faster and Smaller Than Bloom and Cuckoo
Filters](https://arxiv.org/abs/1912.08258), Journal of Experimental
Algorithmics.