automata 0.0.3 → 0.0.5

data/README.md

@@ -22,7 +22,75 @@ Or install it yourself as:
 
 ## Usage
 
-We'll be adding some wiki pages with usage details soon.
+### Creating a new machine
+
+Defining a new machine can be done in two ways: 
+* From a structured YAML file.
+* Through class setter methods.
+
+#### Building with YAML
+
+We can easily define a machine's _n_-tuples in a YAML file. For example, let's create a DFA defined by the 5-tuple (_states_, _alphabet_, _start_, _accept_, _transitions_). We create the file `examples/dfa_sample.yml` with the following content:
+
+    states:
+      - A
+      - B
+      - C
+      - D
+    alphabet:
+      - '0'
+      - '1'
+    start: A
+    accept:
+      - C
+    transitions:
+      A:
+        '0': B
+        '1': D
+      B:
+        '0': C
+        '1': D
+      C:
+        '0': C
+        '1': C
+      D:
+        '0': D
+        '1': D
+        
+__Note:__ Integer hash keys are currently unsupported, hence they must be wrapped in quotes.
+
+With our machine defined, we can create a new DFA object from the file.
+
+    dfa = Automata::DFA.new(file: 'examples/dfa_sample.yml')
+    
+Presto! We have a fully functioning DFA machine.
+
+#### Building with setters
+
+You also have the option of setting each variable in the machine's _n_-tuple definition. For example, let's create a new empty DFA and define its states.
+
+    dfa = Automata::DFA.new
+    dfa.states = ['A', 'B', 'C', 'D']
+    
+We can define each property of the DFA in a similar manner.
+
+### Playing with our machine
+
+Now that we've built a machine, we can pass it input and let it work its magic. Consider our DFA built using our `examples/dfa_sample.yml` file, which accepts all strings starting with _00_. Let's experiment with some input:
+
+    # We can make sure it's a valid DFA
+    >> dfa.is_valid?
+    => true
+    >> dfa.accepts? '001'
+    => true
+    >> dfa.accepts? '0101'
+    => false
+    
+Awesomesauce.
+
+## Special Characters
+
+* _&_ - Represents an ε-transition (epsilon/empty transition)
 
 ## Contributing
 

data/examples/dfa_sample.yml

@@ -1,20 +1,29 @@
+##
+# Sample DFA file.
+#
+# Accepts all binary strings starting with 00.
+#
 states:
-  - q1
-  - q2
-  - q3
+  - A
+  - B
+  - C
+  - D
 alphabet:
   - '0'
   - '1'
-start: q1
+start: A
 accept:
-  - q3
+  - C
 transitions:
-  q1:
-    '0': q2
-    '1': q2
-  q2:
-    '0': q1
-    '1': q3
-  q3:
-    '0': q3
-    '1': q3
+  A:
+    '0': B
+    '1': D
+  B:
+    '0': C
+    '1': D
+  C:
+    '0': C
+    '1': C
+  D:
+    '0': D
+    '1': D

data/examples/nfa_2.yml

@@ -0,0 +1,31 @@
+##
+# Sample NFA build file
+#
+# Accepts all binary strings where
+# the last symbol is 0 or
+# which contain only 1's
+#
+states:
+  - A
+  - B
+  - C
+  - D
+alphabet:
+  - '0'
+  - '1'
+start: B
+accept:
+  - A
+  - D
+transitions:
+  A:
+    '1': A
+  B:
+    '&':
+      - A
+      - C
+  C:
+    '0':
+      - C
+      - D
+    '1': C

data/lib/automata/nfa.rb

@@ -12,10 +12,6 @@ module Automata
   #
   class NFA < StateDiagram
     
-    #--
-    # TODO: Check if valid NFA.
-    #
-    
     ##
     # Determines whether the NFA accepts the given string.
     #
@@ -27,8 +23,18 @@ module Automata
     def accepts?(string)
       heads = [@start]
       string.each_char do |symbol|
-        newHeads = []
-        heads.each_with_index do |head, i|
+        newHeads, eTrans = [], []
+        
+        #--
+        # Move any e-transitions
+        heads.each do |head|
+          if has_transition?(head, '&')
+            transition(head, '&').each { |t| eTrans << t }
+          end
+        end
+        eTrans.each { |h| heads << h }
+        
+        heads.each do |head|
           #--
           # Check if head can transition read symbol
           # Head dies if no transition for symbol
@@ -75,6 +81,7 @@ module Automata
     #   Whether a transition exists. (boolean)
     #
     def has_transition?(state, input)
+      return false unless @transitions.include? state
       @transitions[state].has_key? input
     end
     

data/lib/automata/version.rb

@@ -1,3 +1,3 @@
 module Automata
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/dfa_spec.rb

@@ -11,8 +11,8 @@ describe Automata::DFA do
       @dfa.should be_valid
     end
     
-    it "should accept '01'" do
-      @dfa.accepts?('01').should == true
+    it "should accept '00'" do
+      @dfa.accepts?('00').should == true
     end
     
     it "should accept '001101'" do
@@ -23,8 +23,20 @@ describe Automata::DFA do
       @dfa.accepts?('').should == false
     end
     
-    it "should not accept '10'" do
-      @dfa.accepts?('10').should == false
+    it "should not accept '0'" do
+      @dfa.accepts?('0').should == false
+    end
+    
+    it "should not accept '1'" do
+      @dfa.accepts?('1').should == false
+    end
+    
+    it "should not accept '01'" do
+      @dfa.accepts?('01').should == false
+    end
+    
+    it "should not accept '100'" do
+      @dfa.accepts?('100').should == false
     end
   end
   
@@ -40,22 +52,26 @@ describe Automata::DFA do
   
   context "Initializing a DFA by params" do
     before do
-      states = ['q1','q2','q3']
-      alphabet = ['0','1']
-      start = 'q1'
-      accept = ['q3']
+      states = %w( A B C D )
+      alphabet = %w( 0 1 )
+      start = 'A'
+      accept = %w( C )
       transitions = {
-        'q1' => {
-          '0' => 'q2',
-          '1' => 'q2'
+        'A' => {
+          '0' => 'B',
+          '1' => 'D'
+        },
+        'B' => {
+          '0' => 'C',
+          '1' => 'D'
         },
-        'q2' => {
-          '0' => 'q1',
-          '1' => 'q3'
+        'C' => {
+          '0' => 'C',
+          '1' => 'C'
         },
-        'q3' => {
-          '0' => 'q3',
-          '1' => 'q3'
+        'D' => {
+          '0' => 'D',
+          '1' => 'D'
         }
       }
       params = {
@@ -72,8 +88,8 @@ describe Automata::DFA do
       @dfa.should be_valid
     end
     
-    it "should accept '01'" do
-      @dfa.accepts?('01').should == true
+    it "should accept '00'" do
+      @dfa.accepts?('00').should == true
     end
     
     it "should accept '001101'" do
@@ -84,8 +100,20 @@ describe Automata::DFA do
       @dfa.accepts?('').should == false
     end
     
-    it "should not accept '10'" do
-      @dfa.accepts?('10').should == false
+    it "should not accept '0'" do
+      @dfa.accepts?('0').should == false
+    end
+    
+    it "should not accept '1'" do
+      @dfa.accepts?('1').should == false
+    end
+    
+    it "should not accept '01'" do
+      @dfa.accepts?('01').should == false
+    end
+    
+    it "should not accept '100'" do
+      @dfa.accepts?('100').should == false
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automata
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70308841255600 !ruby/object:Gem::Requirement
+  requirement: &70101266746740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70308841255600
+  version_requirements: *70101266746740
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70308841254660 !ruby/object:Gem::Requirement
+  requirement: &70101266745440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70308841254660
+  version_requirements: *70101266745440
 description: Create and simulate automaton.
 email:
 - jico@baligod.com
@@ -48,6 +48,7 @@ files:
 - Rakefile
 - automata.gemspec
 - examples/dfa_sample.yml
+- examples/nfa_2.yml
 - examples/nfa_sample.yml
 - lib/automata.rb
 - lib/automata/dfa.rb
@@ -71,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1969094852898081340
+      hash: -2023160774653295454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1969094852898081340
+      hash: -2023160774653295454
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17