array_metrics 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ricardo Panaggio
+
+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,45 @@
+= array_metrics
+
+A bundle of metrics for Arrays.
+
+== Installation
+
+  gem install array_metrics
+
+== Usage
+
+Metrics (will) have a lot of distance and similarity metrics implemented
+inside it.
+
+For example, to calculate the Pearson Correlarion between two Arrays
+<tt>arr1</tt> and <tt>arr2</tt>:
+
+  ArrayMetrics.cosine_similarity(arr1, arr2)
+
+== Maintainer
+
+* Ricardo Panaggio - http://panaggio.net
+
+== License
+
+(The 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/Rakefile

@@ -0,0 +1,26 @@
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/array_metrics.gemspec

@@ -0,0 +1,17 @@
+# coding: UTF-8
+
+Gem::Specification.new do |s|
+  s.name          = "array_metrics"
+  s.version       = "0.0.1"
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["Ricardo Panaggio"]
+  s.email         = ["panaggio.ricardo@gmail.com"]
+  s.homepage      = "http://github.com/panaggio/array_metrics"
+  s.summary       = "A bundle of metrics for Arrays"
+  s.description   = "A bundle (not that much by now) of metrics for Arrays"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files spec`.split("\n")
+  s.has_rdoc      = true
+  s.require_path  = 'lib'
+  s.add_runtime_dependency "rspec", "~> 2.0"
+end

data/lib/array_metrics/common.rb

@@ -0,0 +1,12 @@
+NaN = 0.0/0
+
+class Array
+  def mean
+    return 0.0 if size==0
+    self.inject(0.0){|sum,e| sum+e}.to_f/self.size
+  end
+
+  def -@
+    self.map{ |e| if e.nil? then e else -e end }
+  end
+end

data/lib/array_metrics/pearson_correlation.rb

@@ -0,0 +1,47 @@
+module ArrayMetrics
+  # Calculates the Constraint Pearson Correlation between Arrays x and y.
+  # See Shardanand and Maes 1995 for more details.
+  #
+  # Shardanand, U. and Maes, P. Social information filtering: algorithms for
+  # automating "word of mouth". In Proceedings of the SIGCHI conference on
+  # Human factors in computing systems (CHI '95). ACM Press/Addison-Wesley
+  # Publishing Co., New York, NY, USA, 210-217.
+  # DOI=10.1145/223904.223931 http://dx.doi.org/10.1145/223904.223931
+  def self.constraint_pearson_correlation(x, y, m)
+    raise "array sizes don't match" if x.size != y.size
+
+    cx, cy = [], []
+    x.each_with_index do |xi, i|
+      next if xi.nil? or y[i].nil?
+      cx << xi
+      cy << y[i]
+    end
+
+    return NaN if cx.size == 0
+
+    s = sx = sy = 0.0
+    if m.nil?
+      cx_ = cx.mean
+      cy_ = cy.mean
+    else
+      cx_ = cy_ = m
+    end
+
+    cx.each_with_index do |cxi,i|
+      px = cxi-cx_
+      py = cy[i]-cy_
+      s  += px*py
+      sx += px*px
+      sy += py*py
+    end
+
+    s/Math.sqrt(sx*sy)
+  end
+
+  # Calculates the Pearson Correlation between the Arrays x and x.
+  # See https://secure.wikimedia.org/wikipedia/en/wiki/Pearson_correlation
+  # for more details.
+  def self.pearson_correlation(x,y)
+    self.constraint_pearson_correlation(x,y,nil)
+  end
+end

data/lib/array_metrics.rb

@@ -0,0 +1,2 @@
+require "lib/array_metrics/common.rb"
+require "lib/array_metrics/pearson_correlation.rb"

data/spec/array_metrics/common_spec.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Array do
+  describe "#mean" do
+    it "should return 0 when the array is empty" do
+      [].mean.should == 0.0
+    end
+
+    it "should calculate then mean value correctly" do
+      [1,2,3].mean.should == 2.0
+      [1,2,3,4,5].mean.should == 3.0
+      arr = [0.5,1.3,4.0/3,1.7/3.12]
+      arr.mean.should be_within(0.0001).of(arr.inject(0.0){|s,e| s+e}/arr.size)
+    end
+  end
+
+  describe "#-@" do
+    it "should return the same array when there are only nil's" do
+      arr = [nil,nil,nil,nil,nil]
+      (-arr).should == arr
+    end
+
+    it "should return inverted numeric values" do
+      (-[1,2,3,-1,-2,-3]).should == [-1,-2,-3,1,2,3]
+      (-[1.0,nil,0.0,-1.0]).should == [-1.0,nil,0.0,1.0]
+    end
+  end
+end
+

data/spec/array_metrics/pearson_correlation_spec.rb

@@ -0,0 +1,194 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe ArrayMetrics do
+  arrays = [[1,2,3], [1,0,-1,nil,1000]]
+  opposite_pairs = [
+    [[1,2,3],[3,2,1]], [[1,2,3],[7,5,3]],
+    [[1,10,1,10,1],[-3,-30,-3,-30,-3]] ]
+  non_correlated_pairs = [ [[1,2,3],[1,2,1]] ]
+  generic_cases = [
+    [[1,2,3], [1,2,6],    5.0/Math.sqrt(2*14), 2,   5.0/Math.sqrt(2*17)],
+    [[1,2,3], [1,6,-1],  -2.0/Math.sqrt(2*26), 2,  -2.0/Math.sqrt(2*26)],
+    [[1,2,6], [1,6,-1], -11.0/Math.sqrt(14*26),3, -11.0/Math.sqrt(14*29)] ]
+
+  describe "#pearson_correlation" do
+    it "should return NaN when arrays have size less or equal to one" do
+      result = ArrayMetrics.pearson_correlation([],[])
+      result.should be_nan
+
+      result = ArrayMetrics.pearson_correlation([5],[1])
+      result.should be_nan
+    end
+
+    it "should return NaN when arrays have size less or equal to one, even after removing nils" do
+      result = ArrayMetrics.pearson_correlation([nil],[nil])
+      result.should be_nan
+
+      result = ArrayMetrics.pearson_correlation([nil,nil],[nil,nil])
+      result.should be_nan
+
+      result = ArrayMetrics.pearson_correlation([nil,1],[nil,5])
+      result.should be_nan
+    end
+
+    it "should return NaN when one of the arrays it homogeneous" do
+      result = ArrayMetrics.pearson_correlation([1,2,3],[1,1,1])
+      result.should be_nan
+    end
+
+    it "should raise an error when arrays size don't match" do
+      lambda do
+        ArrayMetrics.pearson_correlation([1,2],[1])
+      end.should raise_error(RuntimeError, "array sizes don't match")
+
+      lambda do
+        ArrayMetrics.pearson_correlation([1],[1,2])
+      end.should raise_error(RuntimeError, "array sizes don't match")
+    end
+
+    it "should return 1 when arrays are the same" do
+      arrays.each do |arr|
+        result = ArrayMetrics.pearson_correlation(arr,arr)
+        result.should == 1.0
+      end
+    end
+
+    it "should return -1 when arrays are the opposite from each other" do
+      arrays.each do |arr|
+        result = ArrayMetrics.pearson_correlation(arr,-arr)
+        result.should == -1.0
+      end
+
+      opposite_pairs.each do |arr1, arr2|
+        result = ArrayMetrics.pearson_correlation(arr1,arr2)
+        result.should == -1.0
+      end
+    end
+
+    it "should return 0 if arrays are not correlated" do
+      non_correlated_pairs.each do |arr1, arr2|
+        result = ArrayMetrics.pearson_correlation(arr1,arr2)
+        result.should == 0.0
+      end
+    end
+
+    it "should calculate generic cases correctly" do
+      generic_cases.each do |arr1, arr2, response, _, _|
+        result = ArrayMetrics.pearson_correlation(arr1,arr2)
+        result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should return the same value if arrays are switched (commutative property)" do
+      generic_cases.each do |arr1, arr2, response, _, _|
+        result = ArrayMetrics.pearson_correlation(arr2,arr1)
+        result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should return the same value if a constant is added to the arrays" do
+      generic_cases.each do |arr1, arr2, response, _, _|
+        result = ArrayMetrics.pearson_correlation(
+          arr1.map{|e| e+1},arr2.map{|e| e+1})
+          result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should use only positions that are both not nil in both arrays" do
+      r1 = ArrayMetrics.pearson_correlation([1,2,nil,5,nil,4], [1,nil,3,4,nil,3])
+      r2 = ArrayMetrics.pearson_correlation([1,5,4], [1,4,3])
+      r1.should be_within(0.0001).of(r2)
+    end
+  end
+
+  describe "#constraint_pearson_correlation" do
+    it "should return NaN when arrays have size equal to zero" do
+      result = ArrayMetrics.constraint_pearson_correlation([],[],3)
+      result.should be_nan
+    end
+
+    it "should return only 1, -1 or NaN when arrays have size equal to one" do
+      result = ArrayMetrics.constraint_pearson_correlation([5],[1],3)
+      result.should == -1.0
+
+      result = ArrayMetrics.constraint_pearson_correlation([1],[2],3)
+      result.should == 1.0
+
+      result = ArrayMetrics.constraint_pearson_correlation([2],[2],2)
+      result.should be_nan
+    end
+
+    it "should return NaN when arrays have size equal to one, even after removing nils" do
+      result = ArrayMetrics.constraint_pearson_correlation([nil],[nil],2)
+      result.should be_nan
+
+      result = ArrayMetrics.constraint_pearson_correlation([nil,nil],[nil,nil],3)
+      result.should be_nan
+    end
+
+    it "should return NaN when one of the arrays is homogeneous and its mean equals to m" do
+      result = ArrayMetrics.constraint_pearson_correlation([1,2,3],[1,1,1],1)
+      result.should be_nan
+    end
+
+    it "should raise an error when arrays size don't match" do
+      lambda do
+        ArrayMetrics.constraint_pearson_correlation([1,2],[1],3)
+      end.should raise_error(RuntimeError, "array sizes don't match")
+
+      lambda do
+        ArrayMetrics.constraint_pearson_correlation([1],[1,2],3)
+      end.should raise_error(RuntimeError, "array sizes don't match")
+    end
+
+    it "should return 1 when arrays are the same, even with different m's" do
+      arrays.each do |arr|
+        (0..10).to_a.each do |m|
+          result = ArrayMetrics.constraint_pearson_correlation(arr,arr,m)
+          result.should == 1.0
+        end
+      end
+    end
+
+    it "should return -1 when arrays are the opposite from each, using m as the mean" do
+      result = ArrayMetrics.constraint_pearson_correlation([1,2,3],[3,2,1],2)
+      result.should == -1.0
+    end
+
+    it "should return 0 if arrays are not correlated" do
+      result = ArrayMetrics.constraint_pearson_correlation([1,2,3],[1,2,1],2)
+      result.should == 0.0
+    end
+
+    it "should calculate generic cases correctly" do
+      generic_cases.each do |arr1, arr2, _, m, response|
+        result = ArrayMetrics.constraint_pearson_correlation(arr1,arr2,m)
+        result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should return the same value if arrays are switched (commutative property)" do
+      generic_cases.each do |arr1, arr2, _, m, response|
+        result = ArrayMetrics.constraint_pearson_correlation(arr2,arr1,m)
+        result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should return the same value if a constant is added to the arrays" do
+      generic_cases.each do |arr1, arr2, _, m, response|
+        result = ArrayMetrics.constraint_pearson_correlation(
+          arr1.map{|e| e+1},arr2.map{|e| e+1},m+1)
+          result.should be_within(0.0001).of(response)
+      end
+    end
+
+    it "should use only positions that are both not nil in both arrays" do
+      r1 = ArrayMetrics.constraint_pearson_correlation(
+        [1,2,nil,5,nil,4], [1,nil,3,4,nil,3],3)
+      r2 = ArrayMetrics.constraint_pearson_correlation(
+        [1,5,4], [1,4,3],3)
+      r1.should be_within(0.0001).of(r2)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "rubygems"
+require "rspec"
+require File.join(File.dirname(__FILE__), "../lib/array_metrics.rb" )

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: array_metrics
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ricardo Panaggio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-11 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+description: A bundle (not that much by now) of metrics for Arrays
+email: 
+- panaggio.ricardo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- array_metrics.gemspec
+- lib/array_metrics.rb
+- lib/array_metrics/common.rb
+- lib/array_metrics/pearson_correlation.rb
+- spec/array_metrics/common_spec.rb
+- spec/array_metrics/pearson_correlation_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/panaggio/array_metrics
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: A bundle of metrics for Arrays
+test_files: 
+- spec/array_metrics/common_spec.rb
+- spec/array_metrics/pearson_correlation_spec.rb
+- spec/spec_helper.rb