sequitur 0.0.06 → 0.0.07

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWU5NWNmNThiYzM0M2UxOWU2ZGY4Mzc3ZTkzOWM2NGM2M2ZkNGYyYg==
+    YjliZTY3NWVkYWRmNzI3ZmZmNDI2YWU5ZjY0NzUxZjg1ZWQ3ZTFmMg==
   data.tar.gz: !binary |-
-    MDk3ZjQ3NGM0NTFjZDM4NzIzOGExMDdjZDIwYTA4NTZiNmY3YTEwYg==
+    Y2ZjNGYxNDk1NGYxMTE5NTBiYzkyOWYyMGRjYmUyNGMzMGE2MTUxZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDFmZWEzZWQ1MWIzNzg4YTA3MmZhNDc1ZTkxYjE1ODY3MzgyMzlhMWI0MDVm
-    MDUwMTY1OTI0ZTkxYzhjZGEwYWRjNTVjMWZkNzkxMzgxNjQ3ZjcwZmQ2NmI0
-    Y2VmYTA3NzhjMjg0NTE3ZGU2YzNlNjU3Mjk5NTBhMTA0ODQ5M2Y=
+    NzBmZDFiMGQyNWFiNjMzMDAwYTM3ODQ0ZDk4YmUzMTNiYmNjNTE3MGU2ZWZl
+    ZjNmNzdkYzgwOTZiZmZjYjM2NzVkNDIxODhlZDMwMjM1YjIxMDA5ZjhkMTU5
+    ZGNkMDQwNDZkNDRmMWI4NWY2ZWIyMWQwYTAwZDZlZjNjOTVjNWQ=
   data.tar.gz: !binary |-
-    NGNhMmUzZTEyOWQ5N2QyZGExOTljMzJmMmZmNGVjMjRjNjU2NzkyN2EwOTg1
-    YzU0YTcwYzc3OWI0MDdhNjY4NDVjZmVhYzZhMGE4YjY3NDM5NTY4M2NhZDhi
-    MTZhYmQyNmZkMzhjZjIzZDE2NjVkZDhmM2Y4NWZiOGViNzg1MzM=
+    ZDEzY2IyZDk5ZGMxMWY0ZDJiZGMxZDA2ZDM2MzcwNTRhNTRhYWEyODUxNDBl
+    ZTE2OTUxOGM4ZDk4MTdlYmU0ZWI1NGM0ZTNlMWI5MTgzMzg3Y2FmMzhhNTU3
+    ZmYxMTg3NGNkMDljZGQ3MzhmMmQyMWNkZWQ2NjFiYzhlZTlmNTY=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### 0.0.07 / 2014-08-24
+* [CHANGE] `digram.rb`: Updated Digram class documentation.
+
 ### 0.0.06 / 2014-08-24
 * [CHANGE] `.rubocop.yml`: Enabled FileName cop and updated source file names accordingly.
 

data/lib/sequitur/constants.rb

@@ -3,7 +3,7 @@
 
 module Sequitur # Module used as a namespace
   # The version number of the gem.
-  Version = '0.0.06'
+  Version = '0.0.07'
 
   # Brief description of the gem.
   Description = 'Ruby implementation of the Sequitur algorithm'

data/lib/sequitur/digram.rb

@@ -1,6 +1,11 @@
+# File: digram.rb
+
 module Sequitur # Module for classes implementing the Sequitur algorithm
 
-# A digram is a sequence of two grammar symbols (terminal or not).
+# In linguitics, a digram is a sequence of two letters.
+# In Sequitur a digram is a sequence of two consecutive symbols that
+# appear in a grammar (production) rule. Each symbol in a digram 
+# can be a terminal or not.
 class Digram
   # The sequence of two consecutive grammar symbols.
   attr_reader(:symbols)
@@ -12,12 +17,16 @@ class Digram
   attr_reader(:key)
   
   # Constructor.
+  # @param symbol1 [StringOrSymbol] First element of the digram
+  # @param symbol2 [StringOrSymbol] Second element of the digram
+  # @param aProduction [Production] Production in which the RHS 
+  # the sequence symbol1 symbol2 appears.
   def initialize(symbol1, symbol2, aProduction)
     @symbols = [symbol1, symbol2]
     @key = "#{symbol1.hash.to_s(16)}:#{symbol2.hash.to_s(16)}" 
     @production_id = aProduction.object_id
   end
-  
+
   # Return the production object of this digram
   def production()
     ObjectSpace._id2ref(production_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequitur
 version: !ruby/object:Gem::Version
-  version: 0.0.06
+  version: 0.0.07
 platform: ruby
 authors:
 - Dimitri Geshef