omf_rete 0.5 → 0.6.1

data/lib/omf_rete/planner/plan_builder.rb

@@ -4,8 +4,8 @@
 # Monkey patch symbol to allow consistent ordering of set keys
 unless (:test).respond_to? '<=>'
   class Symbol
-    def <=>(o) 
-      self.to_s <=> o.to_s 
+    def <=>(o)
+      self.to_s <=> o.to_s
     end
   end
 end
@@ -13,20 +13,20 @@ end
 
 module OMF::Rete
   module Planner
-    
-    # The base exception for all errors related 
+
+    # The base exception for all errors related
     class PlannerException < Exception; end
 
     require 'omf_rete/planner/source_plan'
     require 'omf_rete/planner/plan_level_builder'
     require 'omf_rete/planner/plan_set'
-    require 'omf_rete/planner/filter_plan'      
+    require 'omf_rete/planner/filter_plan'
 
-    # This class builds all the possible plans for a given 
+    # This class builds all the possible plans for a given
     # query
     #
     class PlanBuilder
-      
+
       attr_reader :plan, :store
       #
       # query -- query consists of an array of tuple paterns with binding declarations
@@ -35,17 +35,17 @@ module OMF::Rete
       def initialize(query, store, opts = {})
         @store = store
         @opts = opts
-        
+
         _parse_query(query)
-        
+
         @complete_plans = []
         if (@source_cnt == 1)
           # only one source means a trivial plan, the source itself
           @complete_plans = @sources.to_a
         end
-        
+
       end
-      
+
       def build()
         level = 0
         maxLevels = @source_cnt + 10 # pull the emergency breaks sometimes
@@ -54,24 +54,24 @@ module OMF::Rete
           level += 1
         end
         if (@complete_plans.empty?)
-          raise PlannerException.new("Can't create plan")            
+          raise PlannerException.new("Can't create plan")
         end
         @complete_plans
       end
-      
+
       def each_plan()
         @complete_plans.each do |p| yield(p) end
       end
-      
+
       # Return plan with lowest cost
       #
       def best_plan()
         # best_plan = nil
         # lowest_cost = 9999999999
-#           
+#
         # each_plan do |plan|
           # cost = plan.cost
-          # if (cost < lowest_cost) 
+          # if (cost < lowest_cost)
             # lowest_cost = cost
             # best_plan = plan
           # end
@@ -81,8 +81,8 @@ module OMF::Rete
         end
         best_plan
       end
-      
-      
+
+
       # Materialize the plan. Create all the relevant operations and tuple sets
       # to realize a configuration for the respective query. Returns the result
       # set.
@@ -99,7 +99,7 @@ module OMF::Rete
           _materialize_simple_plan(projectPattern, plan, opts, &block)
         else
           # this is the root of the plan
-          if projectPattern 
+          if projectPattern
             description = projectPattern
           else
             description = plan.result_set.to_a.sort
@@ -109,8 +109,8 @@ module OMF::Rete
           endS
         end
       end
-      
-      
+
+
       def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
         out << "\n=========\n"
         @complete_plans.each do |p|
@@ -118,35 +118,40 @@ module OMF::Rete
           p.describe(out, offset, incr, sep)
         end
       end
-      
+
       private
 
       # Parse +query+ which is an array of query tuples or filters.
-      # 
+      #
       # This method create a new +SourcePlan+ (to be attached to a store)
       # for every query tuple in the +query+ array.
-      #      
+      #
       def _parse_query(query)
         @query = query
         @sources = Set.new
         @filters = []
         @plans = PlanSet.new
+        if query.length == 1 && (query[0].is_a? Array)
+          # it's only rule, so we can allow source plans without binding variables
+          query[0] = SourcePlan.new(query[0], @store, false)
+        end
         query.each do |sp|
-          
+
           if sp.is_a? FilterPlan
             @filters << sp
           elsif sp.is_a? SourcePlan
             @sources << sp
             @plans << sp
           elsif sp.is_a? Array
-            unless sp.length == @store.length
+            unless @store.confirmLength(sp)
               raise PlannerException.new("SubPlan: Expected array of store size, but got '#{sp}'")
             end
             begin
               p = SourcePlan.new(sp, @store)
               @sources << p
               @plans << p
-            rescue NoBindingException
+            rescue NoBindingException => nex
+              raise nex
               # ignore sources with no bindings in them
             end
           else
@@ -158,7 +163,7 @@ module OMF::Rete
           raise PlannerException.new("Query '#{query}' seems to be empty")
         end
       end
-      
+
       #
       # Array of sources from lower levels to build new plans from
       #
@@ -180,7 +185,7 @@ module OMF::Rete
         end
         @plans
       end
-        
+
       # Compare +plan+ with all remaining plans and create
       # a new plan if it can be combined. If no new plan
       # is created for +plan+ elevated it to this level.
@@ -192,8 +197,8 @@ module OMF::Rete
           end
         end
       end
-      
-      
+
+
       def _build_for(left, right)
 #          STDOUT.puts "CHECKING"
 #          STDOUT.puts "  LEFT"
@@ -208,22 +213,22 @@ module OMF::Rete
         if (lcover.size == combinedSize || rcover.size == combinedSize)
           return nil # doesn't get us closer to a solution
         end
-        
+
         joinSet = left.result_set.intersection(right.result_set)
         if (joinSet.empty?)
-          return nil # nothing to join            
+          return nil # nothing to join
         end
-        
+
         resultSet = left.result_set + right.result_set
         left.used
         right.used
         jp = JoinPlan.new(left, right, joinSet, resultSet, combinedCover, self)
         _add_plan(jp)
       end
-      
+
       def _add_plan(plan)
         action = 'DUPLICATE: '
-        if (@plans << plan) 
+        if (@plans << plan)
           action = 'ADDED: '
           if (plan.cover_set.size == @source_cnt)
             action = 'COMPLETE: '
@@ -234,13 +239,12 @@ module OMF::Rete
 #          STDOUT << action
 #          plan.describe
       end
-      
+
       # The +plan+ consists only of a source plan. Create
       # a processing stream and attach a block which extracts
       # the 'bound' elements from the incoming tuple.
       #
       def _materialize_simple_plan(projectPattern, plan, opts, &block)
-        
         unless projectPattern
           # create one from the binding varibales in plan.description
           projectPattern = []
@@ -249,16 +253,16 @@ module OMF::Rete
               projectPattern << name.to_sym
             end
           end
-          if (projectPattern.empty?)
-            raise NoBindingException.new("No binding declaration in source plan '#{plan.description.join(', ')}'")
-          end              
+          # if (projectPattern.empty?)
+            # raise NoBindingException.new("No binding declaration in source plan '#{plan.description.join(', ')}'")
+          # end
         end
         description = projectPattern
-        
+
         #src = plan.materialize(nil, projectPattern, opts)
-        src = ProcessingTupleStream.new(projectPattern, projectPattern, plan.description) 
+        src = ProcessingTupleStream.new(projectPattern, projectPattern, plan.description)
         frontS, endS = _materialize_result_stream(plan, projectPattern, opts, &block)
-        
+
         src.receiver = frontS
         frontS.source = src
 
@@ -266,7 +270,7 @@ module OMF::Rete
 
         endS
       end
-    
+
       # This creates the result stream and stacks all filters on top (if any)
       # It returns the first and last element as an array.
       #
@@ -274,9 +278,9 @@ module OMF::Rete
         plan_description = plan.result_description
         description = projectPattern || plan.result_description
         rs = ResultTupleStream.new(description, &block)
-          
+
         # This is a very naive plan to add filters. It simple stacks them all at the end.
-        # It would be much better to put them right after each source or join which produces 
+        # It would be much better to put them right after each source or join which produces
         # the matching binding stream.
         #
         first_filter = nil
@@ -295,7 +299,7 @@ module OMF::Rete
         end
         [first_filter || rs, rs]
       end
-      
+
 
     end # PlanBuilder
   end # Planner

data/lib/omf_rete/planner/source_plan.rb

@@ -1,28 +1,29 @@
 
 require 'omf_rete/planner/plan_builder'
 require 'omf_rete/planner/abstract_plan'
+require 'omf_rete/indexed_tuple_set'
 require 'set'
 
 module OMF::Rete
   module Planner
-    
+
     # Thrown if the plan doesn't contain any bindings
     class NoBindingException < PlannerException; end
 
     # This class represents a planned join op.
-    # 
+    #
     #
     class SourcePlan < AbstractPlan
       attr_reader :description
       attr_reader :source_set  # tuple set created by this plan
-      
+
       #
       # description - description of tuples contained in set
       # store - store to attach +source_set+ to
       #
-      def initialize(description, store = nil)
+      def initialize(description, store = nil, check_for_empty_result_set = true)
         @description = description
-        # the result set consists of all the binding declarations 
+        # the result set consists of all the binding declarations
         # which are symbols with trailing '?'
         resultSet = Set.new
         description.each do |name|
@@ -30,29 +31,29 @@ module OMF::Rete
             resultSet << name.to_sym
           end
         end
-        if (resultSet.empty?)
+        if (check_for_empty_result_set && resultSet.empty?)
           raise NoBindingException.new("No binding declaration in sub plan '#{description.join(', ')}'")
         end
         coverSet = Set.new([self])
-        super coverSet, resultSet 
-        
+        super coverSet, resultSet
+
         #raise Exception unless store.kind_of?(Moana::Filter::Store)
         @store = store
       end
-      
+
       # Materialize the plan. Returns a tuple set.
       #
       def materialize(indexPattern, projectPattern, opts)
         unless indexPattern
           # this plan only consists of a single source
           projectPattern ||= result_description
-          @source_set = ProcessingTupleStream.new(projectPattern, projectPattern, @description) 
+          @source_set = ProcessingTupleStream.new(projectPattern, projectPattern, @description)
         else
           @source_set = OMF::Rete::IndexedTupleSet.new(@description, indexPattern)
         end
         @store.registerTSet(@source_set, @description) if @store
       end
-      
+
       # Return the cost of this plan.
       #
       # TODO: Some more meaningful heuristic will be nice
@@ -65,8 +66,8 @@ module OMF::Rete
         end
         @cost
       end
-      
-      
+
+
       def describe(out = STDOUT, offset = 0, incr = 2, sep = "\n")
         out.write(" " * offset)
         desc = @description.collect do |e| e || '*' end

data/lib/omf_rete/store/alpha/alpha_element.rb

@@ -1,10 +1,10 @@
 
 module OMF::Rete::Store::Alpha
-   
+
     # Module internal class, will only be instantiated by +Store+
     #
     class AlphaElement
-      
+
       def self.create(level, length)
         rem = length - level
         if (rem > 1)
@@ -13,83 +13,12 @@ module OMF::Rete::Store::Alpha
           AlphaLeafElement.new(level)
         end
       end
-      
+
       def initialize(level)
         @level = level
       end
 
     end
 
-    class AlphaInnerElement < AlphaElement
-      
-      def initialize(level, length)
-        super(level)
-        @length = length
-        @children = {}
-        if (level < length)
-          @wildChild = AlphaElement.create(level + 1, length)
-        end
-      end
-      
-      # see Store
-      #
-      def registerTSet(tset, pattern)
-        pitem = pattern[@level]
-        if (pitem)  # not nil
-          child = (@children[pitem] ||= AlphaElement.create(@level + 1, @length))
-          child.registerTSet(tset, pattern)
-        else # wildcard
-          @wildChild.registerTSet(tset, pattern)
-        end
-      end
-
-      
-      def addTuple(tarray)
-        el = tarray[@level]
-        if (child = @children[el])
-          child.addTuple(tarray)
-        end
-        @wildChild.addTuple(tarray) if (@wildChild)
-      end
-    end # AlphaInnerElement
-    
-    # Module internal class, will only be instantiated by +Store+
-    #
-    class AlphaLeafElement < AlphaElement
-
-      def initialize(level)
-        super
-        @tsetIndex = {}
-        @tsetWildcards = []
-      end
-      
-      # see Store
-      #
-      def registerTSet(tset, pattern)
-        pitem = pattern[@level]
-        leaf = (@level == @length)
-        if (pitem)  # not nil
-          (@tsetIndex[pitem] ||= []) << tset
-        else # wildcard
-          @tsetWildcards << tset
-        end
-      end
-
-      def addTuple(tarray)
-        # check if we have any matching tsets
-        item = tarray[@level]
-        if (arr = @tsetIndex[item])
-          arr.each do |s|
-            s.addTuple(tarray)
-          end
-        end
-        @tsetWildcards.each do |s|
-          s.addTuple(tarray)
-        end
-      end
-      
-
 
-    end # AlphaLeafElement
-    
 end # Moana::Filter::Store::Alpha

data/lib/omf_rete/store/alpha/alpha_inner_element.rb

@@ -1,28 +1,9 @@
 require 'omf_rete/store/alpha/alpha_element'
 
 module OMF::Rete::Store::Alpha
-   
-    # Module internal class, will only be instantiated by +Store+
-    #
-    class AlphaElement
-      
-      def self.create(level, length)
-        rem = length - level
-        if (rem > 1)
-          AlphaInnerElement.new(level, length)
-        else
-          AlphaLeafElement.new(level)
-        end
-      end
-      
-      def initialize(level)
-        @level = level
-      end
-
-    end
 
     class AlphaInnerElement < AlphaElement
-      
+
       def initialize(level, length)
         super(level)
         @length = length
@@ -31,7 +12,7 @@ module OMF::Rete::Store::Alpha
           @wildChild = AlphaElement.create(level + 1, length)
         end
       end
-      
+
       # see Store
       #
       def registerTSet(tset, pattern)
@@ -44,7 +25,6 @@ module OMF::Rete::Store::Alpha
         end
       end
 
-      
       def addTuple(tarray)
         el = tarray[@level]
         if (child = @children[el])
@@ -52,45 +32,15 @@ module OMF::Rete::Store::Alpha
         end
         @wildChild.addTuple(tarray) if (@wildChild)
       end
-    end # AlphaInnerElement
-    
-    # Module internal class, will only be instantiated by +Store+
-    #
-    class AlphaLeafElement < AlphaElement
-
-      def initialize(level)
-        super
-        @tsetIndex = {}
-        @tsetWildcards = []
-      end
-      
-      # see Store
-      #
-      def registerTSet(tset, pattern)
-        pitem = pattern[@level]
-        leaf = (@level == @length)
-        if (pitem)  # not nil
-          (@tsetIndex[pitem] ||= []) << tset
-        else # wildcard
-          @tsetWildcards << tset
-        end
-      end
 
-      def addTuple(tarray)
-        # check if we have any matching tsets
-        item = tarray[@level]
-        if (arr = @tsetIndex[item])
-          arr.each do |s|
-            s.addTuple(tarray)
-          end
-        end
-        @tsetWildcards.each do |s|
-          s.addTuple(tarray)
+      def removeTuple(tarray)
+        el = tarray[@level]
+        if (child = @children[el])
+          child.removeTuple(tarray)
         end
+        @wildChild.removeTuple(tarray) if (@wildChild)
       end
-      
 
+    end # AlphaInnerElement
 
-    end # AlphaLeafElement
-    
 end # Moana::Filter::Store::Alpha

data/lib/omf_rete/store/alpha/alpha_leaf_element.rb

@@ -2,7 +2,7 @@
 require 'omf_rete/store/alpha/alpha_element'
 
 module OMF::Rete::Store::Alpha
-   
+
   # Module internal class, will only be instantiated by +Store+
   #
   class AlphaLeafElement < AlphaElement
@@ -12,7 +12,7 @@ module OMF::Rete::Store::Alpha
       @tsetIndex = {}
       @tsetWildcards = []
     end
-    
+
     # see Store
     #
     def registerTSet(tset, pattern)
@@ -37,5 +37,20 @@ module OMF::Rete::Store::Alpha
         s.addTuple(tarray)
       end
     end
-  end # AlphaLeafElement
+
+    def removeTuple(tarray)
+      # check if we have any matching tsets
+      item = tarray[@level]
+      if (arr = @tsetIndex[item])
+        arr.each do |s|
+          s.removeTuple(tarray)
+        end
+      end
+      @tsetWildcards.each do |s|
+        s.removeTuple(tarray)
+      end
+    end
+
+  end # class
+
 end # Moana::Filter::Store::Alpha