sooth 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52d3347ee6806fdb75d4ede666c0c6571fb8f32393f459765b45660adc79e13
-  data.tar.gz: 2571b62383a6751b6709814b262779d73e3259853644856f3ff20d34f44f7698
+  metadata.gz: b9781b968536658207c18020248b92095f274aeb01b66f8a2b161b63fe355792
+  data.tar.gz: 17c1f18642aade6f2ab2906799f5c5a85cb4b0e1f9c674ae8ed5a071a047640a
 SHA512:
-  metadata.gz: 3069f1da2d2bbdb6a856704503be13b92f1998d1c8fda7cdfc75fe0ca8c700d67c47de97c0590425dbd83a78b895ab0fa45dd576851e492ec3320c2454b03de1
-  data.tar.gz: dac4c0bad6f63069b59e9665e33a0cae791271d649c507da0e19811e2841d42fac4c361bdc6915b0320897ea9d50d4b37046a90991b00e8882f1463c2b2b7c56
+  metadata.gz: f9e0fcf793b1d09119952574a1731551c55b9b3aa7b1e1b7a4edb53ea11af319fa643c52dfbf89d23bfc8cfd1a92841200fcc3a7940b945dc8a7a2744f9aa415
+  data.tar.gz: 0f59f8ee384cd5ddedf6450c6b3b85f123428737dbd411a6ce982331e949eefc4b868d8da084cab6245ac32d0cea53ae4d88a778ccec90bc2a8531ff5d16ec4f

data/VERSION

@@ -1 +1 @@
-2.1.2
+2.2.0

data/ext/sooth_native/native.c

@@ -43,7 +43,10 @@ void method_sooth_native_deallocate(void * predictor);
  *       def uncertainty(context)
  *         # (native code)
  *       end
- *       def surprise(context, evemt)
+ *       def surprise(context, event)
+ *         # (native code)
+ *       end
+ *       def frequency(context, event)
  *         # (native code)
  *       end
  *     end
@@ -159,6 +162,16 @@ VALUE method_sooth_native_uncertainty(VALUE self, VALUE context);
  */
 VALUE method_sooth_native_surprise(VALUE self, VALUE bigram, VALUE limit);
 
+/*
+ * Return a number indicating the frequency that the event has been observed
+ * within the given context.
+ *
+ * @param [Fixnum] context A number that provides a context for observations.
+ * @param [Fixnum] event A number representing the observed event.
+ * @return [Float] The frequency, as a number between 0.0 and 1.0
+ */
+VALUE method_sooth_native_frequency(VALUE self, VALUE bigram, VALUE limit);
+
 //------------------------------------------------------------------------------
 
 void Init_sooth_native()
@@ -181,6 +194,7 @@ void Init_sooth_native()
   rb_define_method(SoothNative, "distribution", method_sooth_native_distribution, 1);
   rb_define_method(SoothNative, "uncertainty", method_sooth_native_uncertainty, 1);
   rb_define_method(SoothNative, "surprise", method_sooth_native_surprise, 2);
+  rb_define_method(SoothNative, "frequency", method_sooth_native_frequency, 2);
 }
 
 //------------------------------------------------------------------------------
@@ -368,4 +382,16 @@ method_sooth_native_surprise(VALUE self, VALUE context, VALUE event)
   return DBL2NUM(surprise);
 }
 
+//------------------------------------------------------------------------------
+
+VALUE
+method_sooth_native_frequency(VALUE self, VALUE context, VALUE event)
+{
+  SoothPredictor * predictor = NULL;
+  Check_Type(context, T_FIXNUM);
+  Check_Type(event, T_FIXNUM);
+  Data_Get_Struct(self, SoothPredictor, predictor);
+  return DBL2NUM(sooth_predictor_frequency(predictor, NUM2UINT(context), NUM2UINT(event)));
+}
+
 //==============================================================================

data/ext/sooth_native/sooth_predictor.c

@@ -406,4 +406,26 @@ sooth_predictor_surprise(SoothPredictor * predictor, uint32_t id, uint32_t event
   return -log2(frequency);
 }
 
+//------------------------------------------------------------------------------
+
+double
+sooth_predictor_frequency(SoothPredictor * predictor, uint32_t id, uint32_t event)
+{
+  SoothContext * context = sooth_predictor_find_context(predictor, id);
+
+  if (context == NULL || context->count == 0)
+  {
+    return 0.0;
+  }
+
+  SoothStatistic * statistic = sooth_predictor_find_statistic(context, event);
+
+  if (statistic == NULL || statistic->count == 0)
+  {
+    return 0.0;
+  }
+
+  return (double)statistic->count / (double)context->count;
+}
+
 //==============================================================================

data/ext/sooth_native/sooth_predictor.h

@@ -30,6 +30,7 @@ uint32_t sooth_predictor_select(SoothPredictor * predictor, uint32_t id, uint32_
 SoothStatistic * sooth_predictor_distribution(SoothPredictor * predictor, uint32_t id);
 double sooth_predictor_uncertainty(SoothPredictor * predictor, uint32_t id);
 double sooth_predictor_surprise(SoothPredictor * predictor, uint32_t id, uint32_t symbol);
+double sooth_predictor_frequency(SoothPredictor * predictor, uint32_t id, uint32_t symbol);
 
 //==============================================================================
 

data/sooth.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sooth 2.1.2 ruby lib
+# stub: sooth 2.2.0 ruby lib
 # stub: ext/sooth_native/extconf.rb
 
 Gem::Specification.new do |s|
   s.name = "sooth".freeze
-  s.version = "2.1.2"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jason Hutchens".freeze]
-  s.date = "2018-03-15"
+  s.date = "2018-03-19"
   s.description = "Sooth is a simple stochastic predictive model.".freeze
   s.email = "jasonhutchens@gmail.com".freeze
   s.extensions = ["ext/sooth_native/extconf.rb".freeze]

data/spec/predictor_spec.rb

@@ -213,4 +213,25 @@ describe Sooth::Predictor do
       expect(predictor.surprise(1, 3)).to eq(8) 
     end
   end
+
+  describe "#frequency" do
+    it "returns zero for a new context" do
+      expect(predictor.frequency(1, 3)).to eq(0) 
+    end
+
+    it "returns zero for a new event" do
+      predictor.observe(1, 3)
+      expect(predictor.frequency(1, 4)).to eq(0) 
+    end
+
+    it "is one for a lone event" do
+      predictor.observe(1, 3)
+      expect(predictor.frequency(1, 3)).to eq(1) 
+    end
+
+    it "is uniform for a uniform distribution" do
+      (1..100).each { |i| predictor.observe(1, i) }
+      expect(predictor.frequency(1, 3)).to eq(0.01) 
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sooth
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Jason Hutchens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec