gecoder 0.8.0 → 0.8.1

data/CHANGES

@@ -1,8 +1,18 @@
+== Version 0.8.1
+This release adds tuple constraints along with a couple of minor features. It 
+also fixes a bug introduced in the previous version.
+
+* [#19435] Fixed a bug causing inconsistencies during BAB-search. The bug stopped the send+more=money example from working correctly.
+* Fixed the "raw_bindings" and "sudoku-set" examples, which were broken by the 0.8.0 release.
+* Integers can now be used to specify singleton lower and upper bounds when creating set variables. 
+* Added convenience methods Model#maximize! and Model#minimize! for optimizing single variables.
+* Added tuple constraints for enumerations of integer and boolean variables.
+
 == Version 0.8.0
 This release makes the jump from using Gecode 1.3.1 to using Gecode 2.1.1 . 
 The following changes have been made to the interface as a result of the jump.
 
-* The distinct constraint for sets has been removed.
+* Removed the distinct constraint for sets.
 * Added the propagation kind option to the non-set constraints.
 
 == Version 0.7.1

data/Rakefile

@@ -4,10 +4,11 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 
 require 'tasks/all_tasks'
-task :default => [:verify_rcov]
+task :default => [:verify_rcov, :example_specs]
 
 desc 'Performs the tasks necessary when releasing'
-task :release => [:publish_website, :publish_packages, :tag]
+task :release => [:clobber, :verify_rcov, :example_specs, :publish_website, 
+  :publish_packages, :tag]
 
 desc 'Runs all the tests'
 task :test => :specs

data/example/raw_bindings.rb

@@ -12,14 +12,16 @@ s, e, n, d, m, o, r, y = (0..7).to_a.map{ |i| letters.at(i) }
 Gecode::Raw::post(space, (s * 1000 + e * 100 + n * 10  + d   + 
                      m * 1000 + o * 100 + r * 10  + e).
             equal(m * 10000 + o * 1000 + n * 100 + e * 10  + y ), 
-            Gecode::Raw::ICL_DEF)
-Gecode::Raw::rel(space, s, Gecode::Raw::IRT_NQ, 0, Gecode::Raw::ICL_DEF)
-Gecode::Raw::rel(space, m, Gecode::Raw::IRT_NQ, 0, Gecode::Raw::ICL_DEF)
-Gecode::Raw::distinct(space, letters, Gecode::Raw::ICL_DEF)
+            Gecode::Raw::ICL_DEF, Gecode::Raw::PK_DEF)
+Gecode::Raw::rel(space, s, Gecode::Raw::IRT_NQ, 0, Gecode::Raw::ICL_DEF, 
+  Gecode::Raw::PK_DEF)
+Gecode::Raw::rel(space, m, Gecode::Raw::IRT_NQ, 0, Gecode::Raw::ICL_DEF, 
+  Gecode::Raw::PK_DEF)
+Gecode::Raw::distinct(space, letters, Gecode::Raw::ICL_DEF, Gecode::Raw::PK_DEF)
 
 # Branching.
 Gecode::Raw::branch(space, letters, 
-  Gecode::Raw::BVAR_SIZE_MIN, Gecode::Raw::BVAL_MIN)
+  Gecode::Raw::INT_VAR_SIZE_MIN, Gecode::Raw::INT_VAL_MIN)
 
 # Search
 COPY_DIST = 16

data/example/sudoku-set.rb

@@ -61,9 +61,6 @@ class SudokuSet < Gecode::Model
         @sets[i].must_be.disjoint_with @sets[j]
       end
     end
-    # The above implies that the sets must be distinct (since cardinality 0 is
-    # not allowed), but we also explicitly add the distinctness constraint.
-    @sets.must_be.distinct(:size => n)
 
     # The sets must intersect in exactly one element with each row column and
     # block. I.e. an assignable number must be assigned exactly once in each

data/lib/gecoder/bindings/bindings.rb

@@ -149,7 +149,7 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
       enum.add_value "SRT_CMPL"
     end
     
-    ns.add_enum "SetOpType " do |enum|
+    ns.add_enum "SetOpType" do |enum|
       enum.add_value "SOT_UNION"
       enum.add_value "SOT_DUNION"
       enum.add_value "SOT_INTER"
@@ -337,6 +337,20 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
       klass.add_method "debug"
     end
     
+    ns.add_cxx_class "TupleSet" do |klass|
+      klass.add_constructor
+      
+      klass.add_method "add" do |method|
+        method.add_parameter "Gecode::IntArgs", "tuple"
+      end
+      
+      klass.add_method "finalize"
+      
+      klass.add_method "finalized", "bool"
+      
+      klass.add_method "tuples", "int"
+    end
+    
     ns.add_cxx_class "MBranchingDesc" do |klass|
       klass.bindname = "BranchingDesc"
       klass.add_constructor
@@ -1207,6 +1221,26 @@ Rust::Bindings::create_bindings Rust::Bindings::LangCxx, "gecode" do |b|
       func.add_parameter "Gecode::PropKind", "pk"
     end
     
+    ns.add_function "extensional", "void" do |func|
+      func.add_parameter "Gecode::MSpace*", "home"
+      func.add_parameter "Gecode::MIntVarArray *", "x" do |param|
+        param.custom_conversion = "*ruby2Gecode_MIntVarArrayPtr(argv[1], 2)->ptr()"
+      end
+      func.add_parameter "Gecode::TupleSet", "t"
+      func.add_parameter "Gecode::IntConLevel", "icl"
+      func.add_parameter "Gecode::PropKind", "pk"
+    end
+    
+    ns.add_function "extensional", "void" do |func|
+      func.add_parameter "Gecode::MSpace*", "home"
+      func.add_parameter "Gecode::MBoolVarArray *", "x" do |param|
+        param.custom_conversion = "*ruby2Gecode_MBoolVarArrayPtr(argv[1], 2)->ptr()"
+      end
+      func.add_parameter "Gecode::TupleSet", "t"
+      func.add_parameter "Gecode::IntConLevel", "icl"
+      func.add_parameter "Gecode::PropKind", "pk"
+    end
+  
 # 		ns.add_function "regular", "void" do |func|
 # 			func.add_parameter "Gecode::MSpace*", "home"
 # 			func.add_parameter "Gecode::MIntVarArray *", "x" do |param|

data/lib/gecoder/interface/binding_changes.rb

@@ -291,15 +291,11 @@ module Gecode
   
       private
       
-      # Transforms a lub or glb domain given as a range or enumeration into one
-      # or more parameters that describe the domain to Gecode::Raw::SetVar .
+      # Transforms a lub or glb domain given as a fixnum, range or enumeration 
+      # into one or more parameters that describe the domain to 
+      # Gecode::Raw::SetVar .
       def domain_to_args(domain)
-        if domain.kind_of? Range
-          return domain.first, domain.last
-        else
-          elements = domain.to_a
-          return Gecode::Raw::IntSet.new(domain, domain.size)
-        end
+        Gecode::Constraints::Util.constant_set_to_int_set(domain)
       end
       
       # Creates a new storage array for bool variables.

data/lib/gecoder/interface/constraints/bool_enum/extensional.rb

@@ -0,0 +1,63 @@
+module Gecode::Constraints::BoolEnum
+  class Expression
+    # Posts an equality constraint on the variables in the enum.
+    def in(tuples, options = {})
+      if @params[:negate]
+        raise Gecode::MissingConstraintError, 'A negated tuple constraint is ' +
+          'not implemented.'
+      end
+      unless options[:reify].nil?
+        raise ArgumentError, 'Reification is not supported by the tuple ' + 
+          'constraint.'
+      end
+      unless tuples.respond_to?(:each) and 
+          tuples.all?{ |tuple| tuple.respond_to?(:each) }
+        raise TypeError, 'Expected an enumeration with tuples, got ' + 
+          "#{tuples.class}."
+      end
+      unless tuples.all?{ |tuple| 
+          tuple.all?{ |x| x.kind_of?(TrueClass) or x.kind_of?(FalseClass) }}
+        raise TypeError, 'All tuples must contain booleans.'
+      end
+    
+      @params[:tuples] = tuples
+      @model.add_constraint Extensional::TupleConstraint.new(@model, 
+        @params.update(Gecode::Constraints::Util.decode_options(options)))
+    end
+  end
+  
+  # A module that gathers the classes and modules used in extensional 
+  # constraints.
+  module Extensional #:nodoc:
+    # Describes a tuple constraint, which constrains the variables in an 
+    # boolean enumeration to be equal to one of the specified tuples. Neither 
+    # negation nor reification is supported.
+    # 
+    # == Example
+    # 
+    #   # Constrains the three boolean variables in +bools+ to either
+    #   # be true, false, true, or false, false, true.
+    #   bools.must_be.in [[true, false, true], [false, false, true]]
+    #
+    #   # The same as above, but preferring speed over low memory usage.
+    #   bools.must_be.in([[true, false, true], [false, false, true]], 
+    #     :kind => :speed)
+    class TupleConstraint < Gecode::Constraints::Constraint
+      def post
+        # Bind lhs.
+        lhs = @params[:lhs].to_bool_var_array
+
+        # Create the tuple set.
+        tuple_set = Gecode::Raw::TupleSet.new
+        @params[:tuples].each do |tuple|
+          tuple_set.add tuple.map{ |b| b ? 1 : 0 }
+        end
+        tuple_set.finalize
+
+        # Post the constraint.
+        Gecode::Raw::extensional(@model.active_space, lhs, tuple_set, 
+          *propagation_options)
+      end
+    end
+  end
+end

data/lib/gecoder/interface/constraints/bool_enum/{boolean.rb → relation.rb}

@@ -3,21 +3,23 @@ module Gecode
     # Produces an expression that can be handled as if it was a variable 
     # representing the conjunction of all boolean variables in the enumeration.
     def conjunction
-      return Gecode::Constraints::BoolEnum::ConjunctionStub.new(
+      return Gecode::Constraints::BoolEnum::Relation::ConjunctionStub.new(
         @model, :lhs => self)
     end
     
     # Produces an expression that can be handled as if it was a variable 
     # representing the disjunction of all boolean variables in the enumeration.
     def disjunction
-      return Gecode::Constraints::BoolEnum::DisjunctionStub.new(
+      return Gecode::Constraints::BoolEnum::Relation::DisjunctionStub.new(
         @model, :lhs => self)
     end
   end
-  
+end
+
+module Gecode::Constraints::BoolEnum
   # A module that gathers the classes and modules used by boolean enumeration 
-  # constraints.
-  module Constraints::BoolEnum
+  # relation constraints.
+  module Relation #:nodoc:
     # Describes a CompositeStub for the conjunction constraint, which constrain
     # the conjunction of all boolean variables in an enumeration.
     # 
@@ -83,4 +85,4 @@ module Gecode
       end
     end
   end
-end
+end

data/lib/gecoder/interface/constraints/bool_enum_constraints.rb

@@ -1,8 +1,32 @@
-module Gecode  
+module Gecode
+  module BoolEnumMethods
+    include Gecode::Constraints::LeftHandSideMethods
+    
+    private
+    
+    # Produces an expression for the lhs module.
+    def expression(params)
+      params.update(:lhs => self)
+      Constraints::BoolEnum::Expression.new(@model, params)
+    end
+  end
+  
   # A module containing constraints that have enumerations of boolean variables 
   # as left hand side.
   module Constraints::BoolEnum
+    # Expressions with bool enums as left hand sides.
+    class Expression < Gecode::Constraints::Expression #:nodoc:
+      # Raises TypeError unless the left hand side is a bool enum.
+      def initialize(model, params)
+        super
+        
+        unless params[:lhs].respond_to? :to_bool_var_array
+          raise TypeError, 'Must have bool enum as left hand side.'
+        end
+      end
+    end
   end
 end
 
-require 'gecoder/interface/constraints/bool_enum/boolean'
+require 'gecoder/interface/constraints/bool_enum/relation'
+require 'gecoder/interface/constraints/bool_enum/extensional'

data/lib/gecoder/interface/constraints/int_enum/extensional.rb

@@ -0,0 +1,61 @@
+module Gecode::Constraints::IntEnum
+  class Expression
+    # Posts an equality constraint on the variables in the enum.
+    def in(tuples, options = {})
+      if @params[:negate]
+        raise Gecode::MissingConstraintError, 'A negated tuple constraint is ' +
+          'not implemented.'
+      end
+      unless options[:reify].nil?
+        raise ArgumentError, 'Reification is not supported by the tuple ' + 
+          'constraint.'
+      end
+      unless tuples.respond_to?(:each) and 
+          tuples.all?{ |tuple| tuple.respond_to?(:each) }
+        raise TypeError, 'Expected an enumeration with tuples, got ' + 
+          "#{tuples.class}."
+      end
+      unless tuples.all?{ |tuple| tuple.all?{ |x| x.kind_of? Fixnum }}
+        raise TypeError, 'All tuples must contain Fixnum.'
+      end
+    
+      @params[:tuples] = tuples
+      @model.add_constraint Extensional::TupleConstraint.new(@model, 
+        @params.update(Gecode::Constraints::Util.decode_options(options)))
+    end
+  end
+  
+  # A module that gathers the classes and modules used in extensional 
+  # constraints.
+  module Extensional #:nodoc:
+    # Describes a tuple constraint, which constrains all the variables in an 
+    # enumeration of integer variables to be equal to one of the specified 
+    # tuples. Neither negation nor reification is supported.
+    # 
+    # == Example
+    # 
+    #   # Constrains the two integer variables in +numbers+ to either have 
+    #   # values 1 and 7, or values 47 and 11.
+    #   numbers.must_be.in [[1,7], [47,11]]
+    #
+    #   # The same as above, but preferring speed over low memory usage.
+    #   numbers.must_be.in([[1,7], [47,11]], :kind => :speed)
+    class TupleConstraint < Gecode::Constraints::Constraint
+      def post
+        # Bind lhs.
+        lhs = @params[:lhs].to_int_var_array
+
+        # Create the tuple set.
+        tuple_set = Gecode::Raw::TupleSet.new
+        @params[:tuples].each do |tuple|
+          tuple_set.add tuple
+        end
+        tuple_set.finalize
+
+        # Post the constraint.
+        Gecode::Raw::extensional(@model.active_space, lhs, tuple_set, 
+          *propagation_options)
+      end
+    end
+  end
+end

data/lib/gecoder/interface/constraints/int_enum_constraints.rb

@@ -35,3 +35,4 @@ require 'gecoder/interface/constraints/int_enum/element'
 require 'gecoder/interface/constraints/int_enum/count'
 require 'gecoder/interface/constraints/int_enum/sort'
 require 'gecoder/interface/constraints/int_enum/arithmetic'
+require 'gecoder/interface/constraints/int_enum/extensional'

data/lib/gecoder/interface/model.rb

@@ -67,11 +67,11 @@ module Gecode
     end
     
     # Creates a set variable with the specified domain for greatest lower bound
-    # and least upper bound (specified as either a range or enum). If no bounds
-    # are specified then the empty set is used as greates lower bound and the 
-    # universe as least upper bound. A range for the allowed cardinality of the 
-    # set can also be specified, if none is specified, or nil is given, then the
-    # default range (anything) will be used. If only a single Fixnum is 
+    # and least upper bound (specified as either a fixnum, range or enum). If 
+    # no bounds are specified then the empty set is used as greates lower bound 
+    # and the universe as least upper bound. A range for the allowed cardinality
+    # of the set can also be specified, if none is specified, or nil is given, 
+    # then the default range (anything) will be used. If only a single Fixnum is 
     # specified as cardinality_range then it's used as lower bound.
     def set_var(glb_domain = [], lub_domain = 
         Gecode::Raw::SetLimits::MIN..Gecode::Raw::SetLimits::MAX, 
@@ -220,6 +220,8 @@ module Gecode
       if glb.kind_of?(Range) and lub.kind_of?(Range)
         glb.first >= lub.first and glb.last <= lub.last
       else
+        glb = [glb] if glb.kind_of?(Fixnum)
+        lub = [lub] if lub.kind_of?(Fixnum)
         (glb.to_a - lub.to_a).empty?
       end
     end
@@ -232,7 +234,8 @@ module Gecode
     # Retrieves the currently selected space, the one which constraints and 
     # variables should be bound to.
     def selected_space
-      @active_space ||= base_space
+      return @active_space unless @active_space.nil?
+      self.active_space = base_space
     end
     
     # Retrieves the space that should be used for variable creation.
@@ -243,9 +246,28 @@ module Gecode
     # Refreshes all cached variables. This should be called if the variables
     # in an existing space were changed.
     def refresh_variables
+      return if @variables.nil?
       @variables.each do |variable|
         variable.refresh if variable.cached?
       end
     end
+    
+    # Executes any interactions with Gecode still waiting in the queue 
+    # (emptying the queue) in the process.
+    def perform_queued_gecode_interactions
+      allow_space_access do
+        gecode_interaction_queue.each{ |con| con.call }
+        gecode_interaction_queue.clear # Empty the queue.
+      end
+    end
+    
+    # Switches the active space used (the space from which variables are read
+    # and to which constraints are posted). @active_space should never be 
+    # assigned directly.
+    def active_space=(new_space)
+      @active_space = new_space
+      new_space.refresh
+      refresh_variables
+    end    
   end
 end

data/lib/gecoder/interface/search.rb

@@ -6,14 +6,14 @@ module Gecode
     def solve!
       space = dfs_engine.next
       return nil if space.nil?
-      @active_space = space
+      self.active_space = space
       return self
     end
     
     # Returns to the original state, before any search was made (but propagation 
     # might have been performed). Returns the reset model.
     def reset!
-      @active_space = base_space
+      self.active_space = base_space
       return self
     end
     
@@ -30,7 +30,9 @@ module Gecode
     # Yields each solution that the model has.
     def each_solution(&block)
       dfs = dfs_engine
-      while not (@active_space = dfs.next).nil?
+      next_solution = nil
+      while not (next_solution = dfs.next).nil?
+        self.active_space = next_solution
         yield self
       end
       self.reset!
@@ -54,10 +56,10 @@ module Gecode
 
       # Set the method used for constrain calls by the BAB-search.
       Model.constrain_proc = lambda do |home_space, best_space|
-        @active_space = best_space
+        self.active_space = best_space
         @variable_creation_space = home_space
         yield(self, self)
-        @active_space = home_space
+        self.active_space = home_space
         @variable_creation_space = nil
         
         perform_queued_gecode_interactions
@@ -74,13 +76,49 @@ module Gecode
       Model.constrain_proc = nil
       return nil if result.nil?
       
-      # Refresh the solution.
-      result.refresh
-      refresh_variables
-      @active_space = result
+      # Switch to the result.
+      self.active_space = result
       return self
     end
     
+    # Finds the solution that maximizes a given integer variable. The name of 
+    # the method that accesses the variable from the model should be given. To 
+    # for instance maximize a variable named "profit", that's accessible through 
+    # the model, one would use the following.
+    #
+    #   model.maximize! :profit
+    #
+    # Returns nil if there is no solution.
+    def maximize!(var)
+      variable = self.method(var).call
+      unless variable.kind_of? Gecode::FreeIntVar
+        raise ArgumentError.new("Expected integer variable, got #{variable.class}.")
+      end
+      
+      optimize! do |model, best_so_far|
+        model.method(var).call.must > best_so_far.method(var).call.value
+      end
+    end
+    
+    # Finds the solution that minimizes a given integer variable. The name of 
+    # the method that accesses the variable from the model should be given. To 
+    # for instance minimize a variable named "cost", that's accessible through 
+    # the model, one would use the following.
+    #
+    #   model.minimize! :cost
+    #
+    # Returns nil if there is no solution.
+    def minimize!(var)
+      variable = self.method(var).call
+      unless variable.kind_of? Gecode::FreeIntVar
+        raise ArgumentError.new("Expected integer variable, got #{variable.class}.")
+      end
+      
+      optimize! do |model, best_so_far|
+        model.method(var).call.must < best_so_far.method(var).call.value
+      end
+    end
+    
     class <<self 
       # Sets the proc that should be used to handle constrain requests.
       def constrain_proc=(proc) #:nodoc:
@@ -111,14 +149,5 @@ module Gecode
         Gecode::Raw::Search::Config::ADAPTIVE_DISTANCE, 
         nil)
     end
-    
-    # Executes any interactions with Gecode still waiting in the queue 
-    # (emptying the queue) in the process.
-    def perform_queued_gecode_interactions
-      allow_space_access do
-        gecode_interaction_queue.each{ |con| con.call }
-        gecode_interaction_queue.clear # Empty the queue.
-      end
-    end
   end
 end

data/lib/gecoder/version.rb

@@ -1,4 +1,4 @@
 module GecodeR
   # A string representation of the Gecode/R version.
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/specs/constraints/{bool_enum.rb → bool_enum_relation.rb}

@@ -17,7 +17,7 @@ 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 constraint', :shared => true do
+describe 'bool enum relation constraint', :shared => true do
   it 'should handle being constrained to be true' do
     @stub.must_be.true
     @model.solve!
@@ -67,7 +67,7 @@ describe 'bool enum constraint', :shared => true do
   end
 end
 
-describe Gecode::Constraints::BoolEnum, ' (conjunction)' do
+describe Gecode::Constraints::BoolEnum::Relation, ' (conjunction)' do
   before do
     @model = BoolEnumSampleProblem.new
     @bools = @model.bools
@@ -109,11 +109,11 @@ describe Gecode::Constraints::BoolEnum, ' (conjunction)' do
     @compute_result = lambda{ @bools.all?{ |b| b.value } }
   end
   
-  it_should_behave_like 'bool enum constraint'
+  it_should_behave_like 'bool enum relation constraint'
   it_should_behave_like 'reifiable constraint'
 end
 
-describe Gecode::Constraints::BoolEnum, ' (disjunction)' do
+describe Gecode::Constraints::BoolEnum::Relation, ' (disjunction)' do
   before do
     @model = BoolEnumSampleProblem.new
     @bools = @model.bools
@@ -155,6 +155,6 @@ describe Gecode::Constraints::BoolEnum, ' (disjunction)' do
     @compute_result = lambda{ @bools.any?{ |b| b.value } }
   end
   
-  it_should_behave_like 'bool enum constraint'
+  it_should_behave_like 'bool enum relation constraint'
   it_should_behave_like 'reifiable constraint'
 end

data/specs/constraints/constraints.rb

@@ -17,6 +17,15 @@ describe Gecode::Constraints::IntEnum::Expression do
   end
 end
 
+describe Gecode::Constraints::BoolEnum::Expression do
+  it 'should raise error unless lhs is a bool enum' do
+    lambda do
+      Gecode::Constraints::BoolEnum::Expression.new(Gecode::Model.new, 
+        :lhs => 'foo', :negate => false)
+    end.should raise_error(TypeError)
+  end
+end
+
 describe Gecode::Constraints::SetEnum::Expression do
   it 'should raise error unless lhs is a set enum' do
     lambda do

data/specs/constraints/extensional.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/constraint_helper'
+
+describe Gecode::Constraints::IntEnum::Extensional 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) 
+      @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), 
+        an_instance_of(Gecode::Raw::TupleSet), strength, kind)
+    end
+  end
+  
+  it 'should constrain the domain of all variables' do
+    @digits.must_be.in @tuples
+    
+    found_solutions = []
+    @model.each_solution do |m|
+      found_solutions << @digits.values
+    end
+    
+    found_solutions.size.should == 2
+    (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
+  
+  it 'should raise error if the right hand side does not contain tuples' 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'
+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)
+    @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
+  end
+  
+  it 'should constrain the domain of all variables' do
+    @bools.must_be.in @tuples
+    
+    found_solutions = []
+    @model.each_solution do |m|
+      found_solutions << @bools.values
+    end
+    
+    found_solutions.size.should == 2
+    (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
+  
+  it 'should raise error if the right hand side does not contain tuples' 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'
+end

data/specs/examples.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'open3'
+
+# This spec checks that the examples are still working.
+files = Dir["#{File.dirname(__FILE__)}/../example/*.rb"]
+files.delete_if do |file|
+  file =~ /example_helper.rb/
+end
+
+files.each do |example|
+  describe "Example (#{File.basename(example)})" do
+    it 'should not output errors' do
+      _, _, stderr = Open3.popen3("ruby #{example} 1> /dev/null")
+      stderr.gets.should be_nil
+    end
+  end
+end

data/specs/search.rb

@@ -205,6 +205,66 @@ 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|

data/specs/set_var.rb

@@ -47,7 +47,7 @@ end
 describe Gecode::FreeSetVar, '(assigned)' do
   before do
     model = Gecode::Model.new
-    @var = model.set_var([1], [1])
+    @var = model.set_var(1, 1)
     model.solve!
   end
   

data/tasks/distribution.rake

@@ -7,6 +7,7 @@ PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 PKG_FILE_NAME_WITH_GECODE = "#{PKG_NAME_WITH_GECODE}-#{PKG_VERSION}"
 # The location where the precompiled DLL should be placed.
 DLL_LOCATION = 'lib/gecode.dll'
+EXT_DIR = 'ext'
 
 desc 'Generate RDoc'
 rd = Rake::RDocTask.new do |rdoc|
@@ -16,14 +17,19 @@ rd = Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README', 'CHANGES', 'LGPL-LICENSE', 'lib/**/*.rb')
 end
 
+TMP_DIR = 'doc/tmp/rdoc_dev'
 desc 'Generate RDoc, ignoring nodoc'
-Rake::RDocTask.new(:rdoc_dev) do |rdoc|
+Rake::RDocTask.new(:rdoc_dev => :prepare_rdoc_dev) do |rdoc|
   rdoc.rdoc_dir = 'doc/output/rdoc_dev'
   rdoc.options << '--title' << 'Gecode/R Developers RDoc' << '--line-numbers' << 
     '--inline-source' << '--accessor' << 'delegate'
-    
+  
+  rdoc.rdoc_files.include("#{TMP_DIR}/**/*.rb")
+end
+
+desc 'Copies the files that RDoc should parse, removing #:nodoc:'
+task :prepare_rdoc_dev do
   # Copy the rdoc and remove all #:nodoc: .
-  TMP_DIR = 'doc/tmp/rdoc_dev'
   Dir['lib/**/*.rb'].each do |source_name|
     destination_name = source_name.sub('lib', TMP_DIR)
     File.makedirs File.dirname(destination_name)
@@ -33,8 +39,6 @@ Rake::RDocTask.new(:rdoc_dev) do |rdoc|
     end
     destination.close
   end
-  
-  rdoc.rdoc_files.include("#{TMP_DIR}/**/*.rb")
 end
 
 spec = Gem::Specification.new do |s|
@@ -122,44 +126,55 @@ end
 desc 'Removes generated distribution files'
 task :clobber do
   rm DLL_LOCATION if File.exists? DLL_LOCATION
+  FileList[
+    "#{EXT_DIR}/*.o",
+    "#{EXT_DIR}/gecode.{cc,hh}",
+    "#{EXT_DIR}/Makefile",
+    "#{EXT_DIR}/mkmf.log"
+  ].to_a.each{ |file| rm file if File.exists? file }
 end
 
 desc 'Publish packages on RubyForge'
 task :publish_packages => [:publish_gecoder_packages, 
   :publish_gecoder_with_gecode_packages]
 
+# Files included in the vanilla Gecode/R release.
+vanilla_release_files = [
+  "pkg/#{PKG_FILE_NAME}.gem",
+  "pkg/#{PKG_FILE_NAME}.tgz",
+  "pkg/#{PKG_FILE_NAME}.zip"
+]
+
 desc 'Publish Gecode/R packages on RubyForge'
-task :publish_gecoder_packages => [:verify_user, :package] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem",
-    "pkg/#{PKG_FILE_NAME}.tgz",
-    "pkg/#{PKG_FILE_NAME}.zip"
-  ]
+task :publish_gecoder_packages => [:verify_user].concat(vanilla_release_files) do
   require 'meta_project'
   require 'rake/contrib/xforge'
 
   Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PROJECT_NAME)) do |xf|
     xf.user_name = ENV['RUBYFORGE_USER']
-    xf.files = release_files.to_a
+    xf.files = vanilla_release_files.to_a
     xf.release_name = "Gecode/R #{PKG_VERSION}"
     xf.package_name = PKG_NAME
   end
 end
 
+# Files included in the release with Gecode.
+gecode_release_files = [
+  "pkg/#{PKG_FILE_NAME_WITH_GECODE}.gem",
+  "pkg/#{PKG_FILE_NAME_WITH_GECODE}.tgz",
+  "pkg/#{PKG_FILE_NAME_WITH_GECODE}.zip",
+  "pkg/#{PKG_FILE_NAME_WITH_GECODE}-mswin32.gem"
+]
+
 desc 'Publish Gecode/R with Gecode packages on RubyForge'
-task :publish_gecoder_with_gecode_packages => [:verify_user, :package] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.gem",
-    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.tgz",
-    "pkg/#{PKG_FILE_NAME_WITH_GECODE}*.zip"
-  ]
-  
+task :publish_gecoder_with_gecode_packages => 
+    [:verify_user].concat(gecode_release_files) do
   require 'meta_project'
   require 'rake/contrib/xforge'
 
   Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new(PROJECT_NAME)) do |xf|
     xf.user_name = ENV['RUBYFORGE_USER']
-    xf.files = release_files.to_a
+    xf.files = gecode_release_files.to_a
     xf.release_name = "Gecode/R with Gecode #{PKG_VERSION}"
     xf.package_name = PKG_NAME_WITH_GECODE
   end

data/tasks/rcov.rake

@@ -3,9 +3,10 @@ require 'spec/rake/verify_rcov'
 
 RCOV_DIR = "#{File.dirname(__FILE__)}/../doc/output/coverage"
 
-desc "Run all specs with rcov"
+desc "Run all specs (except examples) with rcov"
 Spec::Rake::SpecTask.new(:rcov) do |t|
   t.spec_files = FileList['specs/**/*.rb']
+  t.spec_files.exclude 'examples.rb'
   t.rcov = true
   t.rcov_opts = ['--exclude examples', '--exclude specs']
   t.rcov_dir = RCOV_DIR
@@ -14,4 +15,4 @@ end
 RCov::VerifyTask.new(:verify_rcov => :rcov) do |t|
   t.threshold = 100.0
   t.index_html = "#{RCOV_DIR}/index.html"
-end
+end

data/tasks/specs.rake

@@ -3,13 +3,19 @@ require 'spec/rake/spectask'
 spec_files = FileList['specs/**/*.rb']
 
 desc 'Run all specs'
-Spec::Rake::SpecTask.new('specs') do |t|
+Spec::Rake::SpecTask.new(:specs) do |t|
   t.libs = ['lib']
   t.spec_files = spec_files
 end
 
+desc 'Run specs for the examples'
+Spec::Rake::SpecTask.new(:example_specs) do |t|
+  t.libs = ['lib']
+  t.spec_files = FileList['specs/examples.rb']
+end
+
 desc 'Generate an rspec html report'
-Spec::Rake::SpecTask.new('spec_html') do |t|
+Spec::Rake::SpecTask.new(:spec_html) do |t|
   t.spec_files = spec_files
   t.spec_opts = ['--format html:doc/output/rspec.html','--backtrace']
-end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: gecoder
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
-date: 2008-04-10 00:00:00 +02:00
+  version: 0.8.1
+date: 2008-04-20 00:00:00 +02:00
 summary: Ruby interface to Gecode, an environment for constraint programming.
 require_paths: 
 - lib
@@ -34,7 +34,8 @@ files:
 - COPYING
 - README
 - LGPL-LICENSE
-- lib/gecoder/interface/constraints/bool_enum/boolean.rb
+- lib/gecoder/interface/constraints/bool_enum/extensional.rb
+- lib/gecoder/interface/constraints/bool_enum/relation.rb
 - lib/gecoder/interface/constraints/set_enum/operation.rb
 - lib/gecoder/interface/constraints/set_enum/distinct.rb
 - lib/gecoder/interface/constraints/set_enum/selection.rb
@@ -56,6 +57,7 @@ files:
 - lib/gecoder/interface/constraints/int_enum/count.rb
 - lib/gecoder/interface/constraints/int_enum/arithmetic.rb
 - lib/gecoder/interface/constraints/int_enum/element.rb
+- lib/gecoder/interface/constraints/int_enum/extensional.rb
 - lib/gecoder/interface/constraints/int_enum_constraints.rb
 - lib/gecoder/interface/constraints/bool_enum_constraints.rb
 - lib/gecoder/interface/constraints/set_enum_constraints.rb
@@ -156,7 +158,6 @@ files:
 - tasks/dependencies.txt
 - specs/constraints
 - specs/constraints/boolean.rb
-- specs/constraints/bool_enum.rb
 - specs/constraints/int_domain.rb
 - specs/constraints/distinct.rb
 - specs/constraints/set_domain.rb
@@ -176,6 +177,8 @@ files:
 - specs/constraints/channel.rb
 - specs/constraints/linear.rb
 - specs/constraints/set_operation.rb
+- specs/constraints/extensional.rb
+- specs/constraints/bool_enum_relation.rb
 - specs/branch.rb
 - specs/model.rb
 - specs/binding_changes.rb
@@ -188,6 +191,7 @@ files:
 - specs/enum_matrix.rb
 - specs/spec_helper.rb
 - specs/distribution.rb
+- specs/examples.rb
 - ext/missing.cpp
 - ext/vararray.cpp
 - ext/missing.h
@@ -195,7 +199,6 @@ files:
 - ext/extconf.rb
 test_files: 
 - specs/constraints/boolean.rb
-- specs/constraints/bool_enum.rb
 - specs/constraints/int_domain.rb
 - specs/constraints/distinct.rb
 - specs/constraints/set_domain.rb
@@ -215,6 +218,8 @@ test_files:
 - specs/constraints/channel.rb
 - specs/constraints/linear.rb
 - specs/constraints/set_operation.rb
+- specs/constraints/extensional.rb
+- specs/constraints/bool_enum_relation.rb
 - specs/branch.rb
 - specs/model.rb
 - specs/binding_changes.rb
@@ -227,6 +232,7 @@ test_files:
 - specs/enum_matrix.rb
 - specs/spec_helper.rb
 - specs/distribution.rb
+- specs/examples.rb
 rdoc_options: 
 - --title
 - Gecode/R
@@ -240,7 +246,8 @@ extra_rdoc_files:
 - README
 - CHANGES
 - LGPL-LICENSE
-- lib/gecoder/interface/constraints/bool_enum/boolean.rb
+- lib/gecoder/interface/constraints/bool_enum/extensional.rb
+- lib/gecoder/interface/constraints/bool_enum/relation.rb
 - lib/gecoder/interface/constraints/set_enum/operation.rb
 - lib/gecoder/interface/constraints/set_enum/distinct.rb
 - lib/gecoder/interface/constraints/set_enum/selection.rb
@@ -262,6 +269,7 @@ extra_rdoc_files:
 - lib/gecoder/interface/constraints/int_enum/count.rb
 - lib/gecoder/interface/constraints/int_enum/arithmetic.rb
 - lib/gecoder/interface/constraints/int_enum/element.rb
+- lib/gecoder/interface/constraints/int_enum/extensional.rb
 - lib/gecoder/interface/constraints/int_enum_constraints.rb
 - lib/gecoder/interface/constraints/bool_enum_constraints.rb
 - lib/gecoder/interface/constraints/set_enum_constraints.rb