cuckoo_filter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 707afee2fc96bb39d3c1b6e1c9acaf343ca18bba
-  data.tar.gz: 5a9d7af30d472875b0cca4a591dfcc62a8e89a01
+  metadata.gz: 9c147bf11916c1061a594a6c677c78b8c887379f
+  data.tar.gz: 722643649aca8a6fe103d82487c65cc7af8f98b1
 SHA512:
-  metadata.gz: e25982c4ed2dba998b33fc59bdccc9935769ff604b06d4598a716eb6c5564391f992f2a7273e2ddd4523bf2581168f34fb602e9e60ef0dc235a33163c8b4027a
-  data.tar.gz: a32123806cbce6aded4d69a9dfee5207c632e6aaf6b1bb74b0ba3b97e06db447f51631d2215757ea7840b7687a67c4509b43da871ed1b7de6e423bc3514d557b
+  metadata.gz: 0e90957909720a3fdfdedc627c38c7f7f7e6406bc0b332f17c513cc9222aa4880919aebe07ebf1b9c5ebd5eb6a74149eef4fd8ff8509e43b1fa71e14ffb174ec
+  data.tar.gz: e3b80aa3385304c5a2ce8f51e07d7cf60cd20bb3452e72c46e02cc71a68dc2deb0ba205f12d66eba56128c8908469970e0a4b9b556386a239096d70a58604f17

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cuckoo_filter.gemspec
 gemspec
-
-gem 'fnv-hash'

data/README.md

@@ -54,20 +54,38 @@ cf.delete("foo")
 
 ## Frequenty Anticipated Questions
 
-- Q: *Is this useful?*
-  A: Yes, but mainly for academic purposes.
+- Q: *Is this useful?* </br>
+  A: Yes, but have a look at the benchmarks below to see if it satisfies your performance requirements before using it in a real world app.
   
-- Q: *Why not for practical purposes?*
-  A: Because Ruby is not a performance-oriented language. It is made to be expressive, so it lacks a lot of low-level constructs needed to make this implementation fast and efficient enough.
+- Q: *Why did you make this?*</br>
+  A: For fun and education, of course! Although that is not stopping it from having any real world usage!
   
-- Q: *Then why did you make this?*
-  A: For fun and education, of course!
-  
-- Q: *But why Ruby? Why not Go/Rust/Elixir/FooBar*
+- Q: *But why Ruby? Why not Go/Rust/Elixir/FooBar*</br>
   A: Because why not? I like Ruby and I couldn't find a full blown implementation in it.
   
-- Q: *Can I use it in a real project?*
-  A: If it satisfies your criteria, then why not? Let me know if you do!
+- Q: *Can I use it in a real project?*</br>
+  A: If it satisfies your criteria, then why not? Have a look at the benchmarks for performance stats. Let me know if you do!
+  
+## Benchmarks
+
+You can run the benchmark script to see the iterations per second performance of different methods on an initially half full filter.
+
+```
+$ ruby test/benchmark.rb
+
+Setting up for benchmarking...
+Done.
+Warming up --------------------------------------
+# warmup stats -> can be ignored
+
+Calculating -------------------------------------
+Iterations per second - Insertions
+                        214.863M (±47.1%) i/s -      1.214B in   9.859735s
+Iterations per second - Lookups
+                        355.392M (±10.9%) i/s -      3.371B in   9.697599s
+Iterations per second - Deletions
+                        343.890M (± 9.6%) i/s -      3.286B
+```
 
 ## Development
 

data/cuckoo_filter.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "codecov"
+  spec.add_development_dependency "benchmark-ips"
+
+  spec.add_runtime_dependency "fnv-hash"
 end

data/lib/cuckoo_filter/bucket.rb

@@ -19,6 +19,8 @@ module CuckooFilter
     #
     # @return [Boolean] whether the insertion was successful
     def insert(fingerprint)
+      return false unless has_space?
+
       @slots.each do |slot|
         if slot.empty?
           slot.set(fingerprint)

data/lib/cuckoo_filter/cuckoo_filter.rb

@@ -49,6 +49,8 @@ module CuckooFilter
     #
     # @return [Boolean] true if successful insertion, else false
     def insert(item)
+      return false unless has_space?
+
       fingerprint = fingerprint(item)
       first_index = hash(item)
       second_index = alt_index(first_index, fingerprint)
@@ -99,12 +101,12 @@ module CuckooFilter
       first_index = hash(item)
       second_index = alt_index(first_index, fingerprint)
 
-      if @buckets[first_index].remove(fingerprint) ||  @buckets[second_index].remove(fingerprint)
+      if @buckets[first_index].remove(fingerprint) || @buckets[second_index].remove(fingerprint)
         decrement_filled_count
         return true
       end
 
-      return false
+      false
     end
 
     private
@@ -142,5 +144,9 @@ module CuckooFilter
     def size_mask
       ((1 << Math.log2(@num_buckets).to_i) - 1)
     end
+
+    def has_space?
+      @filled < @size
+    end
   end
 end

data/lib/cuckoo_filter/version.rb

@@ -1,3 +1,3 @@
 module CuckooFilter
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuckoo_filter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pawan Dubey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fnv-hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - hi@pawandubey.com