woadwarrior / bloom
Simple sha256 hash based counting bloom filter implementations in Python and Javascript. Filters built with the python module can be serialized to JSON and loaded from the javascript implementation.
Clone this repository (size: 19.7 KB): HTTPS / SSH
$ hg clone http://bitbucket.org/woadwarrior/bloom/
| commit 5: | 2846ae8a905e |
| parent 4: | b944715fe4b2 |
| branch: | default |
| tags: | tip |
Fixed 2 minor docstring typos, added the MIT License.
bloom /
bloom.py
| r5:2846ae8a905e | 245 loc | 6.9 KB | embed / history / annotate / raw / |
|---|
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 | # -*- coding: utf-8 -*-
'''
A simple counting bloom filter implementation using the SHA256 hash function.
-- Jeethu Rao <jeethu@jeethurao.com>
'''
import array
import hashlib
import os
import itertools
import math
from string import hexdigits
import simplejson
class BloomFilter( object ) :
HASH_ALGO = 'sha256'
DIGEST_SIZE = hashlib.new(HASH_ALGO).digest_size
M = 16384
K = 8
def __init__( self, m=None, k=None, ivs=None, value=None ) :
if m is not None :
self.M = m
if k is not None :
self.K = k
if value is not None :
self._filter = array.array('B',value)
l = len(self._filter)
if l < self.M :
self._filter.extend(itertools.repeat(0,self.M-l))
else :
self._filter = array.array('B',itertools.repeat(0,self.M))
self.calc_nbytes()
if ivs is None :
self.ivs = [os.urandom(16) for x in
range((self.n_bytes*self.K/self.DIGEST_SIZE)-1)]
self.ivs.insert(0,'')
else :
self.ivs = ivs
def calc_nbytes( self ) :
n_bits = int(math.floor(math.log(self.M,2)))
self.n_bytes = int(math.ceil(n_bits/8.0))
def __eq__( self, other ) :
if self.K == other.K :
if self.M == other.M :
if self._filter == other._filter :
return True
return False
def __ne__( self, other ) :
return not (self == other)
def __setstate__( self, d ) :
self.M = d['m']
self.K = d['k']
self._filter = array.array('B',d['filter'])
self.calc_nbytes()
self.ivs = d['ivs']
def __getstate__( self ) :
return {
'm' : self.M,
'k' : self.K,
'filter' : self._filter.tolist(),
'ivs' : self.ivs,
}
def hash( self, d ) :
h_l,l = [], []
for iv in self.ivs :
h = hashlib.new(self.HASH_ALGO,iv)
h.update(d)
h_l.append(h.digest())
hashes = ''.join(h_l)
pos = 0
for x in range(self.K) :
v = 0
for n,x in enumerate(hashes[pos:pos+self.n_bytes]) :
v += ord(x) << (n*8)
l.append(v%self.M)
pos += self.n_bytes
return l
def full( self ) :
return sum(bool(x) for x in self._filter) == self.M
def empty( self ) :
return sum(bool(x) for x in self._filter) == 0
def __nonzero__( self ) :
return not self.empty()
def add( self, value ) :
hash = self.hash(value)
if all(self._filter[x] for x in hash) :
return
for x in hash :
self._filter[x] += 1
if self._filter[x] == 0 : # Prevent overflow
self._filter[x] -= 1
def _remove( self, value, hash, cnt=0 ) :
for x in hash :
if self._filter[x] :
self._filter[x] -= 1
# Check if the value is still present
if cnt > 5 :
raise RuntimeError, "Can't remove the element from this filter"
if all(self._filter[x] for x in hash) :
return self._remove( value, hash, cnt+1 )
return True
def remove( self, value ) :
hash = self.hash(value)
return self._remove( value, hash )
def __contains__( self, value ) :
return all(self._filter[x] for x in self.hash(value))
def serialize( self ) :
d = {
'm' : self.M,
'k' : self.K,
}
min_val = min(self._filter)
cfilter = [x-min_val for x in self._filter.tolist()]
if any(cfilter) :
d['filter'] = cfilter
if min_val :
d['min_val'] = min_val
if any(self.ivs) :
d['ivs'] = self.ivs
return d
@classmethod
def unserialize( cls, d ) :
min_val = d.get('min_val',0)
filter = [x+min_val for x in d.get('filter',[])]
if not filter :
filter = None
ivs = d.get('ivs',[''])
return cls( d['m'],d['k'],ivs,filter )
def toJSON( self ) :
return simplejson.dumps(self.serialize())
@classmethod
def fromJSON( cls, s ) :
d = simplejson.loads(s)
return cls.unserialize( d )
HEX_MAP = list('0123456789ABCDEF')
REVERSE_HEX_MAP = dict(zip(HEX_MAP,range(16)))
def _rle( s ) :
'''
Simple RLE to encode on wire data
If the run length is less than 11 chars,
its rather more efficient to use the string.
'''
for k, g in itertools.groupby(s) :
l = len(list(g))
if l < 11 :
yield k*l
else :
yield [k,l]
def rle( s ) :
it = itertools.groupby(_rle(s), lambda x : isinstance(x, (str,unicode)))
for k,g in it :
if k is False :
for x in g :
yield x
else :
yield ''.join(g)
def unrle( l ) :
'''
Undo the RLE
'''
o_l = []
for x in l :
if isinstance(x,list) :
o_l.append(x[0]*x[1])
else :
o_l.append(x)
return ''.join(o_l)
class SimpleBloomFilter(BloomFilter) :
def __init__( self, capacity=100, err=0.1, ivs=None, value=None ) :
'''
@capacity: The capacity of the filter
@err: The tolerable false positives rate ( 0 < err < 0.5 )
'''
m, k = self.calc_mk( capacity, err )
BloomFilter.__init__( self, m, k, ivs, value )
@staticmethod
def calc_mk( capacity, err ) :
m = int(math.ceil(capacity * math.log(err) / math.log(1.0 / 2**math.log(2))))
k = int(math.floor(math.log(2) * m / capacity))
return m, k
def serialize( self ) :
d = BloomFilter.serialize( self )
cfilter = d.get('filter',[])
if cfilter :
max_value = max(cfilter)
if max_value < 16 :
filter = ''.join([HEX_MAP[x] for x in cfilter])
else : # Its a byte value
l = []
for x in cfilter :
l.append(HEX_MAP[x>>4])
l.append(HEX_MAP[x&0x0F])
filter = ''.join(l)
d['filter'] = list(rle(filter))
return d
@classmethod
def unserialize( cls, d ) :
filter = unrle(d.get('filter',[]))
f_l = len(filter)
m = d['m']
if f_l == 0 :
cfilter = []
elif f_l == m :
cfilter = [REVERSE_HEX_MAP[x] for x in filter]
elif f_l == (m << 1) :
state = 0
v = 0
cfilter = []
for x in filter :
if state == 0 :
v = REVERSE_HEX_MAP[x] << 4
else :
v += REVERSE_HEX_MAP[x]
cfilter.append(v)
state = (state + 1) & 1
else :
RuntimeError, "Inconsistent filter length %d for m: %d"%(f_l,m)
d['filter'] = cfilter
return BloomFilter.unserialize( d )
|
