measurable 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+tmp/*
+benchmarks/*

data/Gemfile

@@ -0,0 +1,3 @@
+# Gemfile
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    measurables (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rake-compiler (0.8.1)
+      rake
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  measurables!
+  rake (~> 0.9)
+  rake-compiler (~> 0.8.1)
+  rspec (~> 2.9.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Carlos Agarie
+
+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,73 @@
+# Measurable
+
+This (soon to be) gem encompasses various distance measures to be used in different projects. I want to support both the built-in `Array` class and [NMatrix](http://github.com/sciruby/nmatrix)'s `NVector`.
+
+This is a fork of the gem [Distance Measure](https://github.com/reddavis/Distance-Measures), which has a similar objective, but isn't actively maintained and doesn't support NMatrix. Thank you, [reddavis](https://github.com/reddavis). :)
+
+# Install
+
+I'll update this section when I publish the gem. For now... wait.
+  
+## How to use
+
+This list will be updated as I have time. I'll refactor the existing measures and add some that I'll need in a project.
+
+The API I intend to support is something like this:
+
+```ruby
+require "measurable"
+	
+u = NVector.ones(2)
+v = NVector.zeros(2)
+w = [1, 0]
+
+Measurable::euclidean(u, v) # => 1.41421
+Measurable::euclidean(w, v) # => 1.00000
+Measurable::euclidean(w, w) # => 0.00000
+```
+
+Maybe add some support for some of NMatrix's dtypes, like `:float32`, `:float64`, `:complex64`, `:complex128`, etc.
+
+## How to use, the old way:
+
+  a = [1,1]
+  b = [2,2]
+  
+  a.euclidean_distance(b)
+  
+  a.cosine_similarity(b)
+  
+  a.jaccard_index(b)
+  
+  a.jaccard_distance(b)
+  
+  a.binary_jaccard_index(b)
+  
+  a.binary_jaccard_distance(b)
+  
+  a.tanimoto_coefficient(b)
+  
+  a.haversine_distance(b)
+  
+This may or may not be the complete list, best thing is to check the source code.
+  
+There are also a couple bonus methods:
+
+  a.dot_product(b)
+  
+  a.sum_of_squares
+  
+  a.intersection_with(b)
+  
+  a.union_with(b)
+  
+  # When your dealing with 1's and 0's
+  a.binary_intersection_with(b)
+  
+  a.binary_union_with(b)
+
+## License
+
+Copyright (c) 2012 Carlos Agarie. See LICENSE for details.
+
+The original `Distance Measure` gem is copyrighted by reddavis 2010.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+require "rake/extensiontask"
+
+# Setup the necessary gems, specified in the gemspec.
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+# Compile task.
+Rake::ExtensionTask.new do |ext|
+    ext.name = 'measurable'          
+    ext.ext_dir = 'ext/measurable' 
+    ext.lib_dir = 'lib/'
+    ext.source_pattern = "**/*.{c, cpp, h}" 
+end

data/ext/measurable/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+dir_config("measurable")
+
+create_makefile("measurable")

data/ext/measurable/measurable.c

@@ -0,0 +1,209 @@
+#include <ruby.h>
+#include <math.h>
+
+#ifndef RUBY_19
+#ifndef RARRAY_LEN
+#define RARRAY_LEN(v) (RARRAY(v)->len)
+#endif
+#ifndef RARRAY_PTR
+#define RARRAY_PTR(v) (RARRAY(v)->ptr)
+#endif
+#endif
+
+/*
+** def euclidean_distance(other)
+**   sum = 0.0
+**   self.each_index do |i|
+**     sum += (self[i] - other[i])**2
+**   end
+**   Math.sqrt(sum)
+** end
+*/
+
+static VALUE rb_euclidean(VALUE self, VALUE other_array) {
+  double value = 0.0;
+
+  /* TODO: check they're the same size. */
+  long vector_length = (RARRAY_LEN(self) - 1);
+  int index;
+
+  for (index = 0; index <= vector_length; index++) {
+    double x, y;
+
+    x = NUM2DBL(RARRAY_PTR(self)[index]);
+    y = NUM2DBL(RARRAY_PTR(other_array)[index]);
+
+    value += pow(x - y, 2);
+  }
+
+  return rb_float_new(sqrt(value));
+}
+
+/* Prototypes */
+long c_array_size(VALUE array);
+
+/*
+** def dot_product(other)
+**   sum = 0.0
+**   self.each_with_index do |n, index|
+**     sum += n * other[index]
+**   end
+** 
+**   sum
+** end
+*/
+
+static VALUE rb_dot_product(VALUE self, VALUE other_array) {
+  double sum = 0;
+
+  /* TODO check they're the same size. */
+  long array_size = c_array_size(self);
+  int index;
+
+  for(index = 0; index <= array_size; index++) {
+    double x, y;
+
+    x = NUM2DBL(RARRAY_PTR(self)[index]);
+    y = NUM2DBL(RARRAY_PTR(other_array)[index]);
+
+    sum += x * y;
+  }
+
+  return rb_float_new(sum);
+}
+
+/*
+** def sum_of_squares
+**   inject(0) {|sum, n| sum + n ** 2}
+** end
+*/
+	
+static VALUE rb_sum_of_squares(VALUE self) {
+  double sum = 0;
+  long array_size = c_array_size(self);
+  int index;
+
+  for(index = 0; index <= array_size; index++) {
+    double x;
+
+    x = NUM2DBL(RARRAY_PTR(self)[index]);
+
+    sum += pow(x, 2);
+  }
+
+  return rb_float_new(sum);
+}
+
+/*
+** def euclidean_normalize
+**   sum = 0.0
+**   self.each do |n|
+**     sum += n ** 2
+**   end
+** 
+**   Math.sqrt(sum)
+** end
+*/
+
+static VALUE rb_euclidean_normalize(VALUE self) {
+  double sum = 0;
+  long array_size = c_array_size(self);
+  int index;
+
+  for(index = 0; index <= array_size; index++) {
+    double x;
+
+    x = NUM2DBL(RARRAY_PTR(self)[index]);
+
+    sum += pow(x, 2);
+  }
+
+  return rb_float_new(sqrt(sum));
+}
+
+/*
+** def binary_union_with(other)
+**   unions = []
+**   self.each_with_index do |n, index|
+**     if n == 1 || other[index] == 1
+**       unions << 1
+**     else
+**       unions << 0
+**     end
+**   end
+** 
+**   unions
+** end
+*/
+
+static VALUE rb_binary_union_with(VALUE self, VALUE other_array) {
+  //TODO: check arrays are same size
+  long array_size = c_array_size(self);
+  int index;
+  VALUE results = rb_ary_new();
+
+  for(index = 0; index <= array_size; index++) {
+    int self_attribute = NUM2INT(RARRAY_PTR(self)[index]);
+    int other_array_attribute = NUM2INT(RARRAY_PTR(other_array)[index]);
+
+    if(self_attribute == 1 || other_array_attribute == 1) {
+      rb_ary_push(results, rb_int_new(1));
+    } else {
+      rb_ary_push(results, rb_int_new(0));
+    }
+  }
+
+  return results;
+}
+
+/*
+** def binary_intersection_with(other)
+**   intersects = []
+**   self.each_with_index do |n, index|
+**     if n == 1 && other[index] == 1
+**       intersects << 1
+**     else
+**       intersects << 0
+**     end
+**   end
+** 
+**   intersects
+** end
+*/
+
+static VALUE rb_binary_intersection_with(VALUE self, VALUE other_array) {
+  /* TODO check arrays are same size */
+  long array_size = c_array_size(self);
+  int index;
+  VALUE results = rb_ary_new();
+
+  for(index = 0; index <= array_size; index++) {
+    int self_attribute = NUM2INT(RARRAY_PTR(self)[index]);
+    int other_array_attribute = NUM2INT(RARRAY_PTR(other_array)[index]);
+
+    if(self_attribute == 1 && other_array_attribute == 1) {
+      rb_ary_push(results, rb_int_new(1));
+    } else {
+      rb_ary_push(results, rb_int_new(0));
+    }
+  }
+
+  return results;
+}
+
+/* return the size of a Ruby array - 1 */
+long c_array_size(VALUE array) {
+  return (RARRAY_LEN(array) - 1);
+}
+
+void
+Init_measurable()
+{
+  VALUE rb_measurable = rb_define_module("Measurable");
+	rb_define_method(rb_measurable, "euclidean", rb_euclidean, 1);
+  rb_define_method(rb_measurable, "dot_product", rb_dot_product, 1);
+  rb_define_method(rb_measurable, "sum_of_squares", rb_sum_of_squares, 0);
+  rb_define_method(rb_measurable, "euclidean_normalize", rb_euclidean_normalize, 0);
+  rb_define_method(rb_measurable, "binary_union_with", rb_binary_union_with, 1);
+  rb_define_method(rb_measurable, "binary_intersection_with", rb_binary_intersection_with, 1);
+}

data/lib/measurable.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require "measurable/version.rb"
+
+require "measurable/cosine_similarity"
+require "measurable/tanimoto_coefficient"
+require "measurable/jaccard"
+require "measurable/haversine"
+
+require "measurable.so"
+
+class Array
+  include Measurable
+
+  # http://en.wikipedia.org/wiki/Intersection_(set_theory)
+  def intersection_with(other)
+    (self & other)
+  end
+
+  # http://en.wikipedia.org/wiki/Union_(set_theory)
+  def union_with(other)
+    (self + other).uniq
+  end
+
+  private
+
+  # Checks if we"re dealing with NaN"s and will return 0.0 unless
+  # handle NaN"s is set to false
+  def handle_nan(result)
+    result.nan? ? 0.0 : result
+  end
+end

data/lib/measurable/cosine_similarity.rb

@@ -0,0 +1,8 @@
+module Measurable
+  def self.cosine_similarity(other)
+    dot_product = self.dot_product(other)
+    normalization = self.euclidean_normalize * other.euclidean_normalize
+
+    handle_nan(dot_product / normalization)
+  end
+end

data/lib/measurable/haversine.rb

@@ -0,0 +1,46 @@
+# 
+# Notes:
+#
+# translated into Ruby based on information contained in:
+#   http://mathforum.org/library/drmath/view/51879.html  Doctors Rick and Peterson - 4/20/99
+#   http://www.movable-type.co.uk/scripts/latlong.html
+#   http://en.wikipedia.org/wiki/Haversine_formula
+#
+# This formula can compute accurate distances between two points given latitude and longitude, even for 
+# short distances.
+
+module Measurable
+
+  # PI = 3.1415926535
+  RAD_PER_DEG = 0.017453293  #  PI/180
+
+  R_MILES = 3956     # radius of the great circle in miles
+  R_KM = 6371        # radius in kilometers...some algorithms use 6367
+  
+  # the great circle distance d will be in whatever units R is in
+  R = {
+    :miles => R_MILES,
+    :km => R_KM,
+    :feet => R_MILES * 5282,
+    :meters => R_KM * 1000
+  }
+
+  def haversine_distance(other, um = :meters)
+    dlon = other[1] - self[1]
+    dlat = other[0] - self[0]
+
+    dlon_rad = dlon * RAD_PER_DEG 
+    dlat_rad = dlat * RAD_PER_DEG
+
+    lat1_rad = self[0] * RAD_PER_DEG
+    lon1_rad = self[1] * RAD_PER_DEG
+
+    lat2_rad = other[0] * RAD_PER_DEG
+    lon2_rad = other[1] * RAD_PER_DEG
+
+    a = (Math.sin(dlat_rad/2))**2 + Math.cos(lat1_rad) * Math.cos(lat2_rad) * (Math.sin(dlon_rad/2))**2
+    c = 2 * Math.atan2( Math.sqrt(a), Math.sqrt(1-a))
+
+    R[um] * c
+  end
+end

data/lib/measurable/jaccard.rb

@@ -0,0 +1,26 @@
+# http://en.wikipedia.org/wiki/Jaccard_coefficient
+module Measurable
+  
+  def jaccard_distance(other)
+    1 - self.jaccard_index(other)
+  end
+  
+  def jaccard_index(other)
+    union = (self + other).uniq.size.to_f
+    intersection = self.intersection_with(other).size.to_f
+        
+    intersection / union
+  end
+  
+  def binary_jaccard_distance(other)
+    1 - self.binary_jaccard_index(other)
+  end
+  
+  def binary_jaccard_index(other)
+    intersection = self.binary_intersection_with(other).delete_if {|x| x == 0}.size.to_f
+    union = self.binary_union_with(other).delete_if {|x| x == 0}.size.to_f
+    
+    intersection / union
+  end
+  
+end

data/lib/measurable/tanimoto_coefficient.rb

@@ -0,0 +1,9 @@
+# http://en.wikipedia.org/wiki/Jaccard_index#Tanimoto_coefficient_.28extended_Jaccard_coefficient.29
+module Measurable
+  def tanimoto_coefficient(other)
+    dot = self.dot_product(other).to_f
+    result = dot / (self.sum_of_squares + other.sum_of_squares - dot).to_f
+    
+    handle_nan(result)
+  end
+end

data/lib/measurable/version.rb

@@ -0,0 +1,3 @@
+module Measurable
+  VERSION = "0.0.1"
+end

data/measurable.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'measurable/version'
+
+Gem::Specification.new do |gem|
+  gem.name = "measurable"  
+  gem.version = Measurable::VERSION
+  gem.date = Date.today.to_s
+  gem.summary = %Q{A Ruby module with a lot of distance measures for your projects.}
+  gem.description = %Q{A Ruby module with a lot of distance measures for your projects.}
+  
+  gem.authors = ["Carlos Agarie"]
+  gem.email = "carlos@onox.com.br"
+  gem.homepage = "http://github.com/agarie/measurable"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  gem.require_paths = ["lib"]  
+  gem.extensions = ['ext/measurable/extconf.rb']
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rake-compiler', '~> 0.8.1'
+  gem.add_development_dependency 'rspec', '~> 2.9.0'
+end

data/spec/measurable.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Measurable do
+
+  let(:array) { [5, 5] }
+  let(:array_2) { [7, 3, 2, 4, 1] }
+  let(:array_3) { [4, 1, 9, 7, 5] }
+
+  describe "Euclidean Distance" do
+    it "should return 0.0" do
+      array.euclidean_distance(array).should == 0.0
+    end
+
+    it "should return 4.0" do
+      [5].euclidean_distance([1]).should == 4.0
+    end
+  end
+
+  describe "Cosine Similarity" do
+    it "should return 1.0" do
+      array.cosine_similarity(array).should.to_s == "1.0" # WTF
+    end
+
+    it "should handle NaN's" do
+      [0.0, 0.0].cosine_similarity([0.0, 0.0]).nan?.should be_false
+    end
+  end
+
+  describe "Tanimoto Coefficient" do
+    it "should return 1.0" do
+      array.tanimoto_coefficient(array).should == 1.0
+    end
+
+    it "should handle NaN's" do
+      [0.0, 0.0].tanimoto_coefficient([0.0, 0.0]).nan?.should be_false
+    end
+  end
+
+  describe "Sum of Squares" do
+    it "should return 50" do
+      array.sum_of_squares.should == 50
+    end
+  end
+
+  describe "Jaccard" do
+    describe "Jaccard Distance" do
+      it "should return" do
+        array_2.jaccard_distance(array_3).should == (1 - 3.0/7.0)
+      end
+    end
+
+    describe "Jaccard Index" do
+      it "should return" do
+        array_2.jaccard_index(array_3).should == 3.0/7.0
+      end
+    end
+
+    describe "Binary Jaccard Index" do
+      it "should return 1/4" do
+        [1,1,1,1].binary_jaccard_index([0,1,0,0]).should == 1/4.0
+      end
+    end
+  end
+
+  describe "Binary Jaccard Distance" do
+    it "should return 0.75" do
+      [1,1,1,1].binary_jaccard_distance([0,1,0,0]).should == 1 - (1/4.0)
+    end
+  end
+
+  describe "Intersection" do
+    it "should return [7,4,1]" do
+      array_2.intersection_with(array_3).should == [7,4,1]
+    end
+  end
+
+  describe "Union" do
+    it "should return " do
+      array_2.union_with(array_3).should == [7,3,2,4,1,9,5]
+    end
+  end
+
+  describe "Binary Intersection" do
+    it "should return [0,1,0,0]" do
+      [1,1,1,1].binary_intersection_with([0,1,0,0]).should == [0,1,0,0]
+    end
+  end
+
+  describe "Binary Union" do
+    it "should return [1,1,1,0]" do
+      [1,1,1,0].binary_union_with([0,0,0,0]).should == [1,1,1,0]
+    end
+  end
+
+  describe "Dot Product" do
+    it "should return 50" do
+      [5, 5].dot_product([5, 5]).should == 50.0
+    end
+  end
+
+  describe "Euclidean normalize" do
+    it "should" do
+      [10].euclidean_normalize.should == 10
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'measurable'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: measurable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Carlos Agarie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: A Ruby module with a lot of distance measures for your projects.
+email: carlos@onox.com.br
+executables: []
+extensions:
+- ext/measurable/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ext/measurable/extconf.rb
+- ext/measurable/measurable.c
+- lib/measurable.rb
+- lib/measurable/cosine_similarity.rb
+- lib/measurable/haversine.rb
+- lib/measurable/jaccard.rb
+- lib/measurable/tanimoto_coefficient.rb
+- lib/measurable/version.rb
+- measurable.gemspec
+- spec/measurable.rb
+- spec/spec_helper.rb
+homepage: http://github.com/agarie/measurable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby module with a lot of distance measures for your projects.
+test_files:
+- spec/measurable.rb
+- spec/spec_helper.rb