measurable 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef813e1fecb8d7f5a5a19cf70018b3965ea34790
-  data.tar.gz: 23489086e5091bff9a868e6d167cd2b77210b030
+  metadata.gz: 78f3ee18bb4decc88988138f4a27c967d3ae56a1
+  data.tar.gz: c623b11567f78a13197f91ccc2bbf5ca19dd2f01
 SHA512:
-  metadata.gz: ea90a56d0a5dc4062b45aa8acd8536e9eb2032287d4f04080130f826aaf9bfe88ee0245899dfe5a0188f48768d690e05d9639c3e2dbefed4ba7323157775912a
-  data.tar.gz: 195c6eb734ef6b2183ceece52dc68bd68cbb316de0e26127dde3e152195ce435845b52fe965ca47546f47fa6c325cc67d065311213648a41c7bf90d0563345aa
+  metadata.gz: cb1ea8f5d14c7526955427e96d4232758b6ec94772acf5b51fdc142a4d039c3d95f83d162196431fac663b67cb90dca7e8c5c8543a8eb611d65997086d5466dc
+  data.tar.gz: 981fb532fd55a2ed1b371009fa869afeb1776096952f93f085631739c874be38a78dbd0acb16d6f4550a826e910abcc3f5474bc3166dd928b92b5da071e8d186

data/History.txt

@@ -1,3 +1,6 @@
-=== 18th May, 2014 -- Version 0.0.8
+0.0.9 -- 16th April, 2015
+  * Removed unnecessary argument length check from jaccard_index.
+  * Host documentation on rubydoc.info.
 
+0.0.8 -- 18th May, 2014
   * Added Kullback-Leibler divergence.

data/README.md

@@ -62,16 +62,7 @@ Most of the methods accept arbitrary enumerable objects instead of Arrays. For e
 
 ## Documentation
 
-`RDoc` syntax is used to document the project. To build it locally, you'll need
-to install the [Fivefish
-generator](https://github.com/ged/rdoc-generator-fivefish) (`gem install
-rdoc-generator-fivefish`) and run the following command:
-
-```bash
-rake rdoc
-```
-
-If there's something wrong with an explanation or if there's information missing, please open an issue or send a pull request.
+The documentation is hosted on [rubydoc](http://www.rubydoc.info/github/agarie/measurable).
 
 ## License
 

data/lib/measurable/chebyshev.rb

@@ -4,16 +4,13 @@ module Measurable
     # call-seq:
     #     chebyshev(u, v) -> Float
     #
-    #
-    #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - The L-infinite distance between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - The L-infinite distance between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def chebyshev(u, v)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if u.size != v.size

data/lib/measurable/cosine.rb

@@ -10,14 +10,14 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Cosine_similarity
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - The normalized dot product of +u+ and +v+, that is, the angle between
-    #     them in the n-dimensional space.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - The normalized dot product of +u+ and +v+, that is, the angle between
+    #   them in the n-dimensional space.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     #
     def cosine_similarity(u, v)
       # TODO: Change this to a more specific, custom-made exception.
@@ -35,15 +35,14 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Cosine_similarity
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - The normalized dot product of +u+ and +v+, that is, the angle between
-    #     them in the n-dimensional space.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - The normalized dot product of +u+ and +v+, that is, the angle between
+    #   them in the n-dimensional space.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def cosine_distance(u, v)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if u.size != v.size

data/lib/measurable/euclidean.rb

@@ -11,15 +11,13 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Euclidean_distance#N_dimensions
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> (Optional) An array of Numeric objects.
-    # * *Returns* :
-    #   - The euclidean norm of +u+ or the euclidean distance between +u+ and
-    #     +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> (Optional) An array of Numeric objects.
+    # Returns:
+    # - The euclidean norm of +u+ or the euclidean distance between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def euclidean(u, v = nil)
       Math.sqrt(self.euclidean_squared(u, v))
     end
@@ -38,15 +36,14 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Euclidean_distance#Squared_Euclidean_distance
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> (Optional) An array of Numeric objects.
-    # * *Returns* :
-    #   - The squared value of the euclidean norm of +u+ or of the euclidean
-    #     distance between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> (Optional) An array of Numeric objects.
+    # Returns:
+    # - The squared value of the euclidean norm of +u+ or of the euclidean
+    #   distance between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def euclidean_squared(u, v = nil)
       # If the second argument is nil, the method should return the norm of
       # vector u. For this, we need the distance between u and the origin.

data/lib/measurable/hamming.rb

@@ -10,14 +10,13 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Hamming_distance
     #
-    # * *Arguments* :
-    #   - +s1+ -> A String.
-    #   - +s2+ -> A String with the same size of +s1+.
-    # * *Returns* :
-    #   - The number of characters in which +s1+ and +s2+ differ.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +s1+ and +s2+ don't match.
-    #
+    # Arguments:
+    # - +s1+ -> A String.
+    # - +s2+ -> A String with the same size of +s1+.
+    # Returns:
+    # - The number of characters in which +s1+ and +s2+ differ.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +s1+ and +s2+ don't match.
     def hamming(s1, s2)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if s1.size != s2.size

data/lib/measurable/haversine.rb

@@ -37,17 +37,16 @@ module Measurable
     # - http://en.wikipedia.org/wiki/Haversine_formula
     # - http://en.wikipedia.org/wiki/Great-circle_distance
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    #   - +unit+ -> (Optional) A Symbol representing the unit of measure. Available
-    #               options are +:miles+, +:feet+, +:km+ and +:meters+.
-    # * *Returns* :
-    #   - The great circle distance between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The size of +u+ and +v+ must be 2.
-    #   - +ArgumentError+ -> +unit+ must be a Symbol.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # - +unit+ -> (Optional) A Symbol representing the unit of measure. Available
+    #             options are +:miles+, +:feet+, +:km+ and +:meters+.
+    # Returns:
+    # - The great circle distance between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The size of +u+ and +v+ must be 2.
+    # - +ArgumentError+ -> +unit+ must be a Symbol.
     def haversine(u, v, unit = :meters)
       # TODO: Create better exceptions.
       raise ArgumentError if u.size != 2 || v.size != 2

data/lib/measurable/jaccard.rb

@@ -11,25 +11,19 @@ module Measurable
     # cardinality of set x.
     #
     # For example:
-    #   jaccard_index([1, 0, 1], [1, 1, 1]) == 0.5
+    #   jaccard_index([1, 0], [1]) == 0.5
     #
     # Because |intersection| = |(1)| = 1 and |union| = |(0, 1)| = 2.
     #
     # See: http://en.wikipedia.org/wiki/Jaccard_coefficient
     #
-    # * *Arguments* :
-    #   - +u+ -> Array.
-    #   - +v+ -> Array.
-    # * *Returns* :
-    #   - Float value representing the Jaccard similarity coefficient between
-    #     +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The size of the input arrays doesn't match.
-    #
+    # Arguments:
+    # - +u+ -> Array.
+    # - +v+ -> Array.
+    # Returns:
+    # - Float value representing the Jaccard similarity coefficient between
+    #   +u+ and +v+.
     def jaccard_index(u, v)
-      # TODO: Change this to a more specific, custom-made exception.
-      raise ArgumentError if u.size != v.size
-
       intersection = u & v
       union = u | v
       intersection.length.to_f / union.length
@@ -48,14 +42,13 @@ module Measurable
     #   - Coincidence axiom:     jaccard(u, v) == 0 if u == v
     #   - Triangular inequality: jaccard(u, v) <= jaccard(u, w) + jaccard(w, v)
     #
-    # * *Arguments* :
-    #   - +u+ -> Array.
-    #   - +v+ -> Array.
-    # * *Returns* :
-    #   - Float value representing the dissimilarity between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The size of the input arrays doesn't match.
-    #
+    # Arguments:
+    # - +u+ -> Array.
+    # - +v+ -> Array.
+    # Returns:
+    # - Float value representing the dissimilarity between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The size of the input arrays doesn't match.
     def jaccard(u, v)
       1 - jaccard_index(u, v)
     end

data/lib/measurable/kullback_leibler.rb

@@ -20,11 +20,11 @@ module Measurable
     # - Christopher D. Manning and Hinrich Schütze. Foundations of Statistical
     #   Natural Language Processing.
     #
-    # * *Arguments*:
-    #   - +p+ -> A probability distribution represented by a n-element Array.
-    #   - +q+ -> A probability distribution represented by a n-element Array.
-    # * *Returns*:
-    #   A measure of the difference between the probability distributions p and q.
+    # Arguments:
+    # - +p+ -> A probability distribution represented by a n-element Array.
+    # - +q+ -> A probability distribution represented by a n-element Array.
+    # Returns:
+    # - A measure of the difference between the probability distributions p and q.
     def kullback_leibler(p, q)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if p.size != q.size

data/lib/measurable/levenshtein.rb

@@ -18,12 +18,11 @@ module Measurable
     #
     # See: http://en.wikipedia.org/wiki/Levenshtein_distance
     #
-    # * *Arguments* :
-    #   - +u+ -> Array or String.
-    #   - +v+ -> Array or String.
-    # * *Returns* :
-    #   - Integer value representing the Levenshtein distance between
-    #     +u+ and +v+.
+    # Arguments:
+    # - +u+ -> Array or String.
+    # - +v+ -> Array or String.
+    # Returns:
+    # - Integer value representing the Levenshtein distance between +u+ and +v+.
     #
     def levenshtein(u, v)
       return 0 if u == v

data/lib/measurable/maxmin.rb

@@ -12,14 +12,13 @@ module Measurable
     #
     # See: http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=05156398
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - Similarity between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - Similarity between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def maxmin(u, v)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if u.size != v.size

data/lib/measurable/minkowski.rb

@@ -7,14 +7,13 @@ module Measurable
     # Calculate the sum of the absolute value of the differences between each
     # coordinate of +u+ and +v+.
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - The Minkowski (or L1) distance between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - The Minkowski (or L1) distance between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def minkowski(u, v)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if u.size != v.size

data/lib/measurable/tanimoto.rb

@@ -15,14 +15,13 @@ module Measurable
     #
     # See: # http://en.wikipedia.org/wiki/Jaccard_index#Tanimoto.27s_Definitions_of_Similarity_and_Distance
     #
-    # * *Arguments* :
-    #   - +u+ -> An array of Numeric objects.
-    #   - +v+ -> An array of Numeric objects.
-    # * *Returns* :
-    #   - A measure of the similarity between +u+ and +v+.
-    # * *Raises* :
-    #   - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
-    #
+    # Arguments:
+    # - +u+ -> An array of Numeric objects.
+    # - +v+ -> An array of Numeric objects.
+    # Returns:
+    # - A measure of the similarity between +u+ and +v+.
+    # Raises:
+    # - +ArgumentError+ -> The sizes of +u+ and +v+ don't match.
     def tanimoto(u, v)
       # TODO: Change this to a more specific, custom-made exception.
       raise ArgumentError if u.size != v.size

data/lib/measurable/version.rb

@@ -1,3 +1,3 @@
 module Measurable
-  VERSION = "0.0.8" # :nodoc:
+  VERSION = "0.0.9" # :nodoc:
 end

data/measurable.gemspec

@@ -26,6 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rake', '~> 10.1'
   gem.add_development_dependency 'rdoc', '~> 4.1'
-  gem.add_development_dependency 'rspec', '~> 2.1'
-  gem.add_development_dependency 'rdoc-generator-fivefish'
+  gem.add_development_dependency 'rspec', '~> 3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: measurable
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Carlos Agarie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rdoc-generator-fivefish
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 description: A Ruby gem with a lot of distance measures for your projects.
 email: carlos.agarie@gmail.com
 executables: []
@@ -140,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby gem with a lot of distance measures for your projects.