similar 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use ruby-1.9.3-p194@similar --create
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Scott Barr
+
+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,40 @@
+# Similar
+
+Similar is a library of functions to assist in determining the similarity
+if arbitrary sets of data.
+
+At the moment only the calculation of pearson scores is implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'similar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similar
+
+## Examples
+
+    a = [1, 2, 3]
+    b = [1, 2, 3]
+    Similar.pearson_score(a, b)
+    => 1.0
+
+    a = [1, 2, 3]
+    b = [1, 2, 5.0]
+    Similar.pearson_score(a, b)
+    => 0.9607689228305226
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/similar/version.rb

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

data/lib/similar.rb

@@ -0,0 +1,46 @@
+require "similar/version"
+
+module Similar
+
+  # Calculate the pearson score for the values in two Arrays.
+  #
+  # Each Array must contain the same number of elements.
+  def self.pearson_score(a, b)
+    n = a.length
+
+    # There is nothing to compare.
+    return 0 unless n > 0
+
+    raise ArgumentError.new("Arrays not of equal length") if n != b.length
+
+    # There is a case with pearson score, where if the two arrays
+    # are exactly the same it returns 0, when really the score should be 1.0
+    # as there is an exact correlation between the values.
+    #
+    # Zero is returned in this case because determining the difference between
+    # points shows that there is no difference at all... zero.
+    #
+    # I am returning 1.0 to show extremely high similarity.
+    return 1.0 if a == b
+
+    # sum of the values
+    sum_1 = a.inject(0) { |sum, c| sum + c }
+    sum_2 = b.inject(0) { |sum, c| sum + c }
+
+    # sum of the squares
+    sum_1_sq = a.inject(0) { |sum, c| sum + c ** 2 }
+    sum_2_sq = b.inject(0) { |sum, c| sum + c ** 2 }
+
+    # sum of the product
+    prod_sum = a.zip(b).inject(0) { |sum, ab| sum + ab[0] * ab[1] }
+
+    # calculate the Pearson score
+    num = prod_sum - (sum_1 * sum_2 / n)
+    den = Math.sqrt((sum_1_sq - (sum_1 ** 2) / n) * (sum_2_sq - (sum_2 ** 2) / n))
+
+    return 0 if den == 0
+
+    num / den.to_f
+  end
+
+end

data/similar.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'similar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "similar"
+  gem.version       = Similar::VERSION
+  gem.authors       = ["Scott Barr"]
+  gem.email         = ["scottjbarr@gmail.com"]
+  gem.description   = <<-EOF
+    Similar is a library of functions to assist in determining the similarity
+    if arbitrary sets of data.
+  EOF
+  gem.summary       = %q{Determine similarity of arbitrary sets of data}
+  gem.homepage      = "http://scottjbarr.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rspec-core'
+  gem.add_development_dependency 'rspec-expectations'
+  gem.add_development_dependency 'rspec-mocks'
+  gem.add_development_dependency 'autotest'
+  gem.add_development_dependency 'autotest-fsevent'
+  gem.add_development_dependency 'autotest-growl'
+  gem.add_development_dependency 'builder'
+end

data/spec/similar_spec.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe Similar do
+
+  it "should not calculate pearson score when nothing to compare" do
+    score = Similar.pearson_score([], [])
+    score.should == 0
+  end
+
+  it "should calculate pearson score" do
+    a = [2.5, 3.5, 3.0, 3.5, 3.0, 2.5]
+    b = [3.0, 3.5, 1.5, 5.0, 3.0, 3.5]
+
+    score = Similar.pearson_score(a, b)
+    score.should be_within(0.00001).of(0.39605901719066977)
+  end
+
+  it "should raise an exception when calculating pearson score with different array lengths" do
+    a = [2.5, 3.5]
+    b = [3.0]
+
+    lambda { Similar.pearson_score(a, b) }.should raise_exception(ArgumentError, "Arrays not of equal length")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'similar'

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: similar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Scott Barr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-core
+  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: rspec-expectations
+  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: rspec-mocks
+  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: autotest
+  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: autotest-fsevent
+  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: autotest-growl
+  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: builder
+  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'
+description: ! "    Similar is a library of functions to assist in determining the
+  similarity\n    if arbitrary sets of data.\n"
+email:
+- scottjbarr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/similar.rb
+- lib/similar/version.rb
+- similar.gemspec
+- spec/similar_spec.rb
+- spec/spec_helper.rb
+homepage: http://scottjbarr.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Determine similarity of arbitrary sets of data
+test_files:
+- spec/similar_spec.rb
+- spec/spec_helper.rb