Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
srinivasreddy committed Nov 10, 2020
1 parent 41d939e commit 4b87be1
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 26 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "rust-bloomfilter"
version = "0.0.4"
version = "1.0.0-beta"
authors = ["Srinivas Reddy Thatiparthy <[email protected]>"]
edition = "2018"
license = "MIT"
Expand Down
22 changes: 1 addition & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,4 @@ let mut b = BloomFilter(20000, 0.01, true);
b.add("Helloworld");
assert!(b.contains("Helloworld"));

````
## TODO

1.Adding a constructor for creating a bloomfilter from a BitVec and a number of hash functions
(so the user can choose how they want to initialize the bloomfilter).If you do that and you
allow the user to access the bitvec,than they can serialize/deserialize the bloomfilter.
This way they can create persistent bloomfilters.

2.Consider at least rounding up to whole bytes, as those bits are just wasted otherwise.
But in most circumstances it makes sense to round up to a whole cache line (64 bytes for Intel CPUs).
Rounding up to some sane number of bits lowers your false positive rate and won't increase
the cache footprint of the bloomfilter.

## Benchmarks
TODO

## Performance

TODO
## Compliance with the probability of false positives
TODO
````
4 changes: 0 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ pub struct BloomFilter {
dup_check: bool,
}

// Counting Bloomfilter gives the opportunity to check certain
// elements crossed a certain threshold.
// pub type CountingBloomFilter = BloomFilter;

// The number of bits for the bloom filter is given by the following formula
// m = math.ceil((n * math.log(p)) / math.log(1.0 / (pow(2.0, math.log(2.0)))))
#[inline(always)]
Expand Down

0 comments on commit 4b87be1

Please sign in to comment.