gecoder-with-gecode 0.8.1 → 0.8.2

data/specs/constraints/distinct.rb

@@ -8,7 +8,7 @@ class DistinctSampleProblem < Gecode::Model
   def initialize
     @vars = int_var_array(2, 1)
     @sets = set_var_array(2, [], 0..2)
-    branch_on wrap_enum(@sets)
+    branch_on @sets
   end
 end
 

data/specs/constraints/extensional.rb

@@ -1,25 +1,59 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require File.dirname(__FILE__) + '/constraint_helper'
 
-describe Gecode::Constraints::IntEnum::Extensional do
+# Assumes that @variables, @expected_array and @tuples are defined.
+describe 'tuple constraint', :shared => true do
   before do
-    @model = Gecode::Model.new
-    @tuples = [[1,7], [5,1]]
-    @digits = @model.int_var_array(2, 0..9)
-    @model.branch_on @digits
-    
     @invoke_options = lambda do |hash| 
-      @digits.must_be.in(@tuples, hash) 
+      @variables.must_be.in(@tuples, hash) 
       @model.solve!
     end
     @expect_options = option_expectation do |strength, kind, reif_var|
       Gecode::Raw.should_receive(:extensional).once.with(
         an_instance_of(Gecode::Raw::Space), 
-        an_instance_of(Gecode::Raw::IntVarArray), 
+        @expected_array, 
         an_instance_of(Gecode::Raw::TupleSet), strength, kind)
     end
   end
   
+  it 'should not allow negation' do
+    lambda do 
+      @variables.must_not_be.in @tuples
+    end.should raise_error(Gecode::MissingConstraintError)
+  end
+  
+  it 'should not allow empty tuples' do
+    lambda do 
+      @variables.must_be.in []
+    end.should raise_error(ArgumentError)
+  end
+  
+  it 'should not allow tuples of sizes other than the number of variables' do
+    lambda do 
+      @variables.must_be.in([@tuples.first * 2])
+    end.should raise_error(ArgumentError)
+  end
+  
+  it 'should raise error if the right hand side does not contain tuples of correct type' do
+    lambda do 
+      size = @variables.size
+      @variables.must_be.in ['h'*size, 'i'*size] 
+    end.should raise_error(TypeError)
+  end
+  
+  it_should_behave_like 'non-reifiable constraint'
+end
+
+describe Gecode::Constraints::IntEnum::Extensional do
+  before do
+    @model = Gecode::Model.new
+    @tuples = [[1,7], [5,1]]
+    @variables = @digits = @model.int_var_array(2, 0..9)
+    @model.branch_on @digits
+    
+    @expected_array = an_instance_of Gecode::Raw::IntVarArray
+  end
+  
   it 'should constrain the domain of all variables' do
     @digits.must_be.in @tuples
     
@@ -32,12 +66,6 @@ describe Gecode::Constraints::IntEnum::Extensional do
     (found_solutions - @tuples).should be_empty
   end
   
-  it 'should not allow negation' do
-    lambda do 
-      @digits.must_not_be.in @tuples
-    end.should raise_error(Gecode::MissingConstraintError) 
-  end
-  
   it 'should raise error if the right hand side is not an enumeration' do
     lambda{ @digits.must_be.in 4711 }.should raise_error(TypeError)
   end
@@ -46,30 +74,17 @@ describe Gecode::Constraints::IntEnum::Extensional do
     lambda{ @digits.must_be.in [17, 4711] }.should raise_error(TypeError)
   end
   
-  it 'should raise error if the right hand side does not contain integer tuples' do
-    lambda{ @digits.must_be.in ['hello'] }.should raise_error(TypeError)
-  end
-  
-  it_should_behave_like 'non-reifiable constraint'
+  it_should_behave_like 'tuple constraint'
 end
 
 describe Gecode::Constraints::BoolEnum::Extensional do
   before do
     @model = Gecode::Model.new
     @tuples = [[true, false, true], [false, false, true]]
-    @bools = @model.bool_var_array(3)
+    @variables = @bools = @model.bool_var_array(3)
     @model.branch_on @bools
     
-    @invoke_options = lambda do |hash| 
-      @bools.must_be.in(@tuples, hash) 
-      @model.solve!
-    end
-    @expect_options = option_expectation do |strength, kind, reif_var|
-      Gecode::Raw.should_receive(:extensional).once.with(
-        an_instance_of(Gecode::Raw::Space), 
-        an_instance_of(Gecode::Raw::BoolVarArray), 
-        an_instance_of(Gecode::Raw::TupleSet), strength, kind)
-    end
+    @expected_array = an_instance_of Gecode::Raw::BoolVarArray
   end
   
   it 'should constrain the domain of all variables' do
@@ -84,12 +99,6 @@ describe Gecode::Constraints::BoolEnum::Extensional do
     (found_solutions - @tuples).should be_empty
   end
   
-  it 'should not allow negation' do
-    lambda do 
-      @bools.must_not_be.in @tuples
-    end.should raise_error(Gecode::MissingConstraintError) 
-  end
-  
   it 'should raise error if the right hand side is not an enumeration' do
     lambda{ @bools.must_be.in true }.should raise_error(TypeError)
   end
@@ -98,9 +107,5 @@ describe Gecode::Constraints::BoolEnum::Extensional do
     lambda{ @bools.must_be.in [true, false] }.should raise_error(TypeError)
   end
   
-  it 'should raise error if the right hand side does not contain boolean tuples' do
-    lambda{ @bools.must_be.in ['hello'] }.should raise_error(TypeError)
-  end
-  
-  it_should_behave_like 'non-reifiable constraint'
+  it_should_behave_like 'tuple constraint'
 end

data/specs/constraints/linear.rb

@@ -240,6 +240,14 @@ describe Gecode::Constraints::Int::Linear, '(with booleans)' do
     (x + y).should equal(1)
   end
   
+  it 'should handle singe 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 variables as right hand side' do
     (@x + @y).must == @z
     sol = @model.solve!

data/specs/enum_wrapper.rb

@@ -40,6 +40,13 @@ describe Gecode::Model, ' (enum wrapping)' do
     end.should raise_error(ArgumentError)
   end
   
+  it 'should not allow wrapping a wrapped enumerable' do
+    lambda do 
+      enum = [@bool]
+      @model.wrap_enum(@model.wrap_enum(enum)) 
+    end.should raise_error(ArgumentError)
+  end
+  
   it 'should not allow enumerables without variables or fixnums to be wrapped' do
     lambda do 
       @model.wrap_enum(['foo']) 
@@ -119,4 +126,4 @@ describe Gecode::FixnumEnumMethods do
   it 'should compute the smallest domain range' do
     @enum.domain_range.should == (7..4711)
   end
-end
+end

data/specs/search.rb

@@ -65,6 +65,12 @@ describe Gecode::Model, ' (with multiple solutions)' do
       s.var.should have_domain(@solved_domain)
     end
   end
+
+  it 'should update the search statistics before yielding to #solution' do
+    @model.solution do |s|
+      @model.search_stats.should_not be_nil
+    end
+  end
   
   it 'should only evaluate the block for one solution in #solution' do
     i = 0
@@ -83,6 +89,18 @@ describe Gecode::Model, ' (with multiple solutions)' do
     end
     Set.new(solutions).should == Set.new([2,3])
   end
+  
+  it 'should update the search statistics before yielding to #each_solution' do
+    solutions = []
+    old_stats = @model.search_stats
+    old_stats.should be_nil
+    @model.each_solution do |s|
+      solutions << s.var.value
+      @model.search_stats.should_not == old_stats
+      @model.search_stats.should_not be_nil
+      old_stats = @model.search_stats
+    end
+  end
 end
 
 describe Gecode::Model, ' (after #solve!)' do
@@ -114,6 +132,15 @@ describe Gecode::Model, ' (after #solve!)' do
     enum[2].first.should have_domain(@solved_domain)
     enum[3][1][:b].should have_domain(@solved_domain)
   end
+  
+  it 'should have updated the search statistics' do
+    stats = @model.search_stats
+    stats[:propagations].should == 0
+    stats[:failures].should == 0
+    stats[:clones].should_not be_nil
+    stats[:commits].should_not be_nil
+    stats[:memory].should > 0
+  end
 end
 
 describe 'reset model', :shared => true do
@@ -126,6 +153,10 @@ describe 'reset model', :shared => true do
     enum[2].first.should have_domain(@reset_domain)
     enum[3][1][:b].should have_domain(@reset_domain)
   end
+  
+  it 'should have cleared the search statistics' do
+    @model.search_stats.should be_nil
+  end
 end
 
 describe Gecode::Model, ' (after #reset!)' do
@@ -205,66 +236,6 @@ describe Gecode::Model, '(optimization search)' do
     solution.z.value.should == 25
   end
   
-  it 'should support maximizing singe variables given as symbols' do
-    solution = SampleOptimizationProblem.new.maximize! :z
-    solution.should_not be_nil
-    solution.x.value.should == 5
-    solution.y.value.should == 5
-    solution.z.value.should == 25
-  end
-  
-  it 'should support maximizing singe variables given as strings' do
-    solution = SampleOptimizationProblem.new.maximize! 'z'
-    solution.should_not be_nil
-    solution.x.value.should == 5
-    solution.y.value.should == 5
-    solution.z.value.should == 25
-  end
-  
-  it 'should raise error if maximize! is given a non-existing method' do
-    lambda do
-      SampleOptimizationProblem.new.maximize! :does_not_exist
-    end.should raise_error(NameError)
-  end
-  
-  it 'should raise error if maximize! is given a method that does not return an integer variable' do
-    lambda do
-      SampleOptimizationProblem.new.maximize! :object_id
-    end.should raise_error(ArgumentError)
-  end
-  
-  it 'should support minimizing singe variables given as symbols' do
-    problem = SampleOptimizationProblem.new
-    problem.z.must > 2
-    solution = problem.minimize! :x
-    solution.should_not be_nil
-    solution.x.value.should == 1
-    solution.y.value.should == 3
-    solution.z.value.should == 3
-  end
-  
-  it 'should support minimizing singe variables given as strings' do
-    problem = SampleOptimizationProblem.new
-    problem.z.must > 2
-    solution = problem.minimize! 'x'
-    solution.should_not be_nil
-    solution.x.value.should == 1
-    solution.y.value.should == 3
-    solution.z.value.should == 3
-  end
-  
-  it 'should raise error if minimize! is given a non-existing method' do
-    lambda do
-      SampleOptimizationProblem.new.minimize! :does_not_exist
-    end.should raise_error(NameError)
-  end
-  
-  it 'should raise error if minimize! is given a method that does not return an integer variable' do
-    lambda do
-      SampleOptimizationProblem.new.minimize! :object_id
-    end.should raise_error(ArgumentError)
-  end
-  
   it 'should not be bothered by garbage collecting' do
     # This goes through 400+ spaces.
     solution = SampleOptimizationProblem2.new.optimize! do |model, best_so_far|
@@ -303,4 +274,91 @@ describe Gecode::Model, '(optimization search)' do
     solution.y.value.should == 5
     solution.z.value.should == 25
   end
-end
+  
+  it 'should update the search statistics' do
+    model = SampleOptimizationProblem.new
+    solution = model.maximize! :z
+    
+    stats = model.search_stats
+    stats.should_not be_nil
+    stats[:propagations].should be_between(1, 100)
+    stats[:failures].should be_between(1, 100)
+    stats[:clones].should_not be_nil
+    stats[:commits].should_not be_nil
+    stats[:memory].should > 0
+  end
+end
+
+describe 'single variable optimization', :shared => true do
+  it "should support #{@method_name} having the variable given as a symbol" do
+    solution = @model.method(@method_name).call(@variable_name.to_sym)
+    @expect_to_be_correct.call(solution)
+  end
+  
+  it "should support #{@method_name} having the variable given as a string" do
+    solution = @model.method(@method_name).call(@variable_name.to_s)
+    @expect_to_be_correct.call(solution)
+  end
+  
+  it "should raise error if #{@method_name} is given a non-existing method" do
+    lambda do
+      SampleOptimizationProblem.new.method(@method_name).call(:does_not_exist)
+    end.should raise_error(NameError)
+  end
+  
+  it "should raise error if #{@method_name} is given a method that does not return an integer variable" do
+    lambda do
+      SampleOptimizationProblem.new.method(@method_name).call(:object_id)
+    end.should raise_error(ArgumentError)
+  end
+  
+  it 'should update the search statistics' do
+    @model.method(@method_name).call(@variable_name.to_sym)
+    
+    stats = @model.search_stats
+    stats.should_not be_nil
+    stats[:propagations].should be_between(1, 100)
+    stats[:failures].should be_between(1, 100)
+    stats[:clones].should_not be_nil
+    stats[:commits].should_not be_nil
+    stats[:memory].should > 0
+  end
+end
+
+describe Gecode::Model, '(single variable minimization)' do
+  before do
+    @method_name = 'minimize!'
+    @variable_name = 'x'
+    
+    @model = SampleOptimizationProblem.new
+    @model.z.must > 2
+    
+    @expect_to_be_correct = lambda do |solution|
+      solution.should_not be_nil
+      solution.x.value.should == 1
+      solution.y.value.should == 3
+      solution.z.value.should == 3
+    end
+  end
+  
+  it_should_behave_like 'single variable optimization'
+end
+
+describe Gecode::Model, '(single variable maximization)' do
+  before do
+    @method_name = 'maximize!'
+    @variable_name = 'z'
+    
+    @model = SampleOptimizationProblem.new
+    
+    @expect_to_be_correct = lambda do |solution|
+      solution.should_not be_nil
+      solution.x.value.should == 5
+      solution.y.value.should == 5
+      solution.z.value.should == 25
+    end
+  end
+  
+  it_should_behave_like 'single variable optimization'
+end
+

data/specs/spec_helper.rb

@@ -58,34 +58,6 @@ module CustomVarMatchers
   def have_bounds(expected_glb, expected_lub)
     HaveBounds.new(expected_glb, expected_lub)
   end
-  
-  class IsAlias
-    def initialize(expected)
-      @expected = expected.to_a
-    end
-    
-    def matches?(target)
-      @target = target
-      return false unless @target.size == @expected.size
-      @expected.each do |element|
-        return false unless @target.in(element)
-      end
-      return true
-    end
-    
-    def failure_message
-      "expected #{@target.inspect} to be an alias of #{@expected.inspect}"
-    end
-    
-    def negative_failure_message
-      "expected #{@target.inspect} not to be an alias of #{@expected.inspect}"
-    end
-  end
-
-  # Tests whether a method with a specified name is the alias of another.
-  def is_alias_of(expected)
-    HaveDomain.new(expected)
-  end
 end
 
 Spec::Runner.configure do |config|

data/tasks/distribution.rake

@@ -54,7 +54,7 @@ spec = Gem::Specification.new do |s|
   s.files = FileList[
     '[A-Z]*',
     'lib/**/*.rb', 
-    'example/**/*',
+    'example/**/*.rb',
     'src/**/*',
     'vendor/rust/**/*',
     'tasks/**/*',
@@ -136,8 +136,7 @@ end
 
 desc 'Publish packages on RubyForge'
 task :publish_packages => [:publish_gecoder_packages, 
-  :publish_gecoder_with_gecode_packages,
-  :publish_gecoder_with_gecode_mswin32_packages]
+  :publish_gecoder_with_gecode_packages]
 
 # Files included in the vanilla Gecode/R release.
 vanilla_release_files = [