wongi-engine 0.0.2 → 0.0.3

data/.gitignore

@@ -3,6 +3,8 @@
 .bundle
 .config
 .yardoc
+.rspec
+.rvmrc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -81,7 +81,9 @@ If you don't care about a specific field's value, you can use the all-matcher `:
 
 Once a variable is bound, it can be used to match further facts within a rule. Let's add another friendship:
 
-	engine << [ "Bob", "friend", "Claire" ]
+```ruby
+engine << [ "Bob", "friend", "Claire" ]
+```
 
 and another rule:
 	
@@ -141,7 +143,7 @@ engine.rule "self-printer" do
 end
 ```
 
-The `make` section (also spelled `do!`, if you find it more agreeable English, because `do` is a keyword in Ruby) lists everything that happens when a rule's conditions are fully matched (we say the production node is activated). Wongi::Engine provides only a small amount of build-in actions, but you can define define your own ones, and the simplest one is just `action` with a block.
+The `make` section (also spelled `do!`, if you find it more agreeable English, because `do` is a keyword in Ruby) lists everything that happens when a rule's conditions are fully matched (we say "the production node is **activated**"). Wongi::Engine provides only a small amount of built-in actions, but you can define your own ones, and the simplest one is just `action` with a block.
 
 ### More facts!
 
@@ -163,7 +165,7 @@ engine << ["friend", "symmetric", true]
 
 If you still have the "self-printer" rule installed, you will see some new friendships pop up immediately!
 
-The built-in `gen` action creates new facts, taking either fixed values or variables as arguments. (It will complain if use provide a variable that isn't bound by the time it's activated.) Here, it takes all relations we've defined to be [symmetric](http://en.wikipedia.org/wiki/Symmetric_relation), finds all couples in those sorts of relations and turns them around.
+The built-in `gen` action creates new facts, taking either fixed values or variables as arguments. (It will complain if you provide a variable that isn't bound by the time it's activated.) Here, it takes all relations we've defined to be [symmetric](http://en.wikipedia.org/wiki/Symmetric_relation), finds all couples in those sorts of relations and turns them around.
 
 ### Matchers
 
@@ -175,7 +177,7 @@ Passes if the specified template does *not* match anything in the dataset. Alias
 
 #### `maybe subject, predicate, object`
 
-Passes whether or not the template matches anything. It's only useful if it introduces a new variable. Alias: `optional`.
+Passes whether or not the template matches anything. It's only useful if it introduces a new variable; you can think of `LEFT JOIN`. Alias: `optional`.
 
 #### `none { ... }`
 
@@ -193,13 +195,23 @@ Passes if the arguments are equal. Alias: `eq`, `equal`.
 
 Passes if the arguments are not equal. Alias: `ne`.
 
+#### `assert { |token| ... }`, `assert var1, var2, ... do |val1, val2, ... | ... end`
+
+Passes if the block evaluates to `true`. Having no arguments passes the entire token as an argument, listing some variables passes only their values.
+
+#### `assign variable do |token| ... end`
+
+Not a *matcher*, strictly speaking, because it always passes. What it does instead is introduce a new variable bound to the block's return value.
+
 ### Timeline
 
 Wongi::Engine has a limited concept of timed facts: time is discrete and only extends into the past. Matchers that accept a triple specification (`has`, `neg` and `maybe`) can also accept a fourth parameter, an integer <= 0, which will make them look at a past state of the system. "0" means the current state and is the default value, "-1" means the one just before the current, and so on.
 
 To create past states, say:
 
-	engine.snapshot!
+```ruby
+engine.snapshot!
+```
 
 This will shift all facts one step into the past. The new current state will be a copy of the last one. You can only insert new facts into the current state, "retroactive" facts are not allowed.
 

data/lib/wongi-engine/alpha_memory.rb

@@ -14,7 +14,7 @@ module Wongi::Engine
 
     def activate wme
       betas.each do |beta|
-        beta.right_activate wme
+        beta.alpha_activate wme
       end
       @wmes << wme
       wme.alphas << self

data/lib/wongi-engine/beta/assignment_node.rb

@@ -0,0 +1,39 @@
+module Wongi::Engine
+
+  class Assignment
+
+    def initialize variable, &body
+      @variable, @body = variable, body
+    end
+
+    def compile context
+      context.node = context.node.beta_memory.assignment_node( @variable, @body )
+      context.earlier << self
+      context
+    end
+
+  end
+
+  class AssignmentNode < BetaNode
+
+    def initialize parent, variable, body
+      super parent
+      @variable, @body = variable, body
+    end
+
+    def beta_activate token, wme = nil, assignments = { }
+      propagate_activation token, nil, { @variable => @body.call(token) }
+    end
+
+    def refresh_child child
+      tmp = children
+      self.children = [ child ]
+      parent.tokens.each do |token|
+        beta_activate token
+      end
+      self.children = tmp
+    end
+
+  end
+
+end

data/lib/wongi-engine/beta/beta_memory.rb

@@ -1,7 +1,7 @@
 module Wongi::Engine
 
   class BetaMemory < BetaNode
-    attr_reader :tokens, :last_token
+    attr_reader :tokens
 
     def initialize parent
       super
@@ -9,35 +9,49 @@ module Wongi::Engine
     end
 
     def seed assignments = {}
+      @seed = assignments
       t = Token.new( nil, nil, assignments )
       t.node = self
       @tokens << t
     end
 
     def subst valuations
-      token = @tokens.first
-      token.delete true
+      @tokens.first.delete
+
+      token = Token.new( nil, nil, @seed )
+      token.node = self
+      @tokens << token
+
       valuations.each { |variable, value| token.subst variable, value }
       self.children.each do |child|
-        child.left_activate token
+        child.beta_activate token
       end
     end
 
-    def left_activate token, wme, assignments
+    def beta_activate token, wme, assignments
       # puts "MEMORY #{@id} left-activated with #{wme}"
       t = Token.new( token, wme, assignments)
       t.node = self
-      @last_token = t
       @tokens << t
       self.children.each do |child|
         if child.kind_of? BetaMemory
-          child.left_activate t, nil, {}
+          child.beta_activate t, nil, {}
         else
-          child.left_activate t
+          child.beta_activate t
         end
       end
     end
 
+    def refresh_child child
+      tokens.each do |token|
+        child.beta_activate token, nil, {}
+      end
+    end
+
+    def delete_token token
+      tokens.delete token
+    end
+
     # => TODO: investigate if we really need this
     #def beta_memory
     #  self

data/lib/wongi-engine/beta/beta_node.rb

@@ -27,7 +27,7 @@ module Wongi::Engine
 
 
     def rete
-      if parent
+      @rete ||= if parent
         parent.rete
       else
         @rete
@@ -39,7 +39,7 @@ module Wongi::Engine
       beta = children.find { |node| BetaMemory === node }
       if beta.nil?
         beta = BetaMemory.new self
-        beta.update_above
+        beta.refresh
       end
       beta
     end
@@ -67,14 +67,20 @@ module Wongi::Engine
       return existing if existing
 
       node = FilterNode.new self, test
-      node.update_above
+      node.refresh
+      node
+    end
+
+    def assignment_node variable, body
+      node = AssignmentNode.new self, variable, body
+      node.refresh
       node
     end
 
     def neg_node alpha, tests, alpha_deaf
       node = NegNode.new self, tests, alpha
       alpha.betas << node unless alpha_deaf
-      node.update_above
+      node.refresh
       node
     end
 
@@ -91,8 +97,8 @@ module Wongi::Engine
       partner.ncc = ncc
       partner.divergent = self
       #    partner.conjuncts = condition.children.size
-      ncc.update_above
-      partner.update_above
+      ncc.refresh
+      partner.refresh
       ncc
     end
 
@@ -104,61 +110,26 @@ module Wongi::Engine
       end.node
     end
 
-    def update_above
-      update_from self.parent
+    def refresh
+      parent.refresh_child self
+    end
+
+    def refresh_child node
+      raise "#{self.class} must implement refresh_child"
+    end
+
+    def delete_token token
+      # => noop
     end
 
     private
 
     def propagate_activation token, wme, assignments
       self.children.each do |child|
-        child.left_activate token, wme, assignments
+        child.beta_activate token, wme, assignments
       end
     end
 
-    def update_from parent
-      case parent
-
-      when BetaMemory
-        parent.tokens.each do |token|
-          self.left_activate token, nil, {}
-        end
-
-      when JoinNode, OptionalNode
-        tmp = parent.children
-        parent.children = [ self ]
-        parent.alpha.wmes.each do |wme|
-          parent.right_activate wme
-        end
-        parent.children = tmp
-
-      when FilterNode
-        tmp = parent.children
-        parent.children = [ self ]
-        parent.parent.tokens.each do |token|
-          parent.left_activate token
-        end
-        parent.children = tmp
-
-      when NegNode
-        parent.tokens.each do |token|
-          if token.neg_join_results.empty?
-            left_activate token, nil, {}
-          end
-        end
-        parent.alpha.wmes.each do |wme|
-          parent.right_activate wme
-        end
-
-      when NccNode
-        parent.tokens.each do |token|
-          if token.ncc_results.empty?
-            left_activate token, nil, {}
-          end
-        end
-
-      end # => case
-    end
   end
 
 end

data/lib/wongi-engine/beta/filter_node.rb

@@ -1,91 +1,6 @@
 module Wongi
   module Engine
 
-
-    class FilterTest
-
-      def passes? token
-        true
-      end
-
-      def compile context
-        context.node = context.node.beta_memory.filter_node( self )
-        context.earlier << self
-        context
-      end
-
-      def == other
-        self.class == other.class
-      end
-
-    end
-
-    class EqualityTest < FilterTest
-
-      attr_reader :x, :y
-
-      def initialize x, y
-        @x, @y = x, y
-      end
-
-      def passes? token
-
-        x = if Template.variable? @x
-          token[@x]
-        else
-          @x
-        end
-
-        y = if Template.variable? @y
-          token[@y]
-        else
-          @y
-        end
-
-        return false if x == :_ || y == :_
-        return x == y
-
-      end
-
-      def == other
-        super && x == other.x && y == other.y
-      end
-      
-    end
-
-    class InequalityTest < FilterTest
-
-      attr_reader :x, :y
-
-      def initialize x, y
-        @x, @y = x, y
-      end
-
-      def passes? token
-
-        x = if Template.variable? @x
-          token[@x]
-        else
-          @x
-        end
-
-        y = if Template.variable? @y
-          token[@y]
-        else
-          @y
-        end
-
-        return false if x == :_ || y == :_
-        return x != y
-
-      end
-
-      def == other
-        super && x == other.x && y == other.y
-      end
-
-    end
-
     class FilterNode < BetaNode
 
       attr_accessor :test
@@ -95,7 +10,7 @@ module Wongi
         self.test = test
       end
 
-      def left_activate token
+      def beta_activate token, wme = nil, assignments = { }
         if test.passes? token
           propagate_activation token, nil, {}
         end
@@ -104,6 +19,17 @@ module Wongi
       def equivalent? test
         test == self.test
       end
+
+      def refresh_child child
+        tmp = children
+        self.children = [ child ]
+        parent.tokens.each do |token|
+          beta_activate token
+        end
+        self.children = tmp
+      end
+
     end
+
   end
 end

data/lib/wongi-engine/beta/join_node.rb

@@ -51,7 +51,7 @@ module Wongi
         # puts "\talpha = #{alpha}"
       end
 
-      def right_activate wme
+      def alpha_activate wme
         ws = '  ' * depth
         # puts "#{ws}JOIN #{@id} right-activated with #{wme}"
         collected = collect_assignments( wme )
@@ -65,7 +65,7 @@ module Wongi
         end
       end
 
-      def left_activate token
+      def beta_activate token
         ws = '  ' * depth
         self.alpha.wmes.uniq.each do |wme|
           if matches?( token, wme )
@@ -74,6 +74,15 @@ module Wongi
         end
       end
 
+      def refresh_child child
+        tmp = children
+        self.children = [ child ]
+        alpha.wmes.each do |wme|
+          alpha_activate wme
+        end
+        self.children = tmp
+      end
+
       def self.compile condition, earlier, parameters
         tests = []
         assignment = Template.new
@@ -114,7 +123,7 @@ module Wongi
         return assignments if self.assignment_pattern.nil?
         # puts "more assignments"
         [:subject, :predicate, :object].each do |field|
-          if self.assignment_pattern.send(field)
+          if self.assignment_pattern.send(field) != :_
             #puts "#{self.assignment_pattern.send(field)} = #{wme.send(field)}"
             assignments[ self.assignment_pattern.send(field) ] = wme.send(field)
           end

data/lib/wongi-engine/beta/ncc_node.rb

@@ -25,11 +25,12 @@ module Wongi
         @tokens = []
       end
 
-      #  def left_activate token, wme, assignments
+      #  def beta_activate token, wme, assignments
       #    t = Token.new token, wme, assignments
       #    t.node = self
-      def left_activate token, wme = nil, assignments = { } # => FIXME: left_activate has different signatures for storing and non-storing nodes...
+      def beta_activate token, wme = nil, assignments = { } # => FIXME: beta_activate has different signatures for storing and non-storing nodes...
         t = Token.new token, nil, {}
+        t.node = self
         tokens << t
         partner.tokens.each do |ncc_token|
           t.ncc_results << ncc_token
@@ -37,10 +38,28 @@ module Wongi
         end
         if t.ncc_results.empty?
           children.each do |child|
-            child.left_activate t, nil, {}
+            child.beta_activate t, nil, {}
           end
         end
       end
+
+      def refresh_child child
+        tokens.each do |token|
+          if token.ncc_results.empty?
+            child.beta_activate token, nil, {}
+          end
+        end
+      end
+
+      def delete_token token
+        tokens.delete token
+        token.ncc_results.each do |nccr|
+          nccr.wme.tokens.delete nccr
+          nccr.parent.children.delete nccr
+        end
+        token.ncc_results.clear
+      end
+
     end
   end
 end

data/lib/wongi-engine/beta/ncc_partner.rb

@@ -13,22 +13,11 @@ module Wongi
         @tokens = []
       end
 
-      def left_activate token
+      def beta_activate token
         t = Token.new token, nil, {}
         t.node = self
-        #    owners_t = t
-        #  #  owners_w = t.wme
-        #    conjuncts.times do
-        #  #    owners_w = owners_t.wme
-        #      owners_t = owners_t.parent
-        #    end
-        owner = nil
-        ncc.tokens.each do |ncc_token|
-          # if ncc_token.parent == owners_t
-          if ncc_token.parent.node == divergent
-            owner = ncc_token
-            break
-          end
+        owner = ncc.tokens.find do |ncc_token|
+          ncc_token.parent.node == divergent
         end
         if owner
           owner.ncc_results << t
@@ -38,6 +27,16 @@ module Wongi
           tokens << t
         end
       end
+
+      def delete_token token
+        token.owner.ncc_results.delete token
+        if token.owner.ncc_results.empty?
+          ncc.children.each do |node|
+            node.beta_activate token.owner, nil, {}
+          end
+        end
+
+      end
     end
   end
 end

data/lib/wongi-engine/beta/neg_node.rb

@@ -13,7 +13,7 @@ module Wongi
         @tokens = []
       end
 
-      def right_activate wme
+      def alpha_activate wme
         self.tokens.each do |token|
           if matches?( token, wme )
             token.delete_children if token.neg_join_results.empty?
@@ -22,7 +22,7 @@ module Wongi
         end
       end
 
-      def left_activate token, newwme, assignments
+      def beta_activate token, newwme, assignments
         t = Token.new token, newwme, assignments
         t.node = self
         self.tokens << t
@@ -33,11 +33,30 @@ module Wongi
         end
         if t.neg_join_results.empty?
           self.children.each do |child|
-            child.left_activate t, nil, {}
+            child.beta_activate t, nil, {}
           end
         end
       end
 
+      def refresh_child child
+        tokens.each do |token|
+          if token.neg_join_results.empty?
+            child.beta_activate token, nil, {}
+          end
+        end
+        alpha.wmes.each do |wme|
+          alpha_activate wme
+        end
+      end
+
+      def delete_token token
+        tokens.delete token
+        token.neg_join_results.each do |njr|
+          njr.wme.neg_join_results.delete njr if njr.wme
+        end
+        token.neg_join_results.clear
+      end
+
       protected
 
       def matches? token, wme

data/lib/wongi-engine/beta/optional_node.rb

@@ -5,7 +5,7 @@ module Wongi
 
     class OptionalNode < JoinNode
 
-      def right_activate wme
+      def alpha_activate wme
         parent.tokens.each do |token|
           if matches? token, wme
             if token.has_optional?
@@ -20,7 +20,7 @@ module Wongi
         end
       end
 
-      def left_activate token
+      def beta_activate token
         match = false
         alpha.wmes.each do |wme|
           assignments = collect_assignments(wme)
@@ -38,6 +38,23 @@ module Wongi
         end
       end
 
+      def refresh_child child
+        tmp = children
+        self.children = [ child ]
+        alpha.wmes.each do |wme|
+          alpha_activate wme
+        end
+        self.children = tmp
+      end
+
+      def delete_token token
+        tokens.delete token
+        token.opt_join_results.each do |ojr|
+          ojr.wme.opt_join_results.delete ojr
+        end
+        token.opt_join_results.clear
+      end
+
     end
   end
 end

data/lib/wongi-engine/beta/or_node.rb

@@ -18,7 +18,7 @@ module Wongi
         end
         context.earlier += added
         context.node = OrNode.new( branches )
-        context.node.update_above
+        context.node.refresh
         context
       end
 
@@ -65,9 +65,9 @@ module Wongi
         parents.map( &:depth ).max + 1
       end
 
-      def update_above
+      def refresh
         parents.each do |parent|
-          update_from parent
+          parent.refresh_child self
         end
       end
 

data/lib/wongi-engine/beta/production_node.rb

@@ -11,20 +11,16 @@ module Wongi
         @actions.each { |action| action.production = self }
       end
 
-      def left_activate token, wme, assignments
+      def beta_activate token, wme, assignments
         super
         @actions.each do |action|
           # @tokens.each do |t|
           #  action.execute t
           # end
-          action.execute last_token if action.respond_to? :execute
+          action.execute tokens.last if action.respond_to? :execute
         end
       end
 
-      # => TODO: investigate
-      def deexecute token
-
-      end
     end
 
   end