hamming 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de61c8fcbfd38c34801656f383cb34bc1baff7058a61117af043838f8b10daa8
+  data.tar.gz: 9421e1ccca66a2817f4c421409c34aa1933dd17f5498440c84be07ccf97dbc58
+SHA512:
+  metadata.gz: 3b3447a06164f785058398bf0b18ddaa16d035d78cfb6845b18e91291e83e14cb24870ead0103aacae8f30c0fe6d99e6399da9ea5a07de4131ac6723a27aac46
+  data.tar.gz: 3e65c9e21e4b1d561ffb0e7fc3972b26ae10c05e0dba9fe3ad4c6d81bc49e262f31c0f7544ecb2dea07c9a26e87ab0929bb0eddac5e43720cadeb2ba4902ca72

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Makefile

@@ -0,0 +1,16 @@
+.PHONY: *
+
+default: test
+
+build:
+	rm -f *.gem
+	gem build hamming.gemspec
+
+publish: build
+	gem push *.gem
+
+console:
+	irb -Ilib -rhamming
+
+test:
+	ruby -Ilib:spec spec/*_spec.rb

data/README.md

@@ -0,0 +1,25 @@
+# Hamming
+
+## Install
+
+```bash
+gem install hamming
+```
+
+## Usage
+
+Hamming calculates the distance between two hashes or two vectors.
+
+### Distance
+
+Since hashes exist on a metric space you can measure how far a hash is from another.
+
+```ruby
+hash_a = "859091ce633aaebb"
+hash_b = "859091ce633aaeba"
+Hamming.distance(hash_a, hash_b)
+
+# You can also transform hashes based on your storage:
+Hamming.vector_to_hash(hash)
+Hamming.hash_to_vector(vector)
+```

data/hamming.gemspec

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name              = "hamming"
+  s.version           = "0.1.0"
+  s.summary           = "Hamming calculations"
+  s.authors           = ["elcuervo"]
+  s.licenses          = %w[MIT]
+  s.email             = ["elcuervo@elcuervo.net"]
+  s.homepage          = "http://github.com/elcuervo/hamming"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files test`.split("\n")
+end

data/lib/hamming.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+#
+class Hamming
+  class << self
+    def vector_to_hash(vector)
+      vector.join.to_i(2).to_s(16)
+    end
+
+    def hash_to_vector(hash)
+      hash.hex.to_s(2).split("").map(&:to_i)
+    end
+
+    def distance(a, b)
+      a = a.kind_of?(Array) ? vector_to_hash(a) : a
+      b = b.kind_of?(Array) ? vector_to_hash(b) : b
+
+      n = a.hex ^ b.hex
+
+      ones = 0
+
+      while n > 0
+        n &= n - 1
+        ones += 1
+      end
+
+      ones
+    end
+  end
+end

data/spec/hamming_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Hamming do
+  describe "comparing hashes" do
+    let(:hash_a) { "859091ce633aaebb" }
+    let(:hash_b) { "859091ce633aaeba" }
+
+    let(:vector_a) do
+      [
+        1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1,
+        0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 1, 1, 0,
+        1, 1
+      ]
+    end
+
+    let(:vector_b) do
+      [
+        1, 0, 0, 0, 0, 1, 0, 1, 1, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 1, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1,
+        0, 0, 1, 1, 0, 0, 0, 1, 1, 0, 0, 1, 1, 1, 0, 1, 0, 1, 0, 1, 0, 1, 1, 1, 0, 1, 0, 1, 1, 1, 0,
+        1, 0
+      ]
+    end
+
+    it "conversion" do
+      assert_equal vector_a, Hamming.hash_to_vector(hash_a)
+      assert_equal hash_b, Hamming.vector_to_hash(vector_b)
+    end
+
+    it "#distance" do
+      assert_equal 0, Hamming.distance(vector_b, vector_b)
+      assert_equal 0, Hamming.distance(hash_a, hash_a)
+      assert_equal 1, Hamming.distance(hash_a, vector_b)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "hamming"

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: hamming
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- elcuervo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-29 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- elcuervo@elcuervo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Makefile
+- README.md
+- hamming.gemspec
+- lib/hamming.rb
+- spec/hamming_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/elcuervo/hamming
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hamming calculations
+test_files: []