gecoder 0.4.0 → 0.5.0

data/CHANGES

@@ -1,3 +1,14 @@
+== Version 0.5.0
+This release adds set variables and some of their constraints, along with the 
+last of the boolean constraints.
+
+* Added exclusive or and implication.
+* Added conjunction and disjunction for boolean enumerations.
+* Added set variables. They are created using Model{#set_var, #set_var_array, #set_var_matrix}.
+* Added domain constraints for set variables.
+* Added relation constraints for set variables.
+* Added set cardinality constraints.
+
 == Version 0.4.0
 This release adds most of the constraints supported by Gecode for integer
 variables.

data/README

@@ -22,11 +22,22 @@ instructions.
 
   gem install gecoder
 
-=== Building the gem
+=== Installing from source using gem
 
   rake gem
   gem install pkg/gecoder-0.x.x.gem
 
+=== Installing from source without using gem
+
+"gecode.so" might have another extension depending on which platform it's 
+generated on (replace the extension in the following commands with whatever 
+extension it's given).
+
+	cd ext
+  ruby extconf.rb
+  make
+  mv gecode.so ../lib/
+
 == Running the tests
 
   rake specs

data/example/example_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/gecoder'

data/example/magic_sequence.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# Solves the magic sequence problem.
+class MagicSequence < Gecode::Model
+  # n is the length of the sequence.
+  def initialize(n)
+    # The i:th variable represents the value of the i:th element in the 
+    # sequence.
+    @sequence = int_var_array(n, 0...n)
+    
+    # The basic requirement to qualify as a magic sequence.
+    n.times{ |i| @sequence.count(i).must == @sequence[i] }
+  
+    # The following are implied constraints. They do not affect which 
+    # assignments are solutions, but they do help prune the search space 
+    # quicker.
+    
+    # The sum must be n. This follows from that there are exactly n elements and
+    # that the sum of all elements are the number of occurrences in total, i.e. 
+    # the number of elements.
+    @sequence.sum.must == n
+    
+    # sum(seq[i] * (i-1)) must equal 0 because sum(seq[i]) = n as seen above
+    # and sum(i*seq[i]) is just another way to compute sum(seq[i]). So we get 
+    # sum(seq[i] * (i-1)) = sum(seq[i]) - sum(i*seq[i]) = n - n = 0
+    @sequence.zip((-1...n).to_a).map{ |element, c| element*c }.sum.must == 0
+    
+    branch_on @sequence, :variable => :smallest_degree, :value => :split_max
+  end
+  
+  def to_s
+    @sequence.map{ |element| element.val }.join(', ')
+  end
+end
+
+class Array
+  # Sums all the elements in the array using #+ .
+  def sum
+    inject{ |sum, element| sum + element }
+  end
+end
+
+puts((MagicSequence.new(500).solve! || 'Failed').to_s)

data/example/queens.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# Solves the n-queens problem: http://en.wikipedia.org/wiki/Nqueens . No attempt
+# to break the involved symmetries is made.
+class NQueens < Gecode::Model
+  def initialize(n)
+    @size = n
+  
+    # The row number that the queen in the i:th column has. By using this as
+    # our variables we already make sure that no two queens are in the same
+    # column.
+    @queen_rows = int_var_array(n, 0...n)
+    
+    # Set up the constraints
+    # Queens must not be in the same diagonal (negative slope).
+    @queen_rows.with_offsets((0...n).to_a).must_be.distinct
+    # Queens must not be in the same diagonal (positive slope).
+    @queen_rows.with_offsets((0...n).to_a.reverse).must_be.distinct
+    # Queens must not be in the same row.
+    @queen_rows.must_be.distinct
+    
+    # Branching, we use first-fail heuristic.
+    branch_on @queen_rows, :variable => :smallest_size, :value => :min
+  end
+  
+  # Displays the assignment as a chessboard with queens denoted by 'x'.
+  def to_s
+    rows = @queen_rows.map{ |var| var.val }
+  
+    separator = '+' << '-' * (3 * @size + (@size - 1)) << "+\n"
+    res = (0...@size).inject(separator) do |s, i|
+      (0...@size).inject(s + '|') do |s, j|
+        s << " #{rows[j] == i ? 'x' : ' '} |"
+      end << "\n" << separator
+    end
+  end
+end
+
+# Print the first solution. Note that there are 92 solutions, but only 12 
+# are rotationally distinct. For any serious use one should place additional
+# constraints to eliminate those symmetries.
+NQueens.new( (ARGV[0] || 8).to_i ).solution{ |sol| puts sol.to_s }
+

data/example/raw_bindings.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# An example of using the raw bindings. Solves the send+more=money problem.
+
+# Variables
+space = Gecode::Raw::Space.new
+letters = Gecode::Raw::IntVarArray.new(space, 8, 0, 9)
+space.own(letters, 'letters')
+s, e, n, d, m, o, r, y = (0..7).to_a.map{ |i| letters.at(i) }
+
+# Constraints
+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)
+
+# Branching.
+Gecode::Raw::branch(space, letters, 
+  Gecode::Raw::BVAR_SIZE_MIN, Gecode::Raw::BVAL_MIN)
+
+# Search
+COPY_DIST = 16
+ADAPTATION_DIST = 4 
+dfs = Gecode::Raw::DFS.new(space, COPY_DIST, ADAPTATION_DIST, 
+  Gecode::Raw::Search::Stop.new)
+
+space = dfs.next
+if space.nil?
+  puts 'Failed'
+else
+  puts 'Solution:'
+  correct_letters = space.intVarArray('letters')
+  arr = []
+  correct_letters.size.times do |i|
+    arr << correct_letters.at(i).val
+  end
+  puts arr.join(' ')
+end
+

data/example/send_more_money.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# Solves the send+more=money problem: 
+# http://en.wikipedia.org/wiki/Send%2Bmore%3Dmoney
+class SendMoreMoney < Gecode::Model
+  def initialize
+    # Set up the variables, 8 letters with domain 0..9.
+    s,e,n,d,m,o,r,y = @letters = int_var_array(8, 0..9)
+
+    # Set up the constraints.
+    # The equation must hold.
+    (equation_row(s, e, n, d) + equation_row(m, o, r, e)).must == 
+      equation_row(m, o, n, e, y) 
+    
+    # The initial letters may not be 0.
+    s.must_not == 0
+    m.must_not == 0
+    
+    # All letters must be assigned different digits.
+    @letters.must_be.distinct
+
+    # Set the branching.
+    branch_on @letters, :variable => :smallest_size, :value => :min
+  end
+
+  def to_s
+    %w{s e n d m o r y}.zip(@letters).map do |text, letter|
+      "#{text}: #{letter.val}" 
+    end.join(', ')
+  end
+
+  private
+
+  # A helper to make the linear equation a bit tidier. Takes a number of
+  # variables and computes the linear combination as if the variable
+  # were digits in a base 10 number. E.g. x,y,z becomes
+  # 100*x + 10*y + z .
+  def equation_row(*variables)
+    variables.inject{ |result, variable| variable + result*10 }
+  end
+end
+
+puts SendMoreMoney.new.solve!.to_s

data/example/sudoku.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/example_helper'
+
+# Solves the sudoku problem: http://en.wikipedia.org/wiki/Soduko
+class Sudoku < Gecode::Model
+  # Takes a matrix of values in the initial sudoku, 0 if the square is empty. 
+  # The matrix must be square with a square size. 
+  def initialize(values)
+    # Verify that the input is of a valid size.
+    @size = n = values.row_size
+    sub_matrix_size = Math.sqrt(n).round
+    unless values.square? and sub_matrix_size**2 == n
+      raise ArgumentError, 'Incorrect value matrix size.'
+    end
+    sub_count = sub_matrix_size
+    
+    # Create the squares and initialize them.
+    @squares = int_var_matrix(n, n, 1..n)
+    values.row_size.times do |i|
+      values.column_size.times do |j|
+        @squares[i,j].must == values[i,j] unless values[i,j] == 0
+      end
+    end
+    
+    # Constraints.
+    n.times do |i|
+      # All rows must contain distinct numbers.
+      @squares.row(i).must_be.distinct(:strength => :domain)
+      # All columns must contain distinct numbers.
+      @squares.column(i).must_be.distinct(:strength => :domain)
+      # All sub-matrices must contain distinct numbers.
+      @squares.minor(
+        (i % sub_count) * sub_matrix_size, 
+        sub_matrix_size, 
+        (i / sub_count) * sub_matrix_size, 
+        sub_matrix_size).must_be.distinct(:strength => :domain)
+    end
+    
+    # Branching, we use first-fail heuristic.
+    branch_on @squares, :variable => :smallest_size, :value => :min
+  end
+  
+  # Display the solved sudoku in a grid.  
+  def to_s
+    separator = '+' << '-' * (3 * @size + (@size - 1)) << "+\n"
+    res = (0...@size).inject(separator) do |s, i|
+      (0...@size).inject(s + '|') do |s, j|
+        s << " #{@squares[i,j].val} |"
+      end << "\n" << separator
+    end
+  end
+end
+
+given_squares = Matrix[
+  [0,0,0, 2,0,5, 0,0,0],
+  [0,9,0, 0,0,0, 7,3,0],
+  [0,0,2, 0,0,9, 0,6,0],
+    
+  [2,0,0, 0,0,0, 4,0,9],
+  [0,0,0, 0,7,0, 0,0,0],
+  [6,0,9, 0,0,0, 0,0,1],
+      
+  [0,8,0, 4,0,0, 1,0,0],
+  [0,6,3, 0,0,0, 0,8,0],
+  [0,0,0, 6,0,8, 0,0,0]]
+puts Sudoku.new(given_squares).solve!.to_s

data/ext/missing.cpp

@@ -1,26 +1,20 @@
-/** Copyright (c) 2007, David Cuadrado <krawek@gmail.com>
- * All rights reserved.
+/**
+ * Gecode/R, a Ruby interface to Gecode.
+ * Copyright (C) 2007 The Gecode/R development team.
  * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  * 
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE. 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 **/
 
 #include "missing.h"
@@ -164,7 +158,7 @@ MSpace::MSpace(MSpace& s, bool share) : Gecode::Space(share, s), d(new Private)
 		
 		for(it = s.d->setArrays.begin(); it != eend; it++)
 		{
-			Gecode::MSetVarArray *sva = new Gecode::MSetVarArray;
+			Gecode::MSetVarArray *sva = new Gecode::MSetVarArray(this, (*it).second->ptr()->size());
 			sva->ptr()->update(this, share, *(*it).second->ptr() );
 			
 			own(sva, (*it).first);

data/ext/missing.h

@@ -1,26 +1,20 @@
-/** Copyright (c) 2007, David Cuadrado <krawek@gmail.com>
- * All rights reserved.
+/**
+ * Gecode/R, a Ruby interface to Gecode.
+ * Copyright (C) 2007 The Gecode/R development team.
  * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  * 
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE. 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 **/
 
 #ifndef __MISSING_CLASSES_H

data/ext/vararray.cpp

@@ -1,26 +1,20 @@
-/** Copyright (c) 2007, David Cuadrado <krawek@gmail.com>
- * All rights reserved.
+/**
+ * Gecode/R, a Ruby interface to Gecode.
+ * Copyright (C) 2007 The Gecode/R development team.
  * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  * 
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE. 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 **/
 
 #include "vararray.h"

data/ext/vararray.h

@@ -1,30 +1,24 @@
-/** Copyright (c) 2007, David Cuadrado <krawek@gmail.com>
- * All rights reserved.
+/**
+ * Gecode/R, a Ruby interface to Gecode.
+ * Copyright (C) 2007 The Gecode/R development team.
  * 
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  * 
- * 1. Redistributions of source code must retain the above copyright notice,
- *    this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  * 
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE. 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 **/
 
 #ifndef _VARARRAY_H
-#define _VARARRAT_H
+#define _VARARRAY_H
 
 #include <gecode/int.hh>
 #include <gecode/set.hh>
@@ -95,7 +89,7 @@ class MBoolVarArray : public MVarArray
 		Gecode::BoolVar &at(int index);
 		Gecode::BoolVar &operator[](int index);
 		
-		void push(const Gecode::BoolVar& intvar);
+		void push(const Gecode::BoolVar& boolvar);
 		
 		void debug() const;
 		
@@ -133,6 +127,8 @@ class MSetVarArray : public MVarArray
 		Gecode::SetVar &at(int index);
 		Gecode::SetVar &operator[](int index);
 		
+		void push(const Gecode::SetVar& setvar);
+		
 		void debug() const;
 		
 	private: