tf-idf-similarity 0.0.7 → 0.0.8

data/README.md

@@ -16,17 +16,13 @@ Calculates the similarity between texts using a [bag-of-words](http://en.wikiped
 
     p corpus.similarity_matrix
 
-This gem will use the [gsl gem](http://rb-gsl.rubyforge.org/) if available, for faster matrix multiplication.
-
 ## Optimizations
 
-### [NArray](http://narray.rubyforge.org/)
-
-    gem install narray
+This gem will use the first available library below, for faster matrix multiplication.
 
 ### [GNU Scientific Library (GSL)](http://www.gnu.org/software/gsl/)
 
-The latest `gsl` gem (`1.14.7`) is [not compatible](http://bretthard.in/2012/03/getting-related_posts-lsi-and-gsl-to-work-in-jekyll/) with the `gsl` package (`1.15`) in Homebrew:
+The latest [gsl gem](http://rb-gsl.rubyforge.org/) (`1.14.7`) is [not compatible](http://bretthard.in/2012/03/getting-related_posts-lsi-and-gsl-to-work-in-jekyll/) with the `gsl` package (`1.15`) in Homebrew:
 
 ```sh
 cd /usr/local
@@ -34,16 +30,23 @@ git checkout -b gsl-1.14 83ed49411f076e30ced04c2cbebb054b2645a431
 brew install gsl
 git checkout master
 git branch -d gsl-1.14
-gem install gsl
 ```
 
+Be careful not to upgrade `gsl` to `1.15` with `brew upgrade outdated`. You can now run:
+
+    gem install gsl --no-ri --no-rdoc
+
+### [NArray](http://narray.rubyforge.org/)
+
+    gem install narray
+
 ### [Automatically Tuned Linear Algebra Software (ATLAS)](http://math-atlas.sourceforge.net/)
 
-You may know this software through [Linear Algebra PACKage (LAPACK)](http://www.netlib.org/lapack/) or [Basic Linear Algebra Subprograms (BLAS)](http://www.netlib.org/blas/). You can use it through version `0.0.2` of the [nmatrix gem](https://github.com/SciRuby/nmatrix). As of writing, `0.0.2` is not released, so follow [these instructions](https://github.com/SciRuby/nmatrix#synopsis) to install it. You may need [additional instructions for Mac OS X Lion](https://github.com/SciRuby/nmatrix/wiki/NMatrix-Installation).
+You may know this software through [Linear Algebra PACKage (LAPACK)](http://www.netlib.org/lapack/) or [Basic Linear Algebra Subprograms (BLAS)](http://www.netlib.org/blas/). You can use it through the next release (after `0.0.2`) of the [nmatrix gem](https://github.com/SciRuby/nmatrix). Follow [these instructions](https://github.com/SciRuby/nmatrix#synopsis) to install it. You may need [additional instructions for Mac OS X Lion](https://github.com/SciRuby/nmatrix/wiki/NMatrix-Installation).
 
 ### Other Options
 
-The [nmatrix](http://sciruby.com/nmatrix/) gem has no easy way to normalize all columns to unit vectors. [Ruby-LAPACK](http://ruby.gfd-dennou.org/products/ruby-lapack/) is a very thin wrapper around LAPACK, which has an opaque Fortran-style naming scheme. [Linalg](https://github.com/quix/linalg) and [RNum](http://rnum.rubyforge.org/) are old and not available as gems.
+[Ruby-LAPACK](http://ruby.gfd-dennou.org/products/ruby-lapack/) is a very thin wrapper around LAPACK, which has an opaque Fortran-style naming scheme. [Linalg](https://github.com/quix/linalg) and [RNum](http://rnum.rubyforge.org/) are old and not available as gems.
 
 ## Extras
 

data/lib/tf-idf-similarity/collection.rb

@@ -10,6 +10,8 @@ rescue LoadError
 end
 
 class TfIdfSimilarity::Collection
+  class CollectionError < StandardError; end
+
   # The documents in the collection.
   attr_reader :documents
   # The number of times each term appears in all documents.
@@ -46,6 +48,11 @@ class TfIdfSimilarity::Collection
   # @see http://en.wikipedia.org/wiki/Cosine_similarity
   # @see http://en.wikipedia.org/wiki/Okapi_BM25
   def similarity_matrix(opts = {})
+    if documents.empty?
+      raise CollectionError, "No documents in collection"
+    end
+
+    # Calculate tf*idf.
     if stdlib?
       idf = []
       matrix = Matrix.build(terms.size, documents.size) do |i,j|
@@ -67,13 +74,13 @@ class TfIdfSimilarity::Collection
           end
         end
       end
-
-      # Columns are normalized to unit vectors, so we can calculate the cosine
-      # similarity of all document vectors. BM25 doesn't normalize columns, but
-      # BM25 wasn't written with this use case in mind.
-      matrix = normalize matrix
     end
 
+    # Columns are normalized to unit vectors, so we can calculate the cosine
+    # similarity of all document vectors. BM25 doesn't normalize columns, but
+    # BM25 wasn't written with this use case in mind.
+    matrix = normalize matrix
+
     if nmatrix?
       matrix.transpose.dot matrix
     else
@@ -122,6 +129,10 @@ class TfIdfSimilarity::Collection
 
   # @return [Float] the average document size, in terms
   def average_document_size
+    if documents.empty?
+      raise CollectionError, "No documents in collection"
+    end
+
     @average_document_size ||= documents.map(&:size).reduce(:+) / documents.size.to_f
   end
 
@@ -134,7 +145,7 @@ class TfIdfSimilarity::Collection
   end
 
   # @param [Document] matrix a term-document matrix
-  # @return [Matrix] a matrix in which all document vectors are unit vectors
+  # @return [GSL::Matrix,NMatrix,Matrix] a matrix in which all document vectors are unit vectors
   #
   # @note Lucene normalizes document length differently.
   def normalize(matrix)
@@ -144,6 +155,7 @@ class TfIdfSimilarity::Collection
       # @see https://github.com/masa16/narray/issues/21
       NMatrix.refer matrix / NMath.sqrt((matrix ** 2).sum(1).reshape(documents.size, 1))
     elsif nmatrix?
+      # @see https://github.com/SciRuby/nmatrix/issues/38
       # @todo NMatrix has no way to perform scalar operations on matrices.
       # (0...matrix.shape[0]).each do |i|
       #   column = matrix.slice i, 0...matrix.shape[1]

data/lib/tf-idf-similarity/version.rb

@@ -1,3 +1,3 @@
 module TfIdfSimilarity
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tf-idf-similarity
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -106,4 +106,3 @@ signing_key:
 specification_version: 3
 summary: Calculates the similarity between texts using tf*idf
 test_files: []
-has_rdoc: