minhash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a991d33257686b6ef59fc014ec0d2c89ecfdadc
+  data.tar.gz: cb6fc0a7e12924bf9b04f602f4be49a402ecc486
+SHA512:
+  metadata.gz: 0a34f7fa09f634100dc48aae9ad37fa1368098d1c93157001d2e8fc12028a0320fc89fa12596ce437ee4662e67aba3d94e293f29a237beff0ab5366a303e300a
+  data.tar.gz: 95008befcd4a1ea8863b8ca12dfe3724dd0496d45d59bc80c646809291df58ae653b5050719d133bb4a71779acb82ecceb5654f88ed3e465aaec12c5e766474e

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Roland Swingler
+
+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.rdoc

@@ -0,0 +1,21 @@
+= minhash
+
+An implementation of the Minhash algorithm in Ruby.
+
+For more details, see Chapter 3 of http://www.mmds.org/
+
+== Contributing to minhash
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Roland Swingler. See LICENSE.txt for
+further details.
+

data/lib/minhash.rb

@@ -0,0 +1,111 @@
+require 'murmurhash3'
+require 'set'
+
+module Minhash
+  # Generates the k-shingles for a String.
+  #
+  # For example, with the string "12345" and k = 3 the shingles are
+  # "123", "234" and "345".
+  #
+  #     k_shingles("ABCDE", 3)
+  #     # => ["ABC", "BCD", "CDE"]
+  #
+  # Normalizes all whitespace to be single character spaces.
+  #
+  # You want to select k to be large enough to be able to
+  # distinguish chunks of text adequately - a value of around 9 is
+  # sensible for reasonable sized chunks of standard written text.
+  def self.k_shingles(text, k)
+    if text.size < k
+      [text]
+    else
+      text.tr("\t\n\r", "   ").
+        squeeze(" ").
+        each_char.
+        each_cons(k).
+        map(&:join)
+    end
+  end
+
+  # Generates a Set of tokenized 32-bit integer k-shingles.
+  #
+  #    tokenized_k_shingles("ABCDE", 3)
+  #    # =>  #<Set: {1136772405, 3561005568, 944681077}>
+  #
+  # MurmurHash3 is used by default; if you want to use a different
+  # hash function, pass a block:
+  #
+  #    tokenized_k_shingles("ABCDE", 3) do |shingle|
+  #      # obviously a terrible hash function, just an example.
+  #      shingle[0].ord
+  #    end
+  #    # => #<Set: {65, 66, 67}>
+  def self.tokenized_k_shingles(text, k, &hash)
+    hash ||= lambda {|s| MurmurHash3::Native32.murmur3_32_str_hash(s) }
+    k_shingles(text, k).map {|shingle| hash.call(shingle) }.to_set
+  end
+
+  # Returns the jaccard similarity between two sets of shingles /
+  # tokens.
+  def self.jaccard_similarity(a, b)
+    (a & b).size / (a | b).size.to_f
+  end
+
+  # Returns the approximate jaccard similarity of 2 sets, given their
+  # signatures.
+  def self.approximate_similarity(a, b)
+    a.length.times.select {|i| a[i] == b[i] }.size / a.length.to_f
+  end
+
+  # Mixin to extend String with k-shingle functions.
+  module StringExtensions
+    # Generates the k-shingles for this String.
+    #
+    # See Minhash::StringFunctions#k_shingles
+    def k_shingles(k)
+      Minhash.k_shingles self, k
+    end
+
+    # Generates the tokenized k-shingles for this String.
+    #
+    # See Minhash::StringFunctions#tokenized_k_shingles
+    def tokenized_k_shingles(k, &block)
+      Minhash.tokenized_k_shingles self, k, &block
+    end
+  end
+
+  # The Minhash signature algorithm.
+  #
+  # See section 3.3 of the http://www.mmds.org/ book:
+  # http://infolab.stanford.edu/~ullman/mmds/ch3.pdf
+  #
+  # Simple XORs of random integer bit masks are used as the hash
+  # functions.
+  class Algorithm
+    # Returns the bit masks used to implement the hash functions.
+    attr_reader :masks
+
+    # Creates a new instance of the algorithm, with the given bit
+    # masks.
+    def initialize(masks)
+      @masks = masks.freeze
+      @hash_functions ||= @masks.map {|mask| lambda {|i| i ^ mask } }
+    end
+
+    # Creates a new instance of the algorithm with +length+ random bit
+    # masks.
+    def self.create(length)
+      new length.times.map { rand(2 ** 32 -1) }
+    end
+
+    # Returns the minhash signature for a set of tokens.
+    def signature(tokens)
+      @hash_functions.map {|f| tokens.map(&f).min }
+    end
+  end  
+end
+
+class String
+  include Minhash::StringExtensions
+end
+

data/spec/minhash_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe "Minhash" do
+  describe "generating k-shingles of a string" do
+    it "k-shingles text" do
+      expect( "12345".k_shingles(3) ).to eql(["123", "234", "345"])
+    end
+
+    it "generates a single shingle when the string is smaller than k" do
+      expect( "12".k_shingles(3) ).to eql(["12"])
+    end
+
+    it "replaces whitespace characters with a space" do
+      expect( "\t2\t4\n".k_shingles(3) ).to eql([" 2 ", "2 4", " 4 "])
+    end
+
+    it "squeezes consecutive whitespace characters" do
+      expect("22   \t  \n".k_shingles(3)).to eql(["22 "])
+    end
+
+    it "generates tokenized k-shingles" do
+      expect("ABCDE".tokenized_k_shingles(3)).
+        to eql(Set.new([1136772405, 3561005568, 944681077]))
+    end
+
+    it "tokenizes shingles with a custom hash function" do
+      expect("ABCDE".tokenized_k_shingles(3) {|s| s[0].ord }).
+        to eql(Set.new([65,66,67]))
+    end
+  end
+
+  describe "generating a Minhash signature for text" do
+    it "returns a signature of the tokens" do
+      algorithm = Minhash::Algorithm.new([1,2])
+      expect(algorithm.signature([1, 2, 3])).to eql([0, 0])
+    end
+
+    it "can create X masks internally" do
+      algorithm = Minhash::Algorithm.create(20)
+      expect(algorithm.masks.size).to eql(20)
+      signature = algorithm.signature([1])
+      expect(signature.size).to eql(20)
+      expect(signature.all? {|i| i.instance_of?(Fixnum) }).to eql(true)
+    end
+  end
+
+  it "returns the jaccard similarity of 2 sets" do
+    a = Set.new([1,2,3])
+    b = Set.new([2,3,4])
+    expect(Minhash.jaccard_similarity(a,b)).to eql(0.5)
+  end
+
+  it "returns the approximate similarity for 2 signatures" do
+    a = [1,2,3,4]
+    b = [2,2,3,4]
+    expect(Minhash.approximate_similarity(a,b)).to eql(0.75)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'minhash'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: minhash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Roland Swingler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: murmurhash3
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Minhash algorithm implementation
+email: roland.swingler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- lib/minhash.rb
+- spec/minhash_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/knaveofdiamonds/minhash
+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: Minhash algorithm implementation in ruby
+test_files: []
+has_rdoc: