gecoder-with-gecode 0.8.3 → 0.9.0

data/lib/gecoder/interface/variables.rb

@@ -13,9 +13,9 @@ module Gecode
 
     def inspect
       if assigned?
-        "#<#{self.class} #{domain}>"
+        "#<#{self.class} #{domain_string}>"
       else
-        "#<#{self.class} #{domain}>"
+        "#<#{self.class} #{domain_string}>"
       end
     end
     
@@ -36,11 +36,11 @@ module Gecode
   
   # Creates a class for a free variable that can be bound into the specified
   # class using the specified method in a space.
-  def Gecode::FreeVar(bound_class, space_bind_method)
+  def Gecode::FreeVar(bound_class, space_bind_method) #:nodoc:
     clazz = Class.new(FreeVarBase)
     clazz.class_eval <<-"end_method_definitions"      
-      # Binds the int variable to the currently active space of the model, 
-      # returning the bound int variable.
+      # Binds the variable to the currently active space of the model, 
+      # returning the bound variable.
       def bind
         active_space.method(:#{space_bind_method}).call(@index)
       end
@@ -64,12 +64,25 @@ module Gecode
     return clazz
   end
   
-  FreeIntVar = FreeVar(Gecode::Raw::IntVar, :int_var)
-  # Describes an integer variable. Each integer variable has a domain of several
-  # integers which represent the possible values that the variable may take. 
-  # An integer variable is said to be assigned once the domain only contains a
-  # single element, at which point #value can be used to retrieve the value.
-  class FreeIntVar
+  IntVar = FreeVar(Gecode::Raw::IntVar, :int_var)
+  # Describes an integer variable. 
+  #
+  # An integer variable can take the value of any integer in its 
+  # domain, which is specified upon constructing the variable and
+  # further constrained by placing constraints on the variable.
+  # An integer variable is said to be assigned once the domain only
+  # contains a single element, at which point #value can be used to
+  # retrieve the value.
+  #
+  # Integer variables are integer operands and hence respond to
+  # everything that Gecode::Int::IntOperand responds to.
+  # Any constraint found in
+  # Gecode::Int::IntConstraintReceiver can thereby be 
+  # placed on integer variables.
+  class IntVar
+    include Gecode::Int::IntOperand
+    attr :model
+
     # Gets the minimum value still in the domain of the variable.
     delegate :min
     # Gets the maximum value still in the domain of the variable.
@@ -97,11 +110,27 @@ module Gecode
       raise 'No value is assigned.' unless assigned?
       send_bound(:val)
     end
+
+    # Returns the receiver.
+    def to_int_var
+      self
+    end
     
+    # Returns an enumeration corresponding to the domain.
+    def domain
+      if range?
+        min..max
+      else
+        (min..max).select do |i|
+          include? i
+        end
+      end
+    end
+
     private
     
-    # Returns a string representation of the the range of the variable's domain.
-    def domain #:nodoc:
+    # Returns a string representation of the range of the variable's domain.
+    def domain_string #:nodoc:
       if assigned?
         "range: #{value.to_s}"
       else
@@ -110,10 +139,20 @@ module Gecode
     end
   end
   
-  FreeBoolVar = FreeVar(Gecode::Raw::BoolVar, :bool_var)
-  # Describes a boolean variable. A boolean variable can be either true or 
-  # false.
-  class FreeBoolVar
+  BoolVar = FreeVar(Gecode::Raw::BoolVar, :bool_var)
+  # Describes a boolean variable. 
+  #
+  # A boolean variable can be either true or false.
+  #
+  # Boolean variables are boolean operands and hence respond to
+  # everything that Gecode::Bool::BoolOperand responds to.
+  # Any constraint found in
+  # Gecode::Bool::BoolConstraintReceiver can thereby be 
+  # placed on boolean variables.
+  class BoolVar
+    include Gecode::Bool::BoolOperand
+    attr :model
+
     # Checks whether the variable has been assigned.
     delegate :assigned?, :assigned
     
@@ -123,11 +162,16 @@ module Gecode
       raise 'No value is assigned.' unless assigned?
       send_bound(:val) == 1
     end
+
+    # Returns the receiver.
+    def to_bool_var
+      self
+    end
   
     private
   
     # Returns a string representation of the the variable's domain.
-    def domain
+    def domain_string
       if assigned?
         value.to_s
       else
@@ -136,24 +180,37 @@ module Gecode
     end
   end
 
-  FreeSetVar = FreeVar(Gecode::Raw::SetVar, :set_var)
+  SetVar = FreeVar(Gecode::Raw::SetVar, :set_var)
   # Describes a set variable. 
   # 
-  # A set variable's domain, i.e. possible values that it can take, are 
-  # represented with a greatest lower bound (GLB) and a least upper bound (LUB).
-  # The set variable may then take any set value S such that S is a subset of
-  # the least upper bound and the greatest lower bound is a subset of S.
+  # A set variable's domain, i.e. possible values that it can take, are
+  # represented with a greatest lower bound (GLB) and a least upper
+  # bound (LUB).  The set variable may then take any set value S such
+  # that S is a subset of the least upper bound and the greatest lower
+  # bound is a subset of S.
   #   
-  # If for instance the set has a greatest lower bound {1} and least upper bound
-  # {1,3,5} then the assigned set may be any of the following four sets: {1}, 
-  # {1,3}, {1,5}, {1,3,5}. 
+  # If for instance the set has a greatest lower bound {1} and least
+  # upper bound {1,3,5} then the assigned set may be any of the
+  # following four sets: {1}, {1,3}, {1,5}, {1,3,5}. 
   # 
-  # The domain of a set variable may also specify the cardinality of the set, 
-  # i.e. the number of elements that the set may contains.
-  class FreeSetVar
+  # The domain of a set variable may also specify the cardinality of the
+  # set, i.e. the number of elements that the set may contains.
+  #
+  # Set variables are set operands and hence respond to everything that
+  # Gecode::Set::SetOperand responds to.  Any constraint
+  # found in Gecode::Set::SetConstraintReceiver can thereby
+  # be placed on set variables.
+  class SetVar
+    include Gecode::Set::SetOperand
+    attr :model
+
     # Checks whether the variable has been assigned.
     delegate :assigned?, :assigned
-    
+    # Checks whether a value is included in the set.
+    delegate :in_lower_bound?, :contains
+    # Checks whether a value is not included in the set.
+    delegate :not_in_upper_bound?, :notContains
+
     # Gets all the elements located in the greatest lower bound of the set (an 
     # Enumerable).
     def lower_bound
@@ -185,14 +242,27 @@ module Gecode
       send_bound(:cardMin)..send_bound(:cardMax)
     end
     
+    # Returns the receiver.
+    def to_set_var
+      self
+    end
+    
     private
     
     # Returns a string representation of the the variable's domain.
-    def domain
+    def domain_string
       if assigned?
-        lower_bound.to_a.inspect
+        if lower_bound.size < 100
+          lower_bound.to_a.inspect
+        else
+          "the domain is too large to display"
+        end
       else
-        "glb-range: #{lower_bound.to_a.inspect}, lub-range: #{upper_bound.to_a.inspect}"
+        if upper_bound.size < 100
+          "glb-range: #{lower_bound.to_a.inspect}, lub-range: #{upper_bound.to_a.inspect}"
+        else
+          "the domain is too large to display"
+        end
       end
     end
   end

data/lib/gecoder/interface.rb

@@ -1,8 +1,9 @@
 require 'gecoder/interface/binding_changes'
-require 'gecoder/interface/variables'
 require 'gecoder/interface/enum_matrix'
 require 'gecoder/interface/model'
 require 'gecoder/interface/search'
 require 'gecoder/interface/constraints'
+require 'gecoder/interface/variables'
 require 'gecoder/interface/enum_wrapper'
 require 'gecoder/interface/branch'
+require 'gecoder/interface/model_sugar'

data/lib/gecoder/version.rb

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

data/specs/bool_var.rb

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/constraints/property_helper'
 
 describe 'non-empty bool variable', :shared => true do
   it 'should give a NoMethodError when calling a method that doesn\'t exist' do
@@ -6,10 +7,10 @@ describe 'non-empty bool variable', :shared => true do
   end
 end
 
-describe Gecode::FreeBoolVar, '(not assigned)' do
+describe Gecode::BoolVar, '(not assigned)' do
   before do
-    model = Gecode::Model.new
-    @var = model.bool_var
+    @model = Gecode::Model.new
+    @operand = @var = @model.bool_var
   end
   
   it_should_behave_like 'non-empty bool variable'
@@ -25,14 +26,16 @@ describe Gecode::FreeBoolVar, '(not assigned)' do
   it 'should raise error when trying to access assigned value' do
     lambda{ @var.value }.should raise_error(RuntimeError)
   end
+
+  it_should_behave_like 'bool var operand'
 end
 
-describe Gecode::FreeBoolVar, '(assigned true)' do
+describe Gecode::BoolVar, '(assigned true)' do
   before do
-    model = Gecode::Model.new
-    @var = model.bool_var
+    @model = Gecode::Model.new
+    @operand = @var = @model.bool_var
     @var.must_be.true
-    model.solve!
+    @model.solve!
   end
   
   it_should_behave_like 'non-empty bool variable'
@@ -48,14 +51,16 @@ describe Gecode::FreeBoolVar, '(assigned true)' do
   it "should say that it's true when inspecting" do
     @var.inspect.should include('true')
   end
+  
+  it_should_behave_like 'bool var operand'
 end
 
-describe Gecode::FreeBoolVar, '(assigned false)' do
+describe Gecode::BoolVar, '(assigned false)' do
   before do
-    model = Gecode::Model.new
-    @var = model.bool_var
+    @model = Gecode::Model.new
+    @operand = @var = @model.bool_var
     @var.must_be.false
-    model.solve!
+    @model.solve!
   end
   
   it_should_behave_like 'non-empty bool variable'
@@ -71,4 +76,6 @@ describe Gecode::FreeBoolVar, '(assigned false)' do
   it "should say that it's false when inspecting" do
     @var.inspect.should include('false')
   end
-end
+
+  it_should_behave_like 'bool var operand'
+end

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