gecoder 0.9.0 → 0.9.1

data/lib/gecoder/interface/search.rb

@@ -7,14 +7,14 @@ module Gecode
     end
   end
 
-  class Model
+  module Mixin
     # Finds the first solution to the modelled problem and updates the variables
     # to that solution. The found solution is also returned. Raises
     # Gecode::NoSolutionError if no solution can be found.
     def solve!
       dfs = dfs_engine
       space = dfs.next
-      @statistics = dfs.statistics
+      @gecoder_mixin_statistics = dfs.statistics
       raise Gecode::NoSolutionError if space.nil?
       self.active_space = space
       return self
@@ -24,7 +24,7 @@ module Gecode
     # propagation might have been performed). Returns the reset model.
     def reset!
       self.active_space = base_space
-      @statistics = nil
+      @gecoder_mixin_statistics = nil
       return self
     end
     
@@ -48,7 +48,7 @@ module Gecode
       next_solution = nil
       while not (next_solution = dfs.next).nil?
         self.active_space = next_solution
-        @statistics = dfs.statistics
+        @gecoder_mixin_statistics = dfs.statistics
         yield self
       end
       self.reset!
@@ -64,26 +64,27 @@ module Gecode
     # [:commits]        The number of commit operations performed.
     # [:memory]         The peak memory allocated to Gecode.
     def search_stats
-      return nil if @statistics.nil?
+      return nil if @gecoder_mixin_statistics.nil?
       
       return {
-        :propagations => @statistics.propagate,
-        :failures     => @statistics.fail,
-        :clones       => @statistics.clone,
-        :commits      => @statistics.commit,
-        :memory       => @statistics.memory
+        :propagations => @gecoder_mixin_statistics.propagate,
+        :failures     => @gecoder_mixin_statistics.fail,
+        :clones       => @gecoder_mixin_statistics.clone,
+        :commits      => @gecoder_mixin_statistics.commit,
+        :memory       => @gecoder_mixin_statistics.memory
       }
     end
     
-    # Finds the optimal solution. Optimality is defined by the provided block
-    # which is given one parameter, a solution to the problem. The block should
-    # constrain the solution so that that only "better" solutions can be new 
-    # solutions. For instance if one wants to optimize a variable named price
-    # (accessible from the model) to be as low as possible then one should write
-    # the following.
+    # Finds the optimal solution. Optimality is defined by the provided
+    # block which is given two parameters, the model and the best
+    # solution found so far to the problem. The block should constrain
+    # the model so that that only "better" solutions can be new
+    # solutions. For instance if one wants to optimize a variable named
+    # price (accessible from the model) to be as low as possible then
+    # one should write the following.
     #
     #   model.optimize! do |model, best_so_far|
-    #     model.price.must < best_so_far.price.val
+    #     model.price.must < best_so_far.price.value
     #   end
     #
     # Raises Gecode::NoSolutionError if no solution can be found.
@@ -92,12 +93,12 @@ module Gecode
       perform_queued_gecode_interactions
 
       # Set the method used for constrain calls by the BAB-search.
-      Model.constrain_proc = lambda do |home_space, best_space|
+      Mixin.constrain_proc = lambda do |home_space, best_space|
         self.active_space = best_space
-        @variable_creation_space = home_space
+        @gecoder_mixin_variable_creation_space = home_space
         yield(self, self)
         self.active_space = home_space
-        @variable_creation_space = nil
+        @gecoder_mixin_variable_creation_space = nil
         
         perform_queued_gecode_interactions
       end
@@ -114,10 +115,10 @@ module Gecode
       until (previous_solution = bab.next).nil?
         result = previous_solution
       end
-      @statistics = bab.statistics
+      @gecoder_mixin_statistics = bab.statistics
       
       # Reset the method used constrain calls and return the result.
-      Model.constrain_proc = nil
+      Mixin.constrain_proc = nil
       raise Gecode::NoSolutionError if result.nil?
       
       # Switch to the result.

data/lib/gecoder/version.rb

@@ -1,4 +1,4 @@
 module GecodeR #:nodoc:
   # A string representation of the Gecode/R version.
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/specs/branch.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-class BranchSampleProblem < Gecode::Model
+class BranchSampleProblem
+  include Gecode::Mixin
+
   attr :vars
   attr :bools
   attr :sets
@@ -12,7 +14,7 @@ class BranchSampleProblem < Gecode::Model
   end
 end
 
-describe Gecode::Model, ' (integer branch)' do
+describe Gecode::Mixin, ' (integer branch)' do
   before do
     @model = BranchSampleProblem.new
     @vars = @model.vars
@@ -112,7 +114,7 @@ describe Gecode::Model, ' (integer branch)' do
   end
 end
 
-describe Gecode::Model, ' (set branch)' do
+describe Gecode::Mixin, ' (set branch)' do
   before do
     @model = BranchSampleProblem.new
     @sets = @model.sets

data/specs/constraints/bool/boolean.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class BoolSampleProblem < Gecode::Model
+class BoolSampleProblem
+  include Gecode::Mixin
+
   attr :b1
   attr :b2
   attr :b3

data/specs/constraints/bool/linear.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class BoolLinearSampleProblem < Gecode::Model
+class BoolLinearSampleProblem
+  include Gecode::Mixin
+
   attr :x
   attr :y
   attr :z

data/specs/constraints/bool_enum/bool_enum_relation.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class BoolEnumSampleProblem < Gecode::Model
+class BoolEnumSampleProblem
+  include Gecode::Mixin
+
   attr :bools
   attr :b1
   attr :b2

data/specs/constraints/bool_enum/channel.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class BoolChannelSampleProblem < Gecode::Model
+class BoolChannelSampleProblem
+  include Gecode::Mixin
+
   attr :bool_enum
   attr :bool
   attr :int

data/specs/constraints/fixnum_enum/element.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class FixnumElementSampleProblem < Gecode::Model
+class FixnumElementSampleProblem
+  include Gecode::Mixin
+
   attr :prices
   attr :store
   attr :price

data/specs/constraints/int/arithmetic.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class ArithmeticSampleProblem < Gecode::Model
+class ArithmeticSampleProblem
+  include Gecode::Mixin
+
   attr :var
   attr :var2
   

data/specs/constraints/int/channel.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class BoolChannelSampleProblem < Gecode::Model
+class BoolChannelSampleProblem
+  include Gecode::Mixin
+
   attr :bool_enum
   attr :bool
   attr :int

data/specs/constraints/int/linear.rb

@@ -3,7 +3,9 @@ require File.dirname(__FILE__) + '/../constraint_helper'
 # This is neither an operand or a constraint spec. It is mostly a sanity
 # check.
 
-class LinearSampleProblem < Gecode::Model
+class LinearSampleProblem
+  include Gecode::Mixin
+
   attr :x
   attr :y
   attr :z

data/specs/constraints/int/linear_properties.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class LinearPropertySampleProblem < Gecode::Model
+class LinearPropertySampleProblem
+  include Gecode::Mixin
+
   attr :x
   attr :y
   attr :z

data/specs/constraints/int_enum/arithmetic.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class IntEnumArithmeticSampleProblem < Gecode::Model
+class IntEnumArithmeticSampleProblem
+  include Gecode::Mixin
+
   attr :numbers
   attr :var
   

data/specs/constraints/int_enum/channel.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class ChannelSampleProblem < Gecode::Model
+class ChannelSampleProblem
+  include Gecode::Mixin
+
   attr :elements
   attr :positions
   attr :sets

data/specs/constraints/int_enum/count.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class CountSampleProblem < Gecode::Model
+class CountSampleProblem
+  include Gecode::Mixin
+
   attr :list
   attr :element
   attr :target

data/specs/constraints/int_enum/distinct.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class DistinctSampleProblem < Gecode::Model
+class DistinctSampleProblem
+  include Gecode::Mixin
+
   def initialize
     vars_is_an int_var_array(2, 0..1)
     branch_on vars

data/specs/constraints/int_enum/element.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class ElementSampleProblem < Gecode::Model
+class ElementSampleProblem
+  include Gecode::Mixin
+
   attr :prices
   attr :store
   attr :price

data/specs/constraints/int_enum/sort.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class SortSampleProblem < Gecode::Model
+class SortSampleProblem
+  include Gecode::Mixin
+
   attr :vars
   attr :sorted
   attr :indices

data/specs/constraints/property_helper.rb

@@ -30,14 +30,14 @@ require File.dirname(__FILE__) + '/../spec_helper'
 # Requires @operand and @model.
 describe 'int var operand', :shared => true do
   it 'should implement #model' do
-    @operand.model.should be_kind_of(Gecode::Model)
+    @operand.model.should be_kind_of(Gecode::Mixin)
   end
 
   it 'should implement #to_int_var' do
     int_var = @operand.to_int_var
     int_var.should be_kind_of(Gecode::IntVar)
     @model.solve!
-    (int_var.min..int_var.max).should_not equal(Gecode::Model::LARGEST_INT_DOMAIN)
+    (int_var.min..int_var.max).should_not equal(Gecode::Mixin::LARGEST_INT_DOMAIN)
   end
 
   it 'should implement #must' do
@@ -50,7 +50,7 @@ end
 # Requires @operand and @model.
 describe 'bool var operand', :shared => true do
   it 'should implement #model' do
-    @operand.model.should be_kind_of(Gecode::Model)
+    @operand.model.should be_kind_of(Gecode::Mixin)
   end
 
   it 'should implement #to_bool_var' do
@@ -68,7 +68,7 @@ end
 # Requires @operand and @model.
 describe 'set var operand', :shared => true do
   it 'should implement #model' do
-    @operand.model.should be_kind_of(Gecode::Model)
+    @operand.model.should be_kind_of(Gecode::Mixin)
   end
 
   it 'should implement #to_set_var' do
@@ -76,7 +76,7 @@ describe 'set var operand', :shared => true do
     set_var.should be_kind_of(Gecode::SetVar)
     @model.solve!
     ((set_var.lower_bound == []) && 
-     (set_var.upper_bound == Gecode::Model::LARGEST_SET_BOUND)).should_not(
+     (set_var.upper_bound == Gecode::Mixin::LARGEST_SET_BOUND)).should_not(
       be_true)
   end
 
@@ -108,7 +108,7 @@ describe 'property that produces int operand', :shared => true do
     operand = @select_property.call(*operands)
 
     # Test the same invariants as in the test for int var operands.
-    operand.model.should be_kind_of(Gecode::Model)
+    operand.model.should be_kind_of(Gecode::Mixin)
 
     int_var = operand.to_int_var
     int_var.should be_kind_of(Gecode::IntVar)
@@ -128,7 +128,7 @@ describe 'property that produces bool operand', :shared => true do
     operand = @select_property.call(*operands)
 
     # Test the same invariants as in the test for bool var operands.
-    operand.model.should be_kind_of(Gecode::Model)
+    operand.model.should be_kind_of(Gecode::Mixin)
 
     bool_var = operand.to_bool_var
     bool_var.should be_kind_of(Gecode::BoolVar)
@@ -148,7 +148,7 @@ describe 'property that produces set operand', :shared => true do
     operand = @select_property.call(*operands)
 
     # Test the same invariants as in the test for int var operands.
-    operand.model.should be_kind_of(Gecode::Model)
+    operand.model.should be_kind_of(Gecode::Mixin)
 
     set_var = operand.to_set_var
     set_var.should be_kind_of(Gecode::SetVar)
@@ -178,7 +178,7 @@ describe 'property that produces int operand by short circuiting equality', :sha
     @selected_property.must == indirect_int_op
     @model.solve!
 
-    direct_int_var.should_not have_domain(Gecode::Model::LARGEST_INT_DOMAIN)
+    direct_int_var.should_not have_domain(Gecode::Mixin::LARGEST_INT_DOMAIN)
     direct_int_var.should have_domain(indirect_int_op.domain)
   end
 
@@ -282,7 +282,7 @@ describe 'property that produces int operand by short circuiting relations', :sh
       @selected_property.must.method(relation).call indirect_int_var
       @model.solve!
 
-      direct_int_var.should_not have_domain(Gecode::Model::LARGEST_INT_DOMAIN)
+      direct_int_var.should_not have_domain(Gecode::Mixin::LARGEST_INT_DOMAIN)
       direct_int_var.should have_domain(indirect_int_var.domain)
     end
 

data/specs/constraints/reification_sugar.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-class ReifSugarSampleProblem < Gecode::Model
+class ReifSugarSampleProblem
+  include Gecode::Mixin
+
   attr :x
   attr :y
   attr :z

data/specs/constraints/selected_set/select.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../constraint_helper'
 
-class SelectionSampleProblem < Gecode::Model
+class DisjointSelectSampleProblem
+  include Gecode::Mixin
+
   attr :sets
   attr :set
   attr :target
@@ -16,11 +18,11 @@ class SelectionSampleProblem < Gecode::Model
   end
 end
 
-describe Gecode::SetEnum::Select, ' (disjoint)' do
+describe Gecode::SetEnum::Element, ' (disjoint)' do
   include GecodeR::Specs::SetHelper
 
   before do
-    @model = SelectionSampleProblem.new
+    @model = DisjointSelectSampleProblem.new
     @sets = @model.sets
     @set = @model.set
     @target = @model.target
@@ -33,7 +35,7 @@ describe Gecode::SetEnum::Select, ' (disjoint)' do
     end
     @expect = lambda do |var, opts, reif_var|
       set_enum, set = var
-      Gecode::Raw.should_receive(:selectDisjoint).once.with(
+      Gecode::Raw.should_receive(:elementDisjoint).once.with(
         an_instance_of(Gecode::Raw::Space), 
         set_enum, set)
     end
@@ -53,4 +55,3 @@ describe Gecode::SetEnum::Select, ' (disjoint)' do
   it_should_behave_like 'non-reifiable set constraint'
   it_should_behave_like 'non-negatable constraint'
 end
-

data/specs/constraints/selected_set/select_properties.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../property_helper'
 
-class SelectionSampleProblem < Gecode::Model
+class SelectionSampleProblem
+  include Gecode::Mixin
+
   attr :sets
   attr :set
   attr :target
@@ -16,7 +18,7 @@ class SelectionSampleProblem < Gecode::Model
   end
 end
 
-describe Gecode::SelectedSet::Select, ' (union)' do
+describe Gecode::SelectedSet::Element, ' (union)' do
   include GecodeR::Specs::SetHelper
 
   before do
@@ -44,8 +46,8 @@ describe Gecode::SelectedSet::Select, ' (union)' do
     (union - [5,7,9]).should be_empty
   end
 
-  it 'should translate into a select union constraint' do
-    Gecode::Raw.should_receive(:selectUnion)
+  it 'should translate into a elements union constraint' do
+    Gecode::Raw.should_receive(:elementsUnion)
     @sets[@set].union.must_be.subset_of([5,7,9])
     @model.solve!
   end
@@ -54,7 +56,7 @@ describe Gecode::SelectedSet::Select, ' (union)' do
     'property that produces set operand by short circuiting equality')
 end
 
-describe Gecode::SetEnum::Select, ' (intersection)' do
+describe Gecode::SetEnum::Element, ' (intersection)' do
   include GecodeR::Specs::SetHelper
 
   before do
@@ -84,8 +86,8 @@ describe Gecode::SetEnum::Select, ' (intersection)' do
     (intersection - [5,7,9]).should be_empty
   end
 
-  it 'should translate into a select intersection constraint' do
-    Gecode::Raw.should_receive(:selectInter)
+  it 'should translate into a elements intersection constraint' do
+    Gecode::Raw.should_receive(:elementsInter)
     @sets[@set].intersection.must_be.subset_of([5,7,9])
     @model.solve!
   end
@@ -94,7 +96,7 @@ describe Gecode::SetEnum::Select, ' (intersection)' do
     'property that produces set operand by short circuiting equality')
 end
 
-describe Gecode::SelectedSet::Select, ' (intersection with universe)' do
+describe Gecode::SelectedSet::Element, ' (intersection with universe)' do
   include GecodeR::Specs::SetHelper
 
   before do
@@ -132,8 +134,8 @@ describe Gecode::SelectedSet::Select, ' (intersection with universe)' do
     (intersection - [1,2]).should be_empty
   end
 
-  it 'should translate into a select intersection constraint' do
-    Gecode::Raw.should_receive(:selectInterIn)
+  it 'should translate into a elements intersection constraint' do
+    Gecode::Raw.should_receive(:elementsInter)
     @sets[@set].intersection(:with => 1..2).must_be.subset_of([5,7,9])
     @model.solve!
   end