cuckoo_filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 707afee2fc96bb39d3c1b6e1c9acaf343ca18bba
+  data.tar.gz: 5a9d7af30d472875b0cca4a591dfcc62a8e89a01
+SHA512:
+  metadata.gz: e25982c4ed2dba998b33fc59bdccc9935769ff604b06d4598a716eb6c5564391f992f2a7273e2ddd4523bf2581168f34fb602e9e60ef0dc235a33163c8b4027a
+  data.tar.gz: a32123806cbce6aded4d69a9dfee5207c632e6aaf6b1bb74b0ba3b97e06db447f51631d2215757ea7840b7687a67c4509b43da871ed1b7de6e423bc3514d557b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+TAGS

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cuckoo_filter.gemspec
+gemspec
+
+gem 'fnv-hash'

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,94 @@
+[![Build Status](https://travis-ci.com/pawandubey/cuckoo_filter.svg?token=3cAzkSrcDxPpHpxsqQyX&branch=master)](https://travis-ci.com/pawandubey/cuckoo_filter) [![codecov](https://codecov.io/gh/pawandubey/cuckoo_filter/branch/master/graph/badge.svg)](https://codecov.io/gh/pawandubey/cuckoo_filter)
+
+
+# CuckooFilter
+
+Pure Ruby implementation of the [Cuckoo Filter](https://www.cs.cmu.edu/~dga/papers/cuckoo-conext2014.pdf) - a probabilistic datastructure which is objectively better than Bloom Filters for set-membership queries.
+
+## What the heck is a Cuckoo Filter?
+
+It is a probabilistic data structure which is used to determine set-membership, i.e. finding out if a given element exists in a given set.
+
+For practical uses think - checking if an item is present in a cache, if it is present in a database or YouTube trying to figure out if you have already watched some video before it is recommended to you.
+
+It is closely related to Bloom Filters - but outshines them in performance and space efficiency. You can read more from the [original paper](https://www.cs.cmu.edu/~dga/papers/cuckoo-conext2014.pdf) that introduced it in 2014. Yes, it is that young!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cuckoo_filter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cuckoo_filter
+
+## Usage
+
+```ruby
+# Create a filter with 1024 (next power of 2) slots with each bucket holding 4
+cf = CuckooFilter.make(size: 1000, kicks: 500, bucket_size: 4)
+# => returns a CuckooFilter::CuckooFilter instance
+
+# Insert an element into the filter
+cf.insert("foo")
+# => true
+
+# Lookup the existence of an element
+cf.lookup("foo")
+# => true
+
+cf.lookup("bar")
+# => false
+
+# Delete an existing element
+cf.delete("foo")
+# => true
+```
+
+## Frequenty Anticipated Questions
+
+- Q: *Is this useful?*
+  A: Yes, but mainly for academic purposes.
+  
+- 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: *Then why did you make this?*
+  A: For fun and education, of course!
+  
+- Q: *But why Ruby? Why not Go/Rust/Elixir/FooBar*
+  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!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pawandubey/cuckoo_filter.
+
+## License
+
+Copyright 2017 Pawan Dubey
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cuckoo_filter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cuckoo_filter.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cuckoo_filter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cuckoo_filter"
+  spec.version       = CuckooFilter::VERSION
+  spec.authors       = ["Pawan Dubey"]
+  spec.email         = ["hi@pawandubey.com"]
+
+  spec.summary       = %q{Cuckoo Filter implementation in Ruby}
+  spec.homepage      = "https://github.com/pawandubeycuckoo_filter"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "codecov"
+end

data/lib/cuckoo_filter/bucket.rb

@@ -0,0 +1,84 @@
+module CuckooFilter
+  # A Bucket is essentially a collection of a finite number of
+  # Fingerprints.
+  #
+  # Buckets are the actual storage unit in a Cuckoo Filter.
+  class Bucket
+    attr_reader :size, :slots
+
+    def initialize(size)
+      @size = size
+      @filled = 0
+      @slots = Array.new(@size) { Fingerprint.new }
+    end
+
+    # Inserts the given fingerprint into one of the slots
+    # if a slot is found to be empty
+    #
+    # @param fingerprint [Fingerprint] the fingerprint to insert
+    #
+    # @return [Boolean] whether the insertion was successful
+    def insert(fingerprint)
+      @slots.each do |slot|
+        if slot.empty?
+          slot.set(fingerprint)
+          @filled = [(@filled + 1), 4].min
+          return true
+        end
+      end
+
+      false
+    end
+
+    # Removes the given fingerprint from the bucket if present
+    #
+    # @param fingerprint [Fingerprint] the fingerprint to remove
+    #
+    # @return [Fingerprint, nil] the removed fingerprint if successful, else nil
+    def remove(fingerprint)
+      if contains?(fingerprint)
+        @filled = [(@filled - 1), 0].max
+        slot = @slots.find { |slot| slot.value == fingerprint.value }
+        slot.clear!
+      end
+    end
+
+    # Swaps the given fingerprint with a randomly selected one
+    # already present in it, returning the replaced fingerprint
+    #
+    # This is used while "kicking" a fingerprint out during the
+    # insertion process.
+    #
+    # @see CuckooFilter::CuckooFilter#insert
+    #
+    # @param fingerprint [Fingerprint] the fingerprint to swap into the bucket
+    #
+    # @return [Fingerprint] the fingerprint swapped out of the bucket
+    def random_swap(fingerprint)
+      random_index = rand(@size)
+      fingerprint, @slots[random_index] = @slots[random_index], fingerprint
+      fingerprint
+    end
+
+    # @return [Boolean] if the bucket contains the given fingerprint
+    def contains?(fingerprint)
+      @slots.any? { |slot| slot.value == fingerprint.value }
+    end
+
+    # Clears all the values of the fingerprints
+    def clear!
+      @slots.map(&:clear!)
+      @filled = 0
+    end
+
+    # @return [Boolean] true if the bucket has an empty slot
+    def has_space?
+      @filled < @size
+    end
+
+    # @return [Boolean] true if the bucket has no empty slots
+    def empty?
+      @filled.zero?
+    end
+  end
+end

data/lib/cuckoo_filter/cuckoo_filter.rb

@@ -0,0 +1,146 @@
+require 'fnv'
+
+module CuckooFilter
+  # A Cuckoo Filter is a probablisitic data structure, which is highly
+  # useful for set-membership determination, i.e. finding out whether
+  # a given element is present in a set, as fast as possible.
+  #
+  # Probablistic data structures sacrifise some amount of accuracy for the
+  # sake of performance. A Cuckoo Filter, hence sacrifises accuracy in
+  # determining whether an element is "absent" - so it is likely to return
+  # some amount of false positives i.e. it will return "present" for some
+  # items which aren't actually present.
+  #
+  # Another popular data structure used for set-membership queries is the
+  # oft-mentioned Bloom-filter. Cuckoo Filter improves upon the performance of
+  # Bloom Filters by using only 2 hashes and deciding to store only the fixed-length
+  # fingerprint of the elements instead of the whole element. This provides not only
+  # spatial and performance gains, but also gives Cuckoo Filters the ability to delete
+  # an element - something conspicuously missing from Bloom Filters.
+  class CuckooFilter
+    attr_reader :size, :max_kicks, :bucket_size, :num_buckets, :filled
+
+    # Creates a new Cuckoo Filter with the provided options
+    #
+    # the number of buckets is the quotient of the total elements and bucket size
+    #
+    # the total size and bucket sizes are adjusted to the next power of two
+    # to support easy bitmasks instead of costly mod operations
+    #
+    # @param size [Integer] the number of elements the filter can handle
+    # @param kicks [Integer] the max number of kicks to tolerate during insertion
+    # @param bucket_size [Integer] the number of entries per bucket
+    #
+    # @return [CuckooFilter]
+    def initialize(size: 1024, kicks: 500, bucket_size: 4)
+      @size = next_power_of_two(size)
+      @max_kicks = kicks
+      @bucket_size = next_power_of_two(bucket_size)
+      @num_buckets = @size / @bucket_size
+      @filled = 0
+      @buckets = Array.new(@num_buckets) { Bucket.new(@bucket_size) }
+    end
+
+    # Inserts an item into the filter, returning true on success
+    # or false when the filter is either filled or the maximum number
+    # of kicks allowed is exceeded
+    #
+    # @param item [String] the item to be inserted
+    #
+    # @return [Boolean] true if successful insertion, else false
+    def insert(item)
+      fingerprint = fingerprint(item)
+      first_index = hash(item)
+      second_index = alt_index(first_index, fingerprint)
+
+      if @buckets[first_index].insert(fingerprint) || @buckets[second_index].insert(fingerprint)
+        increment_filled_count
+        return true
+      end
+
+      index = [first_index, second_index].sample
+
+      @max_kicks.times do
+        fingerprint = @buckets[index].random_swap(fingerprint)
+        index = alt_index(index, fingerprint)
+
+        if @buckets[index].insert(fingerprint)
+          increment_filled_count
+          return true
+        end
+      end
+
+      return false
+    end
+
+    # Tells whether the given item is present in the filter
+    # with some statistical variance in accuracy - hence the term
+    # "probablisitic data structure".
+    # It has some amount of chance of returning a false positive
+    #
+    # @param item [String] the item to lookup in the filter
+    #
+    # @return [Boolean] true if present else false
+    def lookup(item)
+      fingerprint = fingerprint(item)
+      first_index = hash(item)
+      second_index = alt_index(first_index, fingerprint)
+
+      @buckets[first_index].contains?(fingerprint) ||  @buckets[second_index].contains?(fingerprint)
+    end
+
+    # Delete the item from the filter if present
+    #
+    # @param item [String] the element to remove from the filter
+    #
+    # @return [Boolean] true if deletion successful else false
+    def delete(item)
+      fingerprint = fingerprint(item)
+      first_index = hash(item)
+      second_index = alt_index(first_index, fingerprint)
+
+      if @buckets[first_index].remove(fingerprint) ||  @buckets[second_index].remove(fingerprint)
+        decrement_filled_count
+        return true
+      end
+
+      return false
+    end
+
+    private
+
+    def next_power_of_two(num)
+      if (num & (num - 1)) == 0
+        [num, 1].max
+      else
+        1 << num.bit_length
+      end
+    end
+
+    def fingerprint(item)
+      Fingerprint.new(item)
+    end
+
+    def hash(item)
+      h = Fnv::Hash.fnv_1a(item, size: 32)
+      h & size_mask
+    end
+
+    def alt_index(first_index, fingerprint)
+      i = first_index ^ hash(fingerprint)
+      i & size_mask
+    end
+
+    def increment_filled_count
+      @filled = [@filled.succ, @size].min
+    end
+
+    def decrement_filled_count
+      @filled = [@filled.pred, 0].max
+    end
+
+    def size_mask
+      ((1 << Math.log2(@num_buckets).to_i) - 1)
+    end
+  end
+end

data/lib/cuckoo_filter/cuckoo_filter_error.rb

@@ -0,0 +1,4 @@
+module CuckooFilter
+  class CuckooFilterError < StandardError
+  end
+end

data/lib/cuckoo_filter/fingerprint.rb

@@ -0,0 +1,49 @@
+require 'fnv'
+
+module CuckooFilter
+  # A fingerprint is a fixed size "hash" of an element which is stored
+  # in one of the buckets of the Cuckoo Filter.
+  #
+  # Typically modeled as just a collection of bits (generally 6), since
+  # Ruby doesn't allow that low level an access to the memory, we just go ahead
+  # with a full blown class.
+  #
+  # value stores the actual value of the fingerprint
+  class Fingerprint
+    # @return [Numeric] the actual calculated FNV-1a fingerprint
+    attr_reader :value
+
+    # Creates a new fingerprint with the provided item, or without any
+    # actual fingerprint value if no item is provided
+    def initialize(item = nil)
+      @value = self.class.make(item).freeze unless item.nil?
+    end
+
+    # Update the value of a fingerprint if it was created without
+    # an item (i.e. the value is nil), else return error
+    #
+    # @param fingerprint [Fingerprint] the fingerprint with which to update the value
+    def set(fingerprint)
+      if @value.nil?
+        @value = fingerprint.value.freeze
+      else
+        fail CuckooFilterError, "Fingerprint value cannot be changed once set"
+      end
+    end
+
+    # Clear the value and return the old value encapsulated in a new {Fingerprint}
+    def clear!
+      old_value = self.dup
+      @value = nil
+      old_value
+    end
+
+    def empty?
+      @value.nil?
+    end
+
+    def self.make(item)
+      Fnv::Hash.fnv_1a(item, size: 32)
+    end
+  end
+end

data/lib/cuckoo_filter/version.rb

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

data/lib/cuckoo_filter.rb

@@ -0,0 +1,13 @@
+require "cuckoo_filter/version"
+require "cuckoo_filter/fingerprint"
+require "cuckoo_filter/bucket"
+require "cuckoo_filter/cuckoo_filter"
+require "cuckoo_filter/cuckoo_filter_error"
+
+# @see CuckooFilter::CuckooFilter for documentation
+module CuckooFilter
+  # Create and return a new {CuckooFilter} instance
+  def self.make(size: 1024, kicks: 500, bucket_size: 4)
+    CuckooFilter.new(size: size, kicks: kicks, bucket_size: bucket_size)
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: cuckoo_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pawan Dubey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry
+  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: codecov
+  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'
+description: 
+email:
+- hi@pawandubey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cuckoo_filter.gemspec
+- lib/cuckoo_filter.rb
+- lib/cuckoo_filter/bucket.rb
+- lib/cuckoo_filter/cuckoo_filter.rb
+- lib/cuckoo_filter/cuckoo_filter_error.rb
+- lib/cuckoo_filter/fingerprint.rb
+- lib/cuckoo_filter/version.rb
+homepage: https://github.com/pawandubeycuckoo_filter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Cuckoo Filter implementation in Ruby
+test_files: []