sooth 1.0.3 → 2.0.0

data/spec/predictor_spec.rb

@@ -3,176 +3,214 @@ require 'tempfile'
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Sooth::Predictor do
-  let(:predictor) { Sooth::Predictor.new(42) }
+  let(:error_event) { 42 }
+  let(:predictor) { Sooth::Predictor.new(error_event) }
 
   describe "#observe" do
-    it "increments observation counts" do
-      expect(predictor.observe([1,2], 3)).to eq(1)
-      expect(predictor.observe([1,2], 3)).to eq(2)
-      expect(predictor.observe([1,2], 3)).to eq(3)
+    it "increments counts" do
+      expect(predictor.observe(1, 3)).to eq(1)
+      expect(predictor.observe(1, 3)).to eq(2)
+      expect(predictor.observe(1, 3)).to eq(3)
     end
 
-    it "properly sorts and finds bigrams" do
-      expect(predictor.observe([2,1], 3)).to eq(1)
-      expect(predictor.observe([1,3], 2)).to eq(1)
-      expect(predictor.observe([3,2], 1)).to eq(1)
-      expect(predictor.observe([1,3], 2)).to eq(2)
-      expect(predictor.observe([2,1], 3)).to eq(2)
-      expect(predictor.observe([3,2], 1)).to eq(2)
+    it "sorts and finds contexts" do
+      expect(predictor.observe(2, 3)).to eq(1)
+      expect(predictor.observe(1, 2)).to eq(1)
+      expect(predictor.observe(3, 1)).to eq(1)
+      expect(predictor.observe(1, 2)).to eq(2)
+      expect(predictor.observe(2, 3)).to eq(2)
+      expect(predictor.observe(3, 1)).to eq(2)
     end
   end
 
   describe "#count" do
-    it "returns a zero count for an unobserved bigram" do
-      expect(predictor.count([1,2])).to eq(0)
+    it "returns zero for an unobserved context" do
+      expect(predictor.count(1)).to eq(0)
     end
 
-    it "returns the total count for an observed bigram" do
-      predictor.observe([1,2], 2)
-      predictor.observe([1,2], 1)
-      predictor.observe([1,2], 4)
-      predictor.observe([1,2], 3)
-      predictor.observe([1,2], 0)
-      predictor.observe([1,2], 1)
-      predictor.observe([1,2], 4)
-      expect(predictor.count([1,2])).to eq(7)
+    it "returns the number of observations" do
+      predictor.observe(1, 2)
+      predictor.observe(1, 1)
+      predictor.observe(1, 4)
+      predictor.observe(1, 3)
+      predictor.observe(1, 0)
+      predictor.observe(1, 1)
+      predictor.observe(1, 4)
+      expect(predictor.count(1)).to eq(7)
     end
   end
 
+  describe "#size" do
+    it "returns zero for an unobserved context" do
+      expect(predictor.size(1)).to eq(0)
+    end
+
+    it "returns the number of distinct events" do
+      predictor.observe(1, 2)
+      predictor.observe(1, 1)
+      predictor.observe(1, 4)
+      predictor.observe(1, 3)
+      predictor.observe(1, 0)
+      predictor.observe(1, 1)
+      predictor.observe(1, 4)
+      expect(predictor.size(1)).to eq(5)
+    end
+
+  end
+
   describe "#select" do
-    it "returns the error symbol for an unobserved bigram" do
-      expect(predictor.select([1,2], 1)).to eq(42)
-    end
-
-    it "returns the correct symbol for an observed bigram" do
-      predictor.observe([1,2], 4)
-      predictor.observe([1,2], 3)
-      predictor.observe([1,2], 4)
-      predictor.observe([1,2], 5)
-      expect(predictor.select([1,2], 1)).to eq(3)
-      expect(predictor.select([1,2], 2)).to eq(4)
-      expect(predictor.select([1,2], 3)).to eq(4)
-      expect(predictor.select([1,2], 4)).to eq(5)
-    end
-
-    it "returns the error symbol for a limit that is out of range" do
-      predictor.observe([1,2], 4)
-      predictor.observe([1,2], 3)
-      predictor.observe([1,2], 5)
-      expect(predictor.select([1,2], 0)).to eq(42)
-      expect(predictor.select([1,2], 4)).to eq(42)
-    end
-
-    it "selects the correct symbol with many contexts" do
-      predictor.observe([2,1], 4)
-      predictor.observe([1,3], 5)
-      predictor.observe([3,2], 6)
-      predictor.observe([1,3], 7)
-      predictor.observe([2,1], 8)
-      predictor.observe([3,2], 9)
-      predictor.observe([1,3], 1)
-      predictor.observe([2,1], 2)
-      predictor.observe([3,2], 3)
-      expect(predictor.select([2,1], 0)).to eq(42)
-      expect(predictor.select([2,1], 1)).to eq(2)
-      expect(predictor.select([2,1], 2)).to eq(4)
-      expect(predictor.select([2,1], 3)).to eq(8)
-      expect(predictor.select([2,1], 4)).to eq(42)
-      expect(predictor.select([1,3], 0)).to eq(42)
-      expect(predictor.select([1,3], 1)).to eq(1)
-      expect(predictor.select([1,3], 2)).to eq(5)
-      expect(predictor.select([1,3], 3)).to eq(7)
-      expect(predictor.select([1,3], 4)).to eq(42)
-      expect(predictor.select([3,2], 0)).to eq(42)
-      expect(predictor.select([3,2], 1)).to eq(3)
-      expect(predictor.select([3,2], 2)).to eq(6)
-      expect(predictor.select([3,2], 3)).to eq(9)
-      expect(predictor.select([3,2], 4)).to eq(42)
+    it "returns the error event for an unobserved context" do
+      expect(predictor.select(1, 1)).to eq(error_event)
+    end
+
+    it "returns the correct event for an observed context" do
+      predictor.observe(1, 4)
+      predictor.observe(1, 3)
+      predictor.observe(1, 4)
+      predictor.observe(1, 5)
+      expect(predictor.select(1, 1)).to eq(3)
+      expect(predictor.select(1, 2)).to eq(4)
+      expect(predictor.select(1, 3)).to eq(4)
+      expect(predictor.select(1, 4)).to eq(5)
+    end
+
+    it "returns the error event for a limit that is out of range" do
+      predictor.observe(1, 4)
+      predictor.observe(1, 3)
+      predictor.observe(1, 5)
+      expect(predictor.select(1, 0)).to eq(error_event)
+      expect(predictor.select(1, 4)).to eq(error_event)
+    end
+
+    it "selects the correct event with many contexts" do
+      predictor.observe(2, 4)
+      predictor.observe(1, 5)
+      predictor.observe(3, 6)
+      predictor.observe(1, 7)
+      predictor.observe(2, 8)
+      predictor.observe(3, 9)
+      predictor.observe(1, 1)
+      predictor.observe(2, 2)
+      predictor.observe(3, 3)
+      expect(predictor.select(2, 0)).to eq(error_event)
+      expect(predictor.select(2, 1)).to eq(2)
+      expect(predictor.select(2, 2)).to eq(4)
+      expect(predictor.select(2, 3)).to eq(8)
+      expect(predictor.select(2, 4)).to eq(error_event)
+      expect(predictor.select(1, 0)).to eq(error_event)
+      expect(predictor.select(1, 1)).to eq(1)
+      expect(predictor.select(1, 2)).to eq(5)
+      expect(predictor.select(1, 3)).to eq(7)
+      expect(predictor.select(1, 4)).to eq(error_event)
+      expect(predictor.select(3, 0)).to eq(error_event)
+      expect(predictor.select(3, 1)).to eq(3)
+      expect(predictor.select(3, 2)).to eq(6)
+      expect(predictor.select(3, 3)).to eq(9)
+      expect(predictor.select(3, 4)).to eq(error_event)
     end
   end
 
   describe "#clear" do
-
-    it "clears to a blank slate" do
-      expect(predictor.observe([1,2], 3)).to eq(1)
-      expect(predictor.observe([1,2], 3)).to eq(2)
-      expect(predictor.observe([1,2], 3)).to eq(3)
+    it "resets to a blank slate" do
+      expect(predictor.observe(1, 3)).to eq(1)
+      expect(predictor.observe(1, 3)).to eq(2)
+      expect(predictor.observe(1, 3)).to eq(3)
       predictor.clear
-      expect(predictor.observe([1,2], 3)).to eq(1)
-      expect(predictor.observe([1,2], 3)).to eq(2)
-      expect(predictor.observe([1,2], 3)).to eq(3)
+      expect(predictor.observe(1, 3)).to eq(1)
+      expect(predictor.observe(1, 3)).to eq(2)
+      expect(predictor.observe(1, 3)).to eq(3)
     end
-
   end
 
   describe "#save" do
-
     it "can save a file and load it back again" do
       begin
         file = Tempfile.new('sooth_spec')
-        expect(predictor.observe([1,2], 3)).to eq(1)
-        expect(predictor.observe([2,1], 3)).to eq(1)
-        expect(predictor.observe([1,2], 3)).to eq(2)
-        expect(predictor.observe([1,2], 3)).to eq(3)
+        expect(predictor.observe(1, 3)).to eq(1)
+        expect(predictor.observe(2, 3)).to eq(1)
+        expect(predictor.observe(1, 3)).to eq(2)
+        expect(predictor.observe(1, 3)).to eq(3)
         expect { predictor.save(file.path) } .to_not raise_error
-        expect(predictor.count([1,2])).to eq(3)
-        expect(predictor.count([2,1])).to eq(1)
+        expect(predictor.count(1)).to eq(3)
+        expect(predictor.count(2)).to eq(1)
         predictor.clear
-        expect(predictor.count([1,2])).to eq(0)
-        expect(predictor.count([2,1])).to eq(0)
+        expect(predictor.count(1)).to eq(0)
+        expect(predictor.count(2)).to eq(0)
         expect { predictor.load(file.path) }.to_not raise_error
-        expect(predictor.count([1,2])).to eq(3)
-        expect(predictor.count([2,1])).to eq(1)
-        expect(predictor.observe([1,2], 3)).to eq(4)
-        expect(predictor.observe([1,2], 1)).to eq(1)
-        expect(predictor.observe([2,1], 3)).to eq(2)
-        expect(predictor.observe([2,1], 1)).to eq(1)
+        expect(predictor.count(1)).to eq(3)
+        expect(predictor.count(2)).to eq(1)
+        expect(predictor.observe(1, 3)).to eq(4)
+        expect(predictor.observe(1, 1)).to eq(1)
+        expect(predictor.observe(2, 3)).to eq(2)
+        expect(predictor.observe(2, 1)).to eq(1)
       ensure
         file.close
         file.unlink
       end
     end
+  end
 
+  describe "#distribution" do
+    it "can iterate over a distribution" do
+    end
   end
 
-  describe "#uncertainty" do
+  describe "#distribution" do
+    it "has no distribution for a new context" do
+      expect(predictor.distribution(1)).to be_nil
+      expect(predictor.count(1)).to eq(0)
+      expect(predictor.uncertainty(1)).to be_nil
+    end
+
+    it "has a correct probability distribution" do
+      predictor.observe(1, 4)
+      predictor.observe(1, 2)
+      predictor.observe(1, 4)
+      predictor.observe(1, 3)
+      dist = Hash[predictor.distribution(1)]
+      expect(dist[1]).to be_nil
+      expect(dist[2]).to eq(0.25)
+      expect(dist[3]).to eq(0.25)
+      expect(dist[4]).to eq(0.5)
+    end
+  end
 
+  describe "#uncertainty" do
     it "has no uncertainty for a new context" do
-      expect(predictor.uncertainty([1, 2])).to be_nil 
-      expect(predictor.count([1, 2])).to eq(0) 
-      expect(predictor.uncertainty([1, 2])).to be_nil 
+      expect(predictor.uncertainty(1)).to be_nil 
+      expect(predictor.count(1)).to eq(0) 
+      expect(predictor.uncertainty(1)).to be_nil 
     end
 
     it "has zero uncertainty for a lone context" do
-      predictor.observe([1, 2], 3)
-      expect(predictor.uncertainty([1, 2])).to eq(0) 
+      predictor.observe(1, 3)
+      expect(predictor.uncertainty(1)).to eq(0) 
     end
 
     it "has maximal uncertainty for a uniform distribution" do
-      (1..256).each { |i| predictor.observe([1, 2], i) }
-      expect(predictor.uncertainty([1, 2])).to eq(8) 
+      (1..256).each { |i| predictor.observe(1, i) }
+      expect(predictor.uncertainty(1)).to eq(8) 
     end
-
   end
 
   describe "#surprise" do
+    it "has no surprise for a new context" do
+      expect(predictor.surprise(1, 3)).to be_nil 
+    end
 
-    it "has no surprise for a new context or symbol" do
-      expect(predictor.surprise([1, 2], 3)).to be_nil 
-      expect(predictor.count([1, 2])).to eq(0) 
-      expect(predictor.surprise([1, 2], 3)).to be_nil 
+    it "has no surprise for a new event" do
+      predictor.observe(1, 3)
+      expect(predictor.surprise(1, 4)).to be_nil 
     end
 
-    it "has zero surprise for a lone context" do
-      predictor.observe([1, 2], 3)
-      expect(predictor.surprise([1, 2], 3)).to eq(0) 
+    it "has zero surprise for a lone event" do
+      predictor.observe(1, 3)
+      expect(predictor.surprise(1, 3)).to eq(0) 
     end
 
     it "has uniform surprise for a uniform distribution" do
-      (1..256).each { |i| predictor.observe([1, 2], i) }
-      expect(predictor.surprise([1, 2], 3)).to eq(8) 
+      (1..256).each { |i| predictor.observe(1, i) }
+      expect(predictor.surprise(1, 3)).to eq(8) 
     end
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sooth
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Hutchens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-03 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '8.2'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -142,7 +142,6 @@ executables: []
 extensions:
 - ext/sooth_native/extconf.rb
 extra_rdoc_files:
-- CHANGELOG.md
 - README.md
 files:
 - CHANGELOG.md
@@ -183,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sooth is a simple stochastic predictive model.