seabloom 0.1.0

Yet Another Bloom Filter, this one using seahash
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

#![cfg(test)]

pub use super::Seabloom;

#[test]
fn new_size()
{
	// constructs a filter of the requested size
	let mut seeds: Vec<u64> = Vec::new();
	seeds.push(1);
	seeds.push(2);
	seeds.push(3);
	seeds.push(4);

	let bloom = Seabloom::new(32, seeds);
	assert_eq!(bloom.bitcount, 32);
	assert_eq!(bloom.seeds.len(), 4);
	assert_eq!(bloom.bitfield.len(), 1);
}

#[test]
fn test_create_with_hash_count()
{
	// constructs a filter with 4x the requested hash seed count
	let bloom = Seabloom::create_random_seeds(32, 3);
	assert_eq!(bloom.seeds.len(), 12);
}

#[test]
fn new_zeros()
{
	// zeros out its storage buffer
	let seeds: Vec<u64> = Vec::new();
	let bloom = Seabloom::new(128, seeds);

	for i in 0..bloom.bitfield.len()
	{
		assert_eq!(bloom.bitfield[i], 0);
	}
}

#[test]
fn create_defaults()
{
	let filter = Seabloom::create(95);
	assert_eq!(filter.bitcount, 1048);
	assert_eq!(filter.seeds.len(), 32);

	let f1 = Seabloom::create(148);
	assert_eq!(f1.bitcount, 1632);
	assert_eq!(f1.seeds.len(), 32);

	let f2 = Seabloom::create(10);
	assert_eq!(f2.bitcount, 110);
	assert_eq!(f2.seeds.len(), 32);
}

#[test]
fn create_optimal_error_rate()
{
	let filter = Seabloom::create(20000);
	assert_eq!(filter.bitcount, 220555);

	let f2 = Seabloom::create_optimal(20000, 0.2);
	assert_eq!(f2.bitcount < filter.bitcount, true);
}

#[test]
fn setbit_getbit()
{
	let mut filter = Seabloom::create_random_seeds(32, 4);

	filter.setbit(0);
	assert_eq!(filter.getbit(0), true);

	assert_eq!(filter.getbit(1), false);
	filter.setbit(1);
	assert_eq!(filter.getbit(1), true);

	assert_eq!(filter.getbit(2), false);

	assert_eq!(filter.getbit(17), false);
	filter.setbit(17);
	assert_eq!(filter.getbit(17), true);
}

#[test]
fn set_all_bits()
{
	let mut filter = Seabloom::create_random_seeds(64, 3);
	assert_eq!(filter.bitfield.len(), 2);

	for i in 0..64 { filter.setbit(i); }

	assert_eq!(filter.bitfield[0], u32::max_value());
	assert_eq!(filter.bitfield[1], u32::max_value());
}

#[test]
fn set_slice_shift()
{
	let mut filter = Seabloom::create_random_seeds(128, 3);

	filter.setbit(32);
	assert_eq!(filter.bitfield[1], 1);

	filter.setbit(65);
	assert_eq!(filter.bitfield[2], 2);
}

#[test]
fn add_bytes()
{
	let bytes = "cat".as_bytes();
	let mut filter = Seabloom::create_random_seeds(128, 3);
	assert_eq!(filter.has_bytes(bytes), false);
	filter.add_bytes(bytes);
	assert_eq!(filter.has_bytes(bytes), true);
}

#[test]
fn add()
{
	let mut filter = Seabloom::create_random_seeds(128, 3);
	assert_eq!(filter.has("cat"), false);
	filter.add("cat");
	assert_eq!(filter.has("cat"), true);
}

#[test]
fn add_list()
{
	let mut filter = Seabloom::create_random_seeds(128, 3);
	let vec = vec!["cat", "dog", "wallaby"];
	filter.add_list(vec);

	assert_eq!(filter.has("cat"), true);
	assert_eq!(filter.has("dog"), true);
	assert_eq!(filter.has("wallaby"), true);
	assert_eq!(filter.has("orange"), false);
}

#[test]
fn clear()
{
	let mut filter = Seabloom::create_random_seeds(128, 3);
	let vec = vec!["cat", "dog", "wallaby"];
	filter.add_list(vec);
	assert_eq!(filter.has("cat"), true);
	filter.clear();
	assert_eq!(filter.has("cat"), false);
}

#[test]
fn example()
{
	let mut filter = Seabloom::create(2000);

	assert_eq!(filter.has("cat"), false);
	filter.add("cat");
	assert_eq!(filter.has("cat"), true);

	filter.add_list(vec!["cat", "jaguar", "lion", "tiger", "leopard"]);
	assert_eq!(filter.has("caracal"), false);
	assert_eq!(filter.has("jaguar"), true);

	filter.clear();
	assert_eq!(filter.has("cat"), false);

}