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
use std::collections::hash_map::DefaultHasher;
use std::fmt;
use std::hash::{Hash, Hasher};
use std::ops::{BitOr, Div};
use log::{debug, info, trace};
use roaring::RoaringTreemap;
use crate::utils::*;
pub struct BloomFilter {
slices: Vec<RoaringTreemap>,
k: u32,
m: u64,
n: u64,
f: f64,
}
impl BloomFilter {
pub fn from_scratch(slices_length: u32, slice_size: u64, target_false_positive_rate: f64) -> BloomFilter {
trace!(target: "BloomFilter", "from_scratch(k = {}, m = {}, f = {}) called",
slices_length, slice_size, target_false_positive_rate);
let slices: Vec<RoaringTreemap> = (0..slices_length).map(|_| {
RoaringTreemap::new()
}).collect();
BloomFilter {
slices,
k: slices_length,
m: slice_size,
n: 0,
f: target_false_positive_rate,
}
}
pub fn new(max_size: u64, target_false_positive: f64) -> BloomFilter {
trace!(target: "BloomFilter", "new(n = {}, f = {}) called", max_size, target_false_positive);
assert_ne!(max_size, 0_u64);
assert!(target_false_positive.lt(&1_f64) && target_false_positive.gt(&0_f64));
let k = calculate_best_k(target_false_positive);
info!(target: "BloomFilter", "the best k is {}", k);
let m = calculate_best_m(max_size);
info!(target: "BloomFilter", "the best m is {}", m);
BloomFilter::from_scratch(k, m, target_false_positive)
}
pub fn add<T>(&mut self, value: &T) -> bool
where T: Hash {
trace!(target: "BloomFilter", "add() called");
self.n = self.n + 1;
(0..self.k).map(|i| {
let key = self.get_hash(value, i) % self.m;
debug!(target: "BloomFilter", "inserting the key: {}", key);
self.slices[i as usize].insert(key)
}).fold(false, |res, is_exist| res.bitor(is_exist))
}
pub fn contains<T>(&mut self, value: &T) -> bool
where T: Hash {
trace!(target: "BloomFilter", "contains() called");
(0..self.k).all(|i| {
let key = self.get_hash(value, i) % self.m;
debug!(target: "BloomFilter", "checking the key: {}", key);
self.slices[i as usize].contains(key)
})
}
fn get_hash<T: Hash>(&self, value: &T, seed: u32) -> u64 {
let mut s = DefaultHasher::new();
value.hash(&mut s);
seed.hash(&mut s);
s.finish()
}
pub fn target_false_positive_rate(&self) -> f64 {
trace!(target: "BloomFilter", "target_false_positive_rate() called");
self.f
}
pub fn current_false_positive_rate(&self) -> f64 {
trace!(target: "BloomFilter", "current_false_positive_rate() called");
self.slices.iter().map(|slice| {
(slice.len() as f64).div(self.m as f64)
}).fold(1_f64, |res, slice_f| res * slice_f)
}
pub fn is_empty(&self) -> bool {
trace!(target: "BloomFilter", "is_empty() called");
self.slices.iter().all(|slice| {
slice.is_empty()
})
}
pub fn is_full(&self) -> bool {
trace!(target: "BloomFilter", "is_full() called");
self.current_false_positive_rate() >= self.target_false_positive_rate()
}
pub fn size(&self) -> u64 {
trace!(target: "BloomFilter", "len() called");
self.n
}
pub fn len(&self) -> u64 {
trace!(target: "BloomFilter", "len() called");
self.slices.iter().map(|slice| slice.len()).sum()
}
}
impl fmt::Display for BloomFilter {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "BloomFilter")
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::env;
fn init() {
env::set_var("RUST_LOG", "trace");
let _ = env_logger::builder().is_test(true).try_init();
}
#[test]
fn simple_int_test() {
init();
let mut bf = BloomFilter::new(100, 0.001_f64);
(0..5).for_each(|i| {
bf.add(&i);
debug!("false positive is {}", bf.current_false_positive_rate());
});
assert!(bf.contains(&2));
assert!(!bf.contains(&5));
}
#[test]
fn multiple_value_test() {
init();
let mut bf = BloomFilter::new(100, 0.001_f64);
(-25..25).for_each(|i| {
bf.add(&i);
});
bf.add(&'*');
bf.add(&"this is a string");
debug!("false positive is {}", bf.current_false_positive_rate());
assert!(bf.contains(&2));
assert!(bf.contains(&5));
}
}