diverge 1.1.0 → 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91446f47cea184ffd150c7ea2c8970be6d44a1fa
+  data.tar.gz: 9532bd8926e032f158c2d9edb8c718af5db32825
+SHA512:
+  metadata.gz: d7843f4c6121463c566d5728ce85daad3bc927b66917f93d31614c7320420a682e0c7485102465a13a4c33cf3ca867d6b359ed5fecae8508d5eb43fe3f094885
+  data.tar.gz: e43438b427a8282098ee472fd9e80e2acc2078392179b3ca1c744dfad8249a32eca8b250b7d21310958d021afac33a367a21546f749a66c3ab987df9b18a8097

data/README.md

@@ -2,18 +2,20 @@
 
 Diverge is a very simple class for calculating the Kullback–Leibler divergence or Jensen–Shannon divergence of two datasets. Example usage is as follows:
 
- 1.9.3p194 :001 > require "diverge"
- => true 
- 1.9.3p194 :002 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).kl
- => 0.1379119045715615 
- 1.9.3p194 :003 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).kl(:reverse)
- => 0.14869719288733346 
- 1.9.3p194 :004 > Diverge.new([0.5, 0.3, 0.2], [0.25, 0.5, 0.25]).kl
- => 0.14869719288733346 
- 1.9.3p194 :005 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).js
- => 0.14330454872944748 
- 1.9.3p194 :006 > Diverge.new([0.5, 0.3, 0.2], [0.25, 0.5, 0.25]).js
- => 0.14330454872944748
+    1.9.3p194 :001 > require "diverge"
+    => true 
+    1.9.3p194 :002 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).kl # Kullback-Leibler
+    => 0.1379119045715615 
+    1.9.3p194 :003 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).kl(:reverse)
+    => 0.14869719288733346 
+    1.9.3p194 :004 > Diverge.new([0.5, 0.3, 0.2], [0.25, 0.5, 0.25]).kl
+    => 0.14869719288733346 
+    1.9.3p194 :005 > Diverge.new([0.25, 0.5, 0.25], [0.5, 0.3, 0.2]).js # Jensen-Shannon
+    => 0.14330454872944748 
+    1.9.3p194 :006 > Diverge.new([0.5, 0.3, 0.2], [0.25, 0.5, 0.25]).js
+    => 0.14330454872944748
+    1.9.3p194 :006 > Diverge.new([0.5, 0.3, 0.2], [0.25, 0.5, 0.25]).corr # Pearson correlation
+    => -0.18898223650461368
 
 http://rubygems.org/gems/diverge
 

data/lib/diverge.rb

@@ -1,21 +1,27 @@
 require "gsl"
 
 class Diverge
+  class << self
+    attr_accessor :debug
+  end
+  
+  @debug = true
+  
   attr_reader :p, :q
   
   def initialize(p, q)
     @p, @q = p, q
     
     unless p.length == q.length
-      raise ArgumentError.new("The two discrete distributions must have the same number of elements") 
+      debugger { "The two discrete distributions must have the same number of elements" }
     end
     
     unless (p_sum = p.inject(&:+)) == 1
-      STDERR.puts("Warning: the first argument does not sum to 1, the sum is #{p_sum}")
+      debugger { "Warning: the first argument does not sum to 1, the sum is #{p_sum.inspect}" }
     end
     
     unless (q_sum = q.inject(&:+)) == 1
-      STDERR.puts("Warning: the second argument does not sum to 1, the sum is #{q_sum}")
+      debugger { "Warning: the second argument does not sum to 1, the sum is #{q_sum.inspect}" }
     end
   end
   
@@ -48,4 +54,18 @@ class Diverge
   end
   
   alias :corr :correlation
+  
+  def debug
+    self.class.debug
+  end
+  
+  def debug=(value)
+    self.class.debug = value
+  end
+  
+  private
+  
+  def debugger
+    STDERR.puts yield if debug
+  end
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: diverge
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.1.1
 platform: ruby
 authors:
 - Evan Senter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gsl
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.14.0
 description: A simple collection of functions for determining the divergence between
@@ -39,27 +36,25 @@ files:
 - README.md
 homepage: http://rubygems.org/gems/diverge
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Distribution divergences.
 test_files: []
-has_rdoc: