automata 0.0.6 → 0.0.7

data/lib/automata/dfa.rb

@@ -1,49 +1,39 @@
 module Automata
-  
-  ##
   # Deterministic Finite Automata.
-  # 
-  # Each state of a DFA must have exactly one transition for each transition
-  # defined at creation.
-  #
-  #--
-  # TODO: Check that each state is connected.
-  #
   class DFA < StateDiagram
-    
-    ##
-    # Verify that the initialized DFA is valid.
-    #
-    # * *Returns*:
-    #   Whether or not the DFA is valid (boolean).
+    # Verifies that the initialized DFA is valid.
+    # Checks that each state has a transition for each
+    # symbol in the alphabet.
     #
+    # @return [Boolean] whether or not the DFA is valid.
     def valid?
+      # @todo Check that each state is connected.
+      #   Iterate through each states to verify the graph
+      #   is not disjoint.
       @transitions.each do |key, val|
         @alphabet.each { |a| return false unless @transitions[key].has_key? a }
       end
       true
     end
     
-    ##
-    # Determines whether the DFA accepts the given string.
-    #
-    # * *Args*:
-    #   - +string+ -> The string to use as input for the DFA.
+    # Determines whether the DFA accepts a given string.
     #
-    # * *Returns*:
-    #   Whether or not the DFA accepts the string (boolean).
-    #
-    def accepts?(string)
+    # @param [String] input the string to use as input for the DFA.
+    # @return [Boolean] whether or not the DFA accepts the string.
+    def accepts?(input)
       head = @start
-      string.each_char do |symbol|
+      input.each_char do |symbol|
         head = @transitions[head][symbol]
       end
       is_accept_state? head
     end
     
+    # Determines if a given state is an accept state.
+    #
+    # @param [String] state the state label to check.
+    # @return [Boolean] whether or not the state is an accept state.
     def is_accept_state?(state)
       @accept.include? state
     end
   end
-  
 end

data/lib/automata/nfa.rb

@@ -1,39 +1,27 @@
 module Automata
-  
-  ##
-  # Deterministic Finite Automata.
-  # 
-  # NFA nodes do not need to have a transition for each
-  # symbol in the alphabet. Empty transitions, denoted by 
-  # the '&' charactar, force a transition to another node.
-  #
-  #--
-  # TODO: Check that each state is connected.
-  #
+  # Nondeterministic Finite Automata.
   class NFA < StateDiagram
+    # @todo Check that each state is connected.
+    #   Iterate through each states to verify the graph
+    #   is not disjoint.
     
-    ##
-    # Determines whether the NFA accepts the given string.
+    # Determines whether the NFA accepts a given string.
     #
-    # * *Args*:
-    #   - +string+ -> The string to use as input for the DFA.
-    # * *Returns*:
-    #   Whether or not the DFA accepts the string (boolean).
-    #
-    def accepts?(string)
+    # @param [String] input the string to use as input for the NFA.
+    # @return [Boolean] Whether or not the NFA accepts the input string.
+    def accepts?(input)
       heads = [@start]
       
-      #--
       # Move any initial e-transitions
       if has_transition?(@start, '&')
         transition(@start, '&').each { |h| heads << h } 
       end
       
-      string.each_char do |symbol|
+      # Iterate through each symbol of input string
+      input.each_char do |symbol|
         newHeads, eTrans = [], []
                 
         heads.each do |head|
-          #--
           # Check if head can transition read symbol
           # Head dies if no transition for symbol
           if has_transition?(head, symbol)
@@ -41,7 +29,6 @@ module Automata
           end
         end
         
-        #--
         # Move any e-transitions
         newHeads.each do |head|
           if has_transition?(head, '&')
@@ -58,52 +45,37 @@ module Automata
       false
     end
     
-    ##
-    # Determine the states to transition to from a given
-    # state and input symbol.
-    #
-    # * *Args*:
-    #   - +state+ -> State transitioning from.
-    #   - +input+ -> Input symbol.
-    # * *Returns*:
-    #   The array of transition states. Nil if none.
+    # Determines the transition states, if any, from a given 
+    # beginning state and input symbol pair.
     #
-    def transition(state, input)
-      if has_transition?(state, input)
-        dests = @transitions[state][input]
-        dests = [dests] unless dests.kind_of? Array
-        dests
-      else
-        nil
-      end
+    # @note NFA ε-transitions
+    #   ε-transitions are supported through the use of the
+    #   reserved input alphabet character '&'.
+    # @param [String] state state label for beginning state.
+    # @param [String] symbol input symbol.
+    # @return [Array] Array of destination transition states.
+    def transition(state, symbol)
+      dests = @transitions[state][symbol]
+      dests = [dests] unless dests.kind_of? Array
+      dests
     end
     
-    ##
-    # Determine whether or not a transition exists
-    # for a state, given an input symbol.
+    # Determines whether or not any transition states exist
+    # given a beginning state and input symbol pair.
     #
-    # * *Args*:
-    #   - +state+ -> State transitioning from.
-    #   - +input+ -> Input symbol.
-    # * *Returns*:
-    #   Whether a transition exists. (boolean)
-    #
-    def has_transition?(state, input)
+    # @param (see #transition)
+    # @return [Boolean] Whether or not a transition exists.
+    def has_transition?(state, symbol)
       return false unless @transitions.include? state
-      @transitions[state].has_key? input
+      @transitions[state].has_key? symbol
     end
     
-    ##
-    # Determine if a given state is an accept state.
-    #
-    # * *Args*:
-    #   - +state+ -> The state.
-    # * *Returns*:
-    #   Whether or not the state is an accept state. (boolean)
+    # Determines if a given state is an accept state.
     #
+    # @param [String] state the state label to check.
+    # @return [Boolean] whether or not the state is an accept state.
     def accept_state?(state)
       @accept.include? state
     end
   end
-  
 end

data/lib/automata/state_diagram.rb

@@ -1,14 +1,25 @@
 module Automata
-  
-  ##
   # A generic state diagram class represented as a 5-tuple.
-  #
-  #--
-  # TODO: Check for valid transitions against declared states and alphabet.
-  #
   class StateDiagram
     attr_accessor :states, :alphabet, :start, :accept, :transitions
     
+    # @todo Validate machine
+    #   Check that each transition reads a valid, declared
+    #   input symbol.
+    
+    # Initialize and build a StateDiagram object.
+    #
+    # @param [Hash] params the parameters to build the machine with.
+    # @option [String] :file a YAML file containing machine params.
+    # @option [Array<String>] :states the state labels of the machine.
+    # @option [Array<String>] :alphabet the alphabet of input symbols.
+    # @option [String] :start the start state of the machine.
+    # @option [Array<String>] :accept the accept states of the machine.
+    # @option [Hash] :transitions nested hash of transitions for each state.
+    # @note The :transitions hash structure will vary
+    #   Different machines will require different transition structures.
+    #   Please refer to the {http://github.com/jico/automata/wiki wiki}
+    #   for details regarding each machine type.
     def initialize(params={})
       yaml = {}
       yaml = YAML::load_file(params[:file]) if params.has_key? :file
@@ -18,7 +29,5 @@ module Automata
       @accept = yaml['accept'] || params[:accept]
       @transitions = yaml['transitions'] || params[:transitions]
     end
-    
   end
-  
 end

data/lib/automata/version.rb

@@ -1,3 +1,3 @@
 module Automata
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automata
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70295152631100 !ruby/object:Gem::Requirement
+  requirement: &70318108152500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70295152631100
+  version_requirements: *70318108152500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70295152630000 !ruby/object:Gem::Requirement
+  requirement: &70318108151900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70295152630000
+  version_requirements: *70318108151900
 description: Create and simulate automaton.
 email:
 - jico@baligod.com
@@ -72,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 830920834745777469
+      hash: 149328891026543090
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 830920834745777469
+      hash: 149328891026543090
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17