tf_idf 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 reddavis
+
+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,33 @@
+= Tf-Idf
+
+http://en.wikipedia.org/wiki/Tf–idf
+
+== Install
+
+  gem sources -a http://gems.github.com
+  sudo gem install tf_idf
+
+== How To Use
+  require 'rubygems'
+  require 'tf_idf'
+  
+  data = ['a a a a a a a a b b', 'a a']
+  
+  # 1 is the ngram setter => http://en.wikipedia.org/wiki/N-gram
+  a = TfIdf.new(data, 1)
+  
+  # To find the term frequencies
+  a.tf
+    #=> [{'b' => 0.2, 'a' => etc...}, {'a' => 1}]
+    
+  # To find the inverse document frequency
+  a.idf
+    #=> {'b' => 0.301... etc...}
+    
+  # And to find the tf-idf
+  a.tf_idf
+    #=> [{'b' => 0.0602, 'a' => etc...}, {etc...}]
+    
+== Copyright
+
+Copyright (c) 2009 Red Davis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tf_idf"
+    gem.summary = %Q{A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf–idf}
+    gem.description = %Q{A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf–idf}
+    gem.email = "reddavis@gmail.com"
+    gem.homepage = "http://github.com/reddavis/TF-IDF"
+    gem.authors = ["reddavis"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('n_gram', ">= 0.0.0")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tf_idf #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/tf_idf.rb

@@ -0,0 +1,80 @@
+require 'n_gram'
+
+class TfIdf
+  
+  # n the n-grams of the data http://en.wikipedia.org/wiki/N-gram
+  def initialize(data, n=1)
+    @data = data
+    @n = n
+  end
+  
+  def tf
+    @tf ||= calculate_term_frequencies
+  end
+  
+  def idf
+    @idf ||= calculate_inverse_document_frequency
+  end
+  
+  # This is basically calculated by multiplying tf by idf
+  def tf_idf
+    tf_idf = tf.clone
+    
+    tf.each_with_index do |document, index|
+      document.each_pair do |term, tf_score|
+        tf_idf[index][term] = tf_score * idf[term]
+      end
+    end
+    
+    tf_idf
+  end
+  
+  def total_documents
+    @data.size.to_f
+  end
+  
+  private
+  
+  # IDF = total_documents / number_of_document_term_appears_in
+  # This calculates how important a term is.
+  def calculate_inverse_document_frequency
+    original_ngrams = n_gram.ngrams_of_all_data[@n].clone
+    
+    original_ngrams.each_key do |term|
+      
+      # Calculate how many documents the term appears in
+      count = 0.0
+      n_gram.ngrams_of_inputs.each do |document|
+        count += 1 if document[@n].key?(term)
+      end
+    
+      original_ngrams[term] = Math.log10(total_documents / count)
+    end
+    
+    original_ngrams
+  end
+  
+  # TF = number_of_n_term_in_document / number_of_terms_in_document
+  # Calculates the number of times a term appears in the document
+  # It is then normalized (as some documents are longer than others)
+  def calculate_term_frequencies
+    original_ngrams = n_gram.ngrams_of_inputs.clone
+        
+    original_ngrams.each_with_index do |document, index|
+      
+      # Calculate the total number of terms
+      total_terms = 0.0
+      document[@n].each_value {|v| total_terms += v} 
+      
+      document[@n].each_pair do |key, value|
+        original_ngrams[index][@n][key] = (value.to_f / total_terms)
+      end
+    end
+        
+    original_ngrams.map {|x| x.map {|y| y[@n] }}.flatten
+  end
+  
+  def n_gram
+    @n_gram ||= NGram.new(@data, :n => @n)
+  end  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

data/spec/tf_idf_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TfIdf" do
+  describe "Term Frequency" do
+    before do
+      @a = TfIdf.new(data, 1)
+    end
+    
+    it "should return 0.2" do
+      @a.tf[0]['b'].should == 0.2
+    end
+  end
+  
+  describe "Inverse Document Frequency" do
+    before do
+      @a = TfIdf.new(data, 1)
+    end
+    
+    it "should return 0.3010" do
+      @a.idf['b'].to_s.should match(/0.30102999/)
+    end
+  end
+  
+  before do
+    @a = TfIdf.new(data, 1)
+  end
+  
+  it "should return 0.0602" do
+    @a.tf_idf[0]['b'].to_s.should match(/0.0602/)
+  end
+
+  private
+  
+  def data
+    ['a a a a a a a a b b', 'a a']
+  end
+end

data/tf_idf.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tf_idf}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["reddavis"]
+  s.date = %q{2009-12-18}
+  s.description = %q{A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf–idf}
+  s.email = %q{reddavis@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tf_idf.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/tf_idf_spec.rb",
+     "tf_idf.gemspec"
+  ]
+  s.homepage = %q{http://github.com/reddavis/TF-IDF}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf–idf}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/tf_idf_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<n_gram>, [">= 0.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<n_gram>, [">= 0.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<n_gram>, [">= 0.0.0"])
+  end
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: tf_idf
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- reddavis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-18 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: n_gram
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: "A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf\xE2\x80\x93idf"
+email: reddavis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tf_idf.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/tf_idf_spec.rb
+- tf_idf.gemspec
+has_rdoc: true
+homepage: http://github.com/reddavis/TF-IDF
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "A TF-IDF in ruby - http://en.wikipedia.org/wiki/Tf\xE2\x80\x93idf"
+test_files: 
+- spec/spec_helper.rb
+- spec/tf_idf_spec.rb