count_min_sketch 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2073d6bc85d3bf50b04a6db9adfa374c54586713
+  data.tar.gz: 3585ef0b618354e3955f06942726435a8d0865b5
+SHA512:
+  metadata.gz: ec86bfdc98e374d9d405f354ed370ed4b34cc2012218cda28804a3cb222a5442c6428bb799d8810689832b59abaac24baf9dda76eb70b44ccedac7cc153bf761
+  data.tar.gz: 0534b13ad4b0733c629c349b291c034b92fde7d836faf9fe8701262094da715b310e193072c30dcc659b629d28c7d6f9414001388631824168d00eabd2abdcaa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in count_min_sketch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Katie Hoffman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Count-Min Sketch
+
+A Ruby implementation of Graham Cormode and S. Muthu Muthukrishnan's probabilistic sub-linear space streaming algorithm. Relies on [nashby's](https://github.com/nashby) [CityHash gem](https://github.com/nashby/cityhash). To read more about count-min sketches, see the [Wiki page](http://en.wikipedia.org/wiki/Count%E2%80%93min_sketch).
+
+## Install
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'count_min_sketch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install count_min_sketch
+
+## Usage
+
+Accepts two optional arguments, `k`, the number of hash functions, and `m`, the column size. These default to 10 and 100000 respectively.
+
+**Without Arguments**
+
+```ruby
+require 'count_min_sketch'
+
+sketch = CountMinSketch::Counter.new
+
+sketch.k
+# => 10
+sketch.m
+# => 100000
+```
+
+**With Arguments**
+
+```ruby
+require 'count_min_sketch'
+
+name = "Guy Fieri"
+restaurant = "Guy's American Kitchen and Bar"
+
+k = 30
+m = 128
+sketch = CountMinSketch::Counter.new(k, m)
+
+sketch.k
+# => 30
+sketch.m
+# => 128
+
+sketch.insert(name)
+sketch.insert(restaurant, 2)
+
+sketch.get_count(name)
+# => 1
+
+sketch.get_count(restaurant)
+# => 2
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/kthffmn/count_min_sketch/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/count_min_sketch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'count_min_sketch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "count_min_sketch"
+  spec.version       = CountMinSketch::VERSION
+  spec.authors       = ["Katie Hoffman"]
+  spec.email         = ["ktahoffman@gmail.com"]
+  spec.summary       = "Count-Min Sketch implementation that relies on nashby's CityHash gem."
+  spec.description   = "Implementation of Graham Cormode and S. Muthu Muthukrishnan's probabilistic sub-linear space streaming algorithm."
+  spec.homepage      = "https://github.com/kthffmn/count_min_sketch"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  
+  spec.add_dependency  'cityhash', "~> 0.8.1"
+end

data/lib/count_min_sketch.rb

@@ -0,0 +1 @@
+require 'count_min_sketch/counter'

data/lib/count_min_sketch/counter.rb

@@ -0,0 +1,34 @@
+require 'cityhash'
+require "count_min_sketch/version"
+
+module CountMinSketch
+  class Counter
+
+    MAX_FIXNUM = 2**(0.size*8 - 2) - 1
+
+    attr_reader :k, :m, :data
+
+    def initialize(k=10, m=100000)
+      @k = k
+      @m = m
+      @data = Array.new(k) { Array.new(m,0) }
+      @seeds = Array.new(k) { rand(MAX_FIXNUM + 1) }
+    end
+
+    def get_count(x)
+      insert(x, 0)
+    end
+
+    def insert(x, n=1)
+      min_count = Float::INFINITY
+      hashes_of_x = @seeds.map { |s| CityHash.hash64(x, s) }
+      hashes_of_x.each_with_index do |hash, i|
+        j = hash % m
+        count = @data[i][j] += n
+        min_count = count if count < min_count
+      end
+      min_count
+    end
+
+  end
+end

data/lib/count_min_sketch/version.rb

@@ -0,0 +1,3 @@
+module CountMinSketch
+  VERSION = "0.0.4"
+end

data/spec/count_min_sketch_spec.rb

@@ -0,0 +1,88 @@
+describe 'CountMinSketch' do 
+  describe 'Counter' do
+
+    let(:count_min_sketch) { CountMinSketch::Counter.new(30, 128) }
+    let(:bands)  { YAML.load_file('spec/fixtures/band_names.yml') }
+    let(:band)   { "Sylvan Esso"  }
+    let(:singer) { "Valerie June" }
+
+    describe "MAX_FIXNUM" do
+      it "is the maximum Fixnum on the machine" do
+        expect(CountMinSketch::Counter::MAX_FIXNUM.class).to eq(Fixnum)
+        expect((CountMinSketch::Counter::MAX_FIXNUM + 1).class).to eq(Bignum)
+      end
+    end
+
+    describe "#initialize" do
+      it "does not raise an error initialized with two arguments, 'k' and 'm'" do
+        expect(count_min_sketch.k).to eq(30)
+        expect(count_min_sketch.m).to eq(128)
+      end
+    end
+
+    describe "#insert" do
+      it "returns a count of one when a string is added once" do
+        expect(count_min_sketch.insert(singer)).to eq(1)
+      end
+
+      it "returns a count of two when a string is added once, then a second time" do
+        count_min_sketch.insert(band)
+        expect(count_min_sketch.insert(band)).to eq(2)
+      end
+
+      it "returns a count of two when a string is added with optional times argument of 2" do
+        expect(count_min_sketch.insert(singer, 2)).to eq(2)
+      end
+
+      it "returns a count of ten when a string is added with optional times argument of 10" do
+        expect(count_min_sketch.insert(band, 10)).to eq(10)
+      end
+    end
+
+    describe "#get_count" do
+      it "remembers when a string is added once" do
+        count_min_sketch.insert(band)
+        expect(count_min_sketch.get_count(band)).to eq(1)
+      end
+
+      it "remembers when the same string is added twice" do
+        2.times { count_min_sketch.insert(singer) }
+        expect(count_min_sketch.get_count(singer)).to eq(2)
+      end
+
+      it "returns a count of zero for strings that have not been added" do
+        expect(count_min_sketch.get_count("Rhye")).to eq(0)
+      end
+
+      it "returns a zero count for a string that has not been added 
+        regardless of other added strings" do
+        2.times do 
+          count_min_sketch.insert(singer)
+          count_min_sketch.insert(band)
+        end
+        expect(count_min_sketch.get_count("Rhye")).to eq(0)
+      end
+
+      it "returns the correct count of one regardless of other added strings" do
+        count_min_sketch.insert(band)
+        expect(count_min_sketch.get_count(band)).to eq(1)
+        2.times { count_min_sketch.insert(singer) }
+        expect(count_min_sketch.get_count(band)).to eq(1)
+      end
+
+      it "returns the correct count of two regardless of other added strings" do
+        2.times { count_min_sketch.insert(singer) }
+        expect(count_min_sketch.get_count(singer)).to eq(2)
+        3.times { count_min_sketch.insert(band) }
+        expect(count_min_sketch.get_count(singer)).to eq(2)
+      end
+
+      it "returns the correct count of four regardless of other added strings" do
+        bands.each { |band| count_min_sketch.insert(band) }
+        expect(count_min_sketch.get_count("Chvrches")).to eq(4)
+        expect(count_min_sketch.get_count("St. Vincent")).to eq(4)
+      end      
+    end
+
+  end
+end

data/spec/fixtures/band_names.yml

@@ -0,0 +1,60 @@
+- The Flaming Lips
+- Valerie June
+- Miranda Lambert
+- St. Vincent
+- Chvrches
+- Katy B
+- Sturgill Simpson
+- St. Vincent
+- Freddie Gibbs and Madlib
+- Chvrches
+- St. Vincent
+- Sharon Van Etten
+- Chvrches
+- EMA
+- Future Islands
+- Lake Street Dive
+- St. Vincent
+- Chvrches
+- Swans
+- Hurray for the Riff Raff
+- My Bloody Valentine
+- Skrillex
+- Jack White
+- Eric Church
+- Against Me!
+- J. Cole
+- Kurt Vile
+- Waxahatchee
+- Bruce Springsteen
+- Parquet Courts
+- Best Coast
+- Earl Sweatshirt
+- Haim
+- Beck
+- Damon Albarn
+- Tegan & Sara
+- Kacey Musgraves
+- Chance The Rapper
+- The Black Keys
+- The Roots
+- Phoenix
+- Sky Ferreira
+- Laura Marling
+- Future
+- Sia
+- Ashley Monroe
+- Danny Brown
+- David Bowie
+- Stephen Malkmus and the Jicks
+- Conor Oberst
+- Drake
+- Disclosure
+- Arctic Monkeys
+- Pharrell Williams
+- Tune-Yards
+- The National
+- Lorde
+- Arcade Fire
+- Schoolboy Q
+- Calle 13

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require_relative '../lib/count_min_sketch'
+require 'cityhash'
+require 'yaml'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: count_min_sketch
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Katie Hoffman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: cityhash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Implementation of Graham Cormode and S. Muthu Muthukrishnan's probabilistic
+  sub-linear space streaming algorithm.
+email:
+- ktahoffman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- count_min_sketch.gemspec
+- lib/count_min_sketch.rb
+- lib/count_min_sketch/counter.rb
+- lib/count_min_sketch/version.rb
+- spec/count_min_sketch_spec.rb
+- spec/fixtures/band_names.yml
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: https://github.com/kthffmn/count_min_sketch
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Count-Min Sketch implementation that relies on nashby's CityHash gem.
+test_files:
+- spec/count_min_sketch_spec.rb
+- spec/fixtures/band_names.yml
+- spec/spec_helper.rb