gecoder 0.8.3 → 0.9.0

data/specs/constraints/{boolean.rb → bool/boolean.rb}

@@ -1,5 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/constraint_helper'
+require File.dirname(__FILE__) + '/../constraint_helper'
 
 class BoolSampleProblem < Gecode::Model
   attr :b1
@@ -13,29 +12,114 @@ class BoolSampleProblem < Gecode::Model
   end
 end
 
-describe Gecode::Constraints::Bool do
-  before do
-    @model = BoolSampleProblem.new
-    @b1 = @model.b1
-    @b2 = @model.b2
-    @b3 = @model.b3
-    
-    # For constraint option spec.
-    @invoke_options = lambda do |hash| 
-      (@b1 | @b2).must_be.true(hash) 
-      @model.solve!
-    end
-    @expect_options = option_expectation do |strength, kind, reif_var|
-      @model.allow_space_access do
+[:true, :false].each do |type|
+  describe Gecode::Bool, " (must be #{type})" do
+    before do
+      @model = Gecode::Model.new
+      @bool = @model.bool_var
+
+      @types = [:bool]
+      @invoke = lambda do |receiver, hash| 
+        receiver.method(type).call(hash) 
+        @model.solve!
+      end
+      @expect = lambda do |var, opts, reif_var|
         # We only test the non-MiniModel parts.
         unless reif_var.nil?
           Gecode::Raw.should_receive(:rel).once.with(
             an_instance_of(Gecode::Raw::Space), 
-            an_instance_of(Gecode::Raw::BoolVar), Gecode::Raw::IRT_EQ, 
-            an_instance_of(Gecode::Raw::BoolVar), strength, kind)
+            an_instance_of(Gecode::Raw::BoolVar), 
+            (type == :true) ? Gecode::Raw::IRT_EQ : Gecode::Raw::IRT_NQ,
+            reif_var, *opts)
         end
       end
     end
+
+    it "should constrain variables to be #{type}" do
+      @bool.must.method(type).call
+      @model.solve!
+      @bool.value.should == (type == :true)
+    end
+    
+    it "should make negation constrain variables to not be #{type}" do
+      @bool.must_not.method(type).call
+      @model.solve!
+      @bool.value.should == (type != :true)
+    end  
+
+    it_should_behave_like 'reifiable constraint'
+  end
+end
+
+describe Gecode::Bool, " (implies)" do
+  before do
+    @model = Gecode::Model.new
+    @b1 = @model.bool_var
+    @b2 = @model.bool_var
+    @model.branch_on @model.wrap_enum([@b1, @b2])
+
+    @types = [:bool, :bool]
+    @invoke = lambda do |receiver, op, hash| 
+      receiver.imply(op, hash) 
+      @model.solve!
+    end
+    @expect = lambda do |var1, var2, opts, reif_var|
+    end
+  end
+
+  it "should constrain variables to imply each other" do
+    @b1.must.imply @b2
+    @model.solve!
+    (!@b1.value || @b2.value).should be_true
+  end
+  
+  it "should, when negated, constrain variables to not imply each other" do
+    @b1.must_not.imply @b2
+    @model.solve!
+    @b1.value.should be_true
+    @b2.value.should_not be_true
+  end  
+
+  it_should_behave_like 'reifiable constraint'
+end
+
+describe Gecode::Bool, " (equality)" do
+  before do
+    @model = Gecode::Model.new
+    @b1 = @model.bool_var
+    @b2 = @model.bool_var
+    @model.branch_on @model.wrap_enum([@b1, @b2])
+
+    @types = [:bool, :bool]
+    @invoke = lambda do |receiver, op, hash| 
+      receiver.equal(op, hash) 
+      @model.solve!
+    end
+    @expect = lambda do |var1, var2, opts, reif_var|
+    end
+  end
+
+  it "should constrain variables to equal each other" do
+    @b1.must == @b2
+    @model.solve!
+    @b1.value.should == @b2.value
+  end
+  
+  it "should, when negated, constrain variables to not equal each other" do
+    @b1.must_not == @b2
+    @model.solve!
+    @b1.value.should_not == @b2.value
+  end  
+
+  it_should_behave_like 'reifiable constraint'
+end
+
+describe Gecode::Bool do
+  before do
+    @model = BoolSampleProblem.new
+    @b1 = @model.b1
+    @b2 = @model.b2
+    @b3 = @model.b3
   end
 
   it 'should handle single variables constrainted to be true' do
@@ -229,14 +313,5 @@ describe Gecode::Constraints::Bool do
     sol = @model.solve!
     sol.b3.value.should be_true
   end
-  
-  it 'should raise error on right hand sides of incorrect type given to #==' do
-    lambda{ @b1.must == 'hello' }.should raise_error(TypeError) 
-  end
-
-  it 'should raise error on right hand sides of incorrect type given to #imply' do
-    lambda{ @b1.must.imply 'hello' }.should raise_error(TypeError) 
-  end
-
-  it_should_behave_like 'reifiable constraint'
 end
+

data/specs/constraints/bool/boolean_properties.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../property_helper'
+
+[:&, :|, :^].each do |property|
+  describe Gecode::Bool, " (#{property} property)" do
+    before do
+      @model = Gecode::Model.new
+      @b1 = @model.bool_var
+      @b2 = @model.bool_var
+      @model.branch_on @model.wrap_enum([@b1, @b2])
+
+      # For bool operand producing property spec.
+      @property_types = [:bool, :bool]
+      @select_property = lambda do |bool1, bool2|
+        bool1.method(property).call bool2
+      end
+      @selected_property = @b1.method(property).call @b2
+    end
+
+    it 'should constrain the conjunction/disjunction/exclusive disjunction' do
+      (@b1.method(property).call @b2).must_be.true
+      @model.solve!
+      @b1.value.method(property).call(@b2.value).should be_true
+    end
+
+    it_should_behave_like 'property that produces bool operand'
+  end
+end
+
+describe Gecode::Bool, ' (#implies property)' do
+  before do
+    @model = Gecode::Model.new
+    @b1 = @model.bool_var
+    @b2 = @model.bool_var
+    @model.branch_on @model.wrap_enum([@b1, @b2])
+
+    # For bool operand producing property spec.
+    @property_types = [:bool, :bool]
+    @select_property = lambda do |bool1, bool2|
+      bool1.implies bool2
+    end
+    @selected_property = @b1.implies @b2
+  end
+
+  it 'should constrain the implication' do
+    (@b1.implies @b2).must_be.true
+    @model.solve!
+    (!@b1.value | @b2.value).should be_true
+  end
+
+  it_should_behave_like 'property that produces bool operand'
+end

data/specs/constraints/bool/linear.rb

@@ -0,0 +1,213 @@
+require File.dirname(__FILE__) + '/../constraint_helper'
+
+class BoolLinearSampleProblem < Gecode::Model
+  attr :x
+  attr :y
+  attr :z
+  
+  def initialize
+    @x = self.bool_var
+    @y = self.bool_var
+    @z = self.bool_var
+    branch_on wrap_enum([@x, @y, @z])
+  end
+end
+
+class TrueClass
+  def to_i
+    1
+  end
+end
+
+class FalseClass
+  def to_i
+    0
+  end
+end
+
+describe Gecode::Int::Linear, '(with booleans)' do
+  before do
+    @model = BoolLinearSampleProblem.new
+    @x = @model.x
+    @y = @model.y
+    @z = @model.z
+    @operand = @x + @y
+  end
+
+  it 'should handle addition with a variable' do
+    (@x + @y).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (x + y).should be_zero
+  end
+  
+  it 'should handle reification (1)' do
+    bool = @model.bool_var
+    (@x + @y).must.equal(0, :reify => bool)
+    bool.must_be.false
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (x + y).should_not be_zero
+  end
+
+  it 'should handle reification (2)' do
+    bool = @model.bool_var
+    (@x + @y).must.equal(0, :reify => bool)
+    bool.must_be.true
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (x + y).should be_zero
+  end
+  
+  it 'should handle addition with multiple variables' do
+    (@x + @y + @z).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    (x + y + z).should be_zero
+  end
+  
+  it 'should handle subtraction with a variable' do
+    (@x - @y).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (x - y).should be_zero
+  end
+  
+  it 'should handle non-zero constants as right hand side' do
+    (@x + @y).must == 1
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (x + y).should equal(1)
+  end
+  
+  it 'should handle single booleans as left hand side' do
+    @x.must == @y + 1 
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    x.should equal(y + 1)
+  end
+
+  it 'should handle single booleans as left hand side (2)' do
+    @x.must == @y + @z 
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    x.should equal(y + z)
+  end
+
+  it 'should handle single booleans as left hand side (3)' do
+    bool = @model.bool_var
+    @x.must.equal(@y + @z, :reify => bool)
+    bool.must_be.false
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    x.should_not equal(y + z)
+  end
+
+  it 'should handle variables as right hand side' do
+    (@x + @y).must == @z
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    (x + y).should equal(z)
+  end
+  
+  it 'should handle linear expressions as right hand side' do
+    (@x + @y).must == @z + @y
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    (x + y).should equal(z + y)
+  end
+  
+  it 'should raise error on invalid right hand sides' do
+    lambda do 
+      (@x + @y).must == 'z'
+    end.should raise_error(TypeError) 
+  end
+
+  it 'should raise error if a fixnum is not used in multiplication' do
+    lambda do
+      (@x * @y).must == 0
+    end.should raise_error(TypeError) 
+  end
+
+  it 'should raise error if bools are combined with integer variables' do
+    lambda do
+      (@x + @model.int_var).must == 0
+    end.should raise_error(TypeError)
+  end
+  
+  it 'should handle coefficients other than 1' do
+    (@x * 2 + @y).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    (2*x + y).should equal(0)
+  end
+  
+  it 'should handle addition with constants' do
+    (@y + 1).must == 1
+    sol = @model.solve!
+    y = sol.y.value.to_i
+    (y + 1).should equal(1)
+  end
+  
+  it 'should handle subtraction with a constant' do
+    (@x - 1).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    (x - 1).should be_zero
+  end
+
+  it 'should handle parenthesis' do
+    (@x - (@y + @z)).must == 1
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    (x - (y + z)).should equal(1)
+  end
+
+  it 'should handle multiplication of parenthesis' do
+    (((@x + @y*10)*10 + @z)*10).must == 0
+    sol = @model.solve!
+    x = sol.x.value.to_i
+    y = sol.y.value.to_i
+    z = sol.z.value.to_i
+    (((x + y*10)*10 + z)*10).should equal(0)
+  end
+  
+  relations = ['>', '>=', '<', '<=', '==']
+  
+  relations.each do |relation|
+    it "should handle #{relation} with constant integers" do
+      (@x + @y).must.send(relation, 1)
+      sol = @model.solve!
+      sol.should_not be_nil
+      (sol.x.value.to_i + sol.y.value.to_i).should.send(relation, 1)
+    end
+  end
+  
+  relations.each do |relation|
+    it "should handle negated #{relation} with constant integers" do
+      (@x + @y).must_not.send(relation, 1)
+      sol = @model.solve!
+      sol.should_not be_nil
+      (sol.x.value.to_i + sol.y.value.to_i).should_not.send(relation, 1)
+    end
+  end
+end

data/specs/constraints/bool_enum/bool_enum_relation.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../property_helper'
+
+class BoolEnumSampleProblem < Gecode::Model
+  attr :bools
+  attr :b1
+  attr :b2
+  
+  def initialize
+    @bools = bool_var_array(4)
+    @b1 = bool_var
+    @b2 = bool_var
+    branch_on @bools
+    branch_on wrap_enum([@b1, @b2])
+  end
+end
+
+# Expects @stub, which contains the started constraint and @compute_result 
+# which computes whether the left hand side is true or not.
+describe 'bool enum relation constraint', :shared => true do
+  it 'should handle being constrained to be true' do
+    @stub.must_be.true
+    @model.solve!
+    @compute_result.call.should be_true
+  end
+  
+  it 'should handle being constrained to be negated true' do
+    @stub.must_not_be.true
+    @model.solve!
+    @compute_result.call.should_not be_true
+  end
+  
+  it 'should handle being constrained to be false' do
+    @stub.must_be.false
+    @model.solve!
+    @compute_result.call.should_not be_true
+  end
+  
+  it 'should handle being constrained to be negated false' do
+    @stub.must_not_be.false
+    @model.solve!
+    @compute_result.call.should be_true
+  end
+  
+  it 'should handle being constrained to be equal to a variable' do
+    @stub.must_be == @b1
+    @model.solve!
+    @compute_result.call.should == @b1.value
+  end
+  
+  it 'should handle being constrained to not be equal to a variable' do
+    @stub.must_not_be == @b1
+    @model.solve!
+    @compute_result.call.should_not == @b1.value
+  end
+  
+  it 'should handle being constrained to be equal to be a nested expression' do
+    @stub.must_be == (@b1 | @b2) & @b1
+    @model.solve!
+    @compute_result.call.should == (@b1.value | @b2.value) & @b1.value
+  end
+  
+  it 'should handle being constrained to not be equal to be a nested expression' do
+    @stub.must_not_be == (@b1 | @b2) & @b1
+    @model.solve!
+    @compute_result.call.should_not == (@b1.value | @b2.value) & @b1.value
+  end
+end
+
+describe Gecode::BoolEnum::Relation, ' (conjunction)' do
+  before do
+    @model = BoolEnumSampleProblem.new
+    @bools = @model.bools
+    @b1 = @model.b1
+    @b2 = @model.b2
+    
+    # For property spec.
+    @property_types = [:bool_enum]
+    @select_property = lambda do |bool_enum|
+      bool_enum.conjunction
+    end
+    @selected_property = @bools.conjunction
+    @constraint_class = Gecode::BlockConstraint
+    
+    # For bool enum spec.
+    @stub = @selected_property
+    @compute_result = lambda{ @bools.all?{ |b| b.value } }
+  end
+  
+  it_should_behave_like 'bool enum relation constraint'
+  it_should_behave_like(
+    'property that produces bool operand by short circuiting equality')
+end
+
+describe Gecode::BoolEnum::Relation, ' (disjunction)' do
+  before do
+    @model = BoolEnumSampleProblem.new
+    @bools = @model.bools
+    @b1 = @model.b1
+    @b2 = @model.b2
+    
+    # For constraint option spec.
+    @property_types = [:bool_enum]
+    @select_property = lambda do |bool_enum|
+      bool_enum.disjunction
+    end
+    @selected_property = @bools.disjunction
+    @constraint_class = Gecode::BlockConstraint
+    
+    # For bool enum spec.
+    @stub = @selected_property
+    @compute_result = lambda{ @bools.any?{ |b| b.value } }
+  end
+  
+  it_should_behave_like 'bool enum relation constraint'
+  it_should_behave_like(
+    'property that produces bool operand by short circuiting equality')
+end