prop_logic 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ed096886dc984eabcd875c578b78a074b5c8b90
-  data.tar.gz: e449635063d3c36226d7efae7db50d0aaddc26be
+  metadata.gz: 4bf3b6daa1a3ae0949907abf3a4ea6e5410c214f
+  data.tar.gz: 851df2ca76ce16d822389c1e6d6842c6f36863fe
 SHA512:
-  metadata.gz: 8635b171e757d2e5bde2f2e16cf37baae110780dedaec0d76b703ae5c5c7189ca3095e45d8d4f31db3d4feb957c6bb990c38a782ad633544623b7f2e4e8067f6
-  data.tar.gz: 66febccd6887ec890e1e56aca6d6929c13381843d2953fc32b30233f0ac528ac9940482cb7eb08dfba5108c01016963d8198fb42a340de31476c40f31ccefa94
+  metadata.gz: 8c2079a701b5827e330b06c662a2a12a3620f68da7519604bc90db2448ac78ac8772df48b4671c83eb98273be3be5f8e1aeeb890dadce449f285026db31bd754
+  data.tar.gz: 1cd28c2060c5898327889adfb6cf28a268cd6101f60f5030c5abdc37aff699579b7f87977278c7bb70951b94b6261db79a4fe9e866a2cb52758ae2b4699beae5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Ver. 0.2.0 (2016/03/13)
+- Add interface for incremental solver
+- add `Term#each_sat`
+
 # Ver. 0.1.3 (2016/03/11)
 - Code cleanup
 - save `PropLogic.sat_solver` to module instance variable (no interface change)

data/README.md

@@ -112,6 +112,9 @@ CNF is one of these:
 
 `#unsat?` returns `true` if unsatisfiable, `false` otherwise.
 
+#### SAT enumrator
+`#each_sat` is an enumerator for all satifiabilities. Returns `Enumerator` if calling without block.
+
 ### `PropLogic` module methods
 #### `PropLogic.new_variable(name = nil)`
 declare new variable with name `name`. if `name` is not supplied, unique name is set.
@@ -124,6 +127,10 @@ calculate all and/or of `terms`. Use this when and/or calculation for many varia
 #### `PropLogic.sat_solver`/ PropLogic.sat_solver=`
 set/get SAT solver object. It shoud have `#call(term)` method and return value is described in `Term#sat?`.
 
+#### `PropLogic.incremental_solver`/ PropLogic.incremental_solver=`
+set/get incremental SAT solver object. It shoud be class with `#add` and `#sat?` methods.
+(see `DefaultIncrementalSolver` for its interface)
+
 ### Information
 `PropLogic::Term` has some subclasses, but these classes are subject to change.
 Using subclasses of `PropLogic::Term` directly is not recommended.

data/lib/prop_logic/default_incremental_solver.rb

@@ -0,0 +1,33 @@
+module PropLogic
+  #
+  # Default implementation of incremental SAT solver.
+  # Provided for reference implementation and avoiding non-existent error.
+  # (Using normal solver, not incrementally)
+  #
+  class DefaultIncrementalSolver
+    # @param [Term] initial term
+    def initialize(term)
+      @term = term
+    end
+
+    # Current term
+    attr_reader :term
+
+    # Adding new terms to this solver.
+    # @param [Term] terms to add.
+    # @return [DefaultIncrementalSolver] self
+    def add(*terms)
+      @term = @term.and(*terms)
+      self
+    end
+
+    alias_method :<<, :add
+
+    # Check satisfiability of terms.
+    # @return [Term] if satisfied
+    # @return [false] if unsatisfied
+    def sat?
+      @term.sat?
+    end
+  end
+end

data/lib/prop_logic/functions.rb

@@ -1,16 +1,40 @@
 module PropLogic
+  #
+  # Utility methods for PropLogic.
+  #
   module Functions
+
     module_function
+
+    # Combine all terms with or.
+    # @param [Term] terms to combine
+    # @return [Term] combined term
     def all_or(*args)
       Term.get OrTerm, *args
     end
 
+    # Combine all terms with and.
+    # @param [Term] terms to combine
+    # @return [Term] combined term
     def all_and(*args)
       Term.get AndTerm, *args
     end
 
+    # Create new variable.
     def new_variable(*args)
-      Variable.new *args
+      Variable.new(*args)
+    end
+
+    # loop while satisfiable.
+    # Note: Loop continues infinitely if no addition was given inside the loop.
+    # @yield [Term, IncrementalSolver] yield for each term.
+    def sat_loop(initial_term)
+      incremental = PropLogic.incremental_solver.new initial_term
+      loop do
+        sat = incremental.sat?
+        break unless sat
+        yield sat, incremental
+      end
     end
   end
 
@@ -20,7 +44,7 @@ module PropLogic
 
   def all_combination(arr)
     0.upto(arr.length) do |num|
-      arr.combination(num){|c| yield c}
+      arr.combination(num) { |c| yield c }
     end
   end
 

data/lib/prop_logic/sat_solver.rb

@@ -3,6 +3,7 @@ module PropLogic
   # default SAT solver.
   # only intended for test use.
   @sat_solver = PropLogic::BruteForceSatSolver
+  @incremental_solver = PropLogic::DefaultIncrementalSolver
 
   class << self
     # @return [Object] current SAT solver
@@ -14,5 +15,9 @@ module PropLogic
       raise TypeError unless engine.respond_to?(:call)
       @sat_solver = engine
     end
+
+    # curreent incremental solver
+    attr_accessor :incremental_solver
+
   end
 end

data/lib/prop_logic/term.rb

@@ -2,13 +2,19 @@ require 'ref'
 require 'prop_logic/functions'
 
 module PropLogic
+  #
+  # Abstract base class for terms of PropLogic.
+  # Actual terms are subclasses of Term.
+  #
   class Term
     include Functions
 
+    # @raise NotImplementedError Term is abstract class.
     def initialize
       raise NotImplementedError, 'Term cannot be initialized'
     end
 
+    # disallow duplication
     def initialize_copy(*)
       raise TypeError, 'Term cannot be duplicated (immutable, not necessary)'
     end
@@ -112,10 +118,13 @@ module PropLogic
       ret.freeze
     end
 
+    # check if this term is a cnf term.
+    # @return [Boolean] false unless overridden.
     def cnf?
       false
     end
 
+    # @return [Array] variables used by this term.
     def variables
       @variables ||= @terms.map(&:variables).flatten.uniq
     end
@@ -146,6 +155,17 @@ module PropLogic
       PropLogic.sat_solver.call(self)
     end
 
+    # loop with each satisfied terms.
+    # @return [Enumerator] if block is not given.
+    # @return [nil] if block is given.
+    def each_sat
+      return to_enum(:each_sat) unless block_given?
+      sat_loop(self) do |sat, solver|
+        yield sat
+        solver << ~sat
+      end
+    end
+
     def unsat?
       sat? == false
     end

data/lib/prop_logic/version.rb

@@ -1,3 +1,3 @@
 module PropLogic
-  VERSION = "0.1.3"
+  VERSION = '0.2.0'
 end

data/lib/prop_logic.rb

@@ -1,11 +1,12 @@
-require "prop_logic/version"
-require "prop_logic/term"
+require 'prop_logic/version'
+require 'prop_logic/term'
 require 'prop_logic/functions'
-require "prop_logic/and_term"
-require "prop_logic/or_term"
-require "prop_logic/not_term"
-require "prop_logic/then_term"
+require 'prop_logic/and_term'
+require 'prop_logic/or_term'
+require 'prop_logic/not_term'
+require 'prop_logic/then_term'
 require 'prop_logic/variable'
 require 'prop_logic/constants'
 require 'prop_logic/brute_force_sat_solver'
+require 'prop_logic/default_incremental_solver'
 require 'prop_logic/sat_solver'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop_logic
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jkr2255
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ref
@@ -87,6 +87,7 @@ files:
 - lib/prop_logic/and_term.rb
 - lib/prop_logic/brute_force_sat_solver.rb
 - lib/prop_logic/constants.rb
+- lib/prop_logic/default_incremental_solver.rb
 - lib/prop_logic/functions.rb
 - lib/prop_logic/not_term.rb
 - lib/prop_logic/or_term.rb