shannon 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a785eb641f59864a30cbe70af13fed8973aa15e8
-  data.tar.gz: d046287d885f8ebd7b1955e13106d972768161bd
+  metadata.gz: 0fe3e4bfd4d9dc1ccb4176e8ecd3c9c59ec95c9c
+  data.tar.gz: c0376d1e4fa8a782e822c91c14d0de62d6b64377
 SHA512:
-  metadata.gz: a7b3ec3d2a94a77c45e2f6066f81fe32d9cede96571955666a62ddb92632895cc40d05c8c807e7dff40306e75eb2e9c51a26d60f7d3ae7b505191f6790540e84
-  data.tar.gz: 742743849f8980bdf5dd5ceb6f03d11ee088dcccc04141691c02eb22326f084fabdcb8a93caf0ac6b423fd7117bdc7d9cfb276edad6ca8d8d06e0f56967c6f01
+  metadata.gz: 16ce694d891fabf947080099c25860d4182529c2b8855c3d72c1a9af8d24b3326c00ecddbca24777cf747a79795753094ee8ba1f35b8e63319cf310a4ec7aa05
+  data.tar.gz: 88883fb94270e8106fed261fcfa20edcba11546e4c68e2aa7ce50ad4d262bc053e7089a71da27de484bc79ce1f45ea3b16807980fa5420f56ac3b40028633680

data/.gitignore

@@ -8,5 +8,7 @@
 /spec/reports/
 /tmp/
 
+profile
+
 # rspec failure tracking
 .rspec_status

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017 Ryan Moore
+
+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

@@ -23,11 +23,13 @@ Or install it yourself as:
 ```ruby
 require "shannon"
 
-Shannon.entropy "aaaa" #=> 0
-Shannon.entropy("abcde").round 4 #=> 2.3219
-Shannon.entropy "" #=> nil
+Shannon::entropy ""               #=> 0
+Shannon::entropy "aaaa"           #=> 0
+Shannon::entropy("abcde").round 4 #=> 2.3219
 ```
 
+It uses base 2 for the log by default, so `Shannon::entropy "abcde"` and `Shannon::entropy "abcde", 2` will give the same answer.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/shannon.rb

@@ -1,31 +1,21 @@
 require "shannon/version"
 
 module Shannon
-  def self.char_counts str
-    counts = Hash.new 0
 
-    str.each_char do |char|
-      counts[char] += 1
-    end
+  # Calculate Shannon entropy for a string.
+  #
+  # @example
+  #   Shannon::entropy("abcde", 2).round(4) #=> 2.3219
+  #
+  # @param str [String] string to calculate entropy of
+  # @param base [Fixnum] base of the log for calculation
+  def self.entropy str, base=2
+    len = str.length.to_f
 
-    counts
-  end
-
-  def self.char_probs str
-    counts = self.char_counts str
-
-    counts.values.map { |count| count / str.length.to_f }
-  end
-
-  def self.probs_to_entropy probs
-    - probs.reduce(0.0) { |sum, prob| sum += prob * Math.log2(prob) }
-  end
-
-  def self.entropy str
-    if str.empty?
-      nil
-    else
-      self.probs_to_entropy self.char_probs(str)
-    end
+    str.each_char.
+      group_by(&:itself).
+      values.
+      map { |ary| ary.length / len }.
+      reduce(0) { |entropy, freq| entropy - freq * Math.log(freq, base) }
   end
 end

data/lib/shannon/version.rb

@@ -1,3 +1,3 @@
 module Shannon
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/shannon.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shannon
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryan Moore
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
 description: Simple gem to calculate Shannon entropy.
 email:
 - moorer@udel.edu
@@ -64,6 +78,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console