or-tools 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c21f77bdb14226464938b4407e6399e8d60247b519df13ae3671643eef4ca47
-  data.tar.gz: e056e127a5ffae6aba598210df051e7d5bee7484b1415415054464cc115a0742
+  metadata.gz: 3d0010ac9fa141621f67cee4eb00ba077a5bafcec58c65202d477c1576ba797e
+  data.tar.gz: '0328a9b9f0fa296df875e0756b40dc16fdbf756725d5ecc4e3bc23c600245974'
 SHA512:
-  metadata.gz: aab9c9e218da811b49805587642e19432d3a5356eb3a5bb75aacea7f2ef8a4370ae8a2d7821d34f15a728a6c03710e50bd10f21f2531bb2309d4b9e953a9efbb
-  data.tar.gz: 79cfe7ee894e35272d3cf0f09f936e66ced59d84b9c6ce2096434ac30887db4c95f6836b12387859f2e089efabea5cb9fa8bdee2d488b00a56da2f5328f6dab2
+  metadata.gz: dd66a479521af3f036ed14f639f957cd6b608efed729a4e7ed1eb5fde749fd779ec471750b93ab5d48e0162116e9865c0763355fd72b610a0b74cf6747dad220
+  data.tar.gz: 41af8a12b7aa110baae1f62029c4bde6e291ea1b870f9435ba3463a1a9e52d41dc069ef049671a95802d3942e29402f7096709c6a8fd659382a372923e03002a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.2 (2020-02-18)
+
+- Added support for scheduling
+- Added `lib_version` method
+
 ## 0.1.1 (2020-02-16)
 
 - Added `RoutingModel`

data/README.md

@@ -31,7 +31,7 @@ Constraint Optimization
 
 Integer Optimization
 
-- [Mixed-Integer Programming](mixed-integer-programming)
+- [Mixed-Integer Programming](#mixed-integer-programming)
 
 Routing
 
@@ -56,6 +56,10 @@ Assignment
 - [Assignment as a Min Cost Problem](#assignment-as-a-min-cost-problem)
 - [Assignment as a MIP Problem](#assignment-as-a-mip-problem)
 
+Scheduling
+
+- [Employee Scheduling](#employee-scheduling)
+
 ### The Glop Linear Solver
 
 [Guide](https://developers.google.com/optimization/lp/glop)
@@ -964,6 +968,123 @@ puts
 puts "Time = #{solver.wall_time} milliseconds"
 ```
 
+## Employee Scheduling
+
+[Guide](https://developers.google.com/optimization/scheduling/employee_scheduling)
+
+Define the data
+
+```ruby
+num_nurses = 4
+num_shifts = 3
+num_days = 3
+all_nurses = num_nurses.times.to_a
+all_shifts = num_shifts.times.to_a
+all_days = num_days.times.to_a
+```
+
+Create the variables
+
+```ruby
+model = ORTools::CpModel.new
+
+shifts = {}
+all_nurses.each do |n|
+  all_days.each do |d|
+    all_shifts.each do |s|
+      shifts[[n, d, s]] = model.new_bool_var("shift_n%id%is%i" % [n, d, s])
+    end
+  end
+end
+```
+
+Assign nurses to shifts
+
+```ruby
+all_days.each do |d|
+  all_shifts.each do |s|
+    model.add(model.sum(all_nurses.map { |n| shifts[[n, d, s]] }) == 1)
+  end
+end
+
+all_nurses.each do |n|
+  all_days.each do |d|
+    model.add(model.sum(all_shifts.map { |s| shifts[[n, d, s]] }) <= 1)
+  end
+end
+```
+
+Assign shifts evenly
+
+```ruby
+min_shifts_per_nurse = (num_shifts * num_days) / num_nurses
+max_shifts_per_nurse = min_shifts_per_nurse + 1
+all_nurses.each do |n|
+  num_shifts_worked = model.sum(all_days.flat_map { |d| all_shifts.map { |s| shifts[[n, d, s]] } })
+  model.add(num_shifts_worked >= min_shifts_per_nurse)
+  model.add(num_shifts_worked <= max_shifts_per_nurse)
+end
+```
+
+Create a printer
+
+```ruby
+class NursesPartialSolutionPrinter < ORTools::CpSolverSolutionCallback
+  attr_reader :solution_count
+
+  def initialize(shifts, num_nurses, num_days, num_shifts, sols)
+    super()
+    @shifts = shifts
+    @num_nurses = num_nurses
+    @num_days = num_days
+    @num_shifts = num_shifts
+    @solutions = sols
+    @solution_count = 0
+  end
+
+  def on_solution_callback
+    if @solutions.include?(@solution_count)
+      puts "Solution #{@solution_count}"
+      @num_days.times do |d|
+        puts "Day #{d}"
+        @num_nurses.times do |n|
+          working = false
+          @num_shifts.times do |s|
+            if value(@shifts[[n, d, s]])
+              working = true
+              puts "  Nurse %i works shift %i" % [n, s]
+            end
+          end
+          unless working
+            puts "  Nurse #{n} does not work"
+          end
+        end
+      end
+      puts
+    end
+    @solution_count += 1
+  end
+end
+```
+
+Call the solver and display the results
+
+```ruby
+solver = ORTools::CpSolver.new
+a_few_solutions = 5.times.to_a
+solution_printer = NursesPartialSolutionPrinter.new(
+  shifts, num_nurses, num_days, num_shifts, a_few_solutions
+)
+solver.search_for_all_solutions(model, solution_printer)
+
+puts
+puts "Statistics"
+puts "  - conflicts       : %i" % solver.num_conflicts
+puts "  - branches        : %i" % solver.num_branches
+puts "  - wall time       : %f s" % solver.wall_time
+puts "  - solutions found : %i" % solution_printer.solution_count
+```
+
 ## History
 
 View the [changelog](https://github.com/ankane/or-tools/blob/master/CHANGELOG.md)

data/ext/or-tools/ext.cpp

@@ -1,5 +1,6 @@
 // or-tools
 #include <ortools/algorithms/knapsack_solver.h>
+#include <ortools/base/version.h>
 #include <ortools/constraint_solver/routing.h>
 #include <ortools/constraint_solver/routing_parameters.h>
 #include <ortools/graph/assignment.h>
@@ -14,6 +15,7 @@
 #include <rice/Constructor.hpp>
 #include <rice/Hash.hpp>
 #include <rice/Module.hpp>
+#include <rice/String.hpp>
 #include <rice/Symbol.hpp>
 
 using operations_research::ArcIndex;
@@ -43,6 +45,8 @@ using operations_research::sat::BoolVar;
 using operations_research::sat::CpModelBuilder;
 using operations_research::sat::CpSolverResponse;
 using operations_research::sat::CpSolverStatus;
+using operations_research::sat::NewFeasibleSolutionObserver;
+using operations_research::sat::SatParameters;
 using operations_research::sat::SolutionIntegerValue;
 
 using Rice::Array;
@@ -51,6 +55,7 @@ using Rice::Constructor;
 using Rice::Hash;
 using Rice::Module;
 using Rice::Object;
+using Rice::String;
 using Rice::Symbol;
 using Rice::define_module;
 using Rice::define_class_under;
@@ -111,7 +116,7 @@ operations_research::sat::LinearExpr from_ruby<operations_research::sat::LinearE
       // TODO clean up
       Object o = cvar[0];
       if (((Rice::String) o.call("class").call("name")).str() == "ORTools::BoolVar") {
-        expr.AddTerm(from_ruby<operations_research::sat::BoolVar>(cvar[0]), from_ruby<int64>(cvar[1]));
+        expr.AddVar(from_ruby<operations_research::sat::BoolVar>(cvar[0]));
       } else {
         expr.AddTerm(from_ruby<operations_research::sat::IntVar>(cvar[0]), from_ruby<int64>(cvar[1]));
       }
@@ -183,7 +188,13 @@ extern "C"
 void Init_ext()
 {
   Module rb_mORTools = define_module("ORTools")
-    .define_singleton_method("default_routing_search_parameters", &DefaultRoutingSearchParameters);
+    .define_singleton_method("default_routing_search_parameters", &DefaultRoutingSearchParameters)
+    .define_singleton_method(
+      "lib_version",
+      *[]() {
+        return std::to_string(operations_research::OrToolsMajorVersion()) + "."
+          + std::to_string(operations_research::OrToolsMinorVersion());
+      });
 
   define_class_under<RoutingSearchParameters>(rb_mORTools, "RoutingSearchParameters")
     .define_method(
@@ -392,7 +403,15 @@ void Init_ext()
 
   // not to be confused with operations_research::IntVar
   define_class_under<operations_research::sat::IntVar>(rb_mORTools, "SatIntVar");
-  define_class_under<BoolVar>(rb_mORTools, "BoolVar");
+  define_class_under<BoolVar>(rb_mORTools, "BoolVar")
+    .define_method("name", &BoolVar::Name)
+    .define_method("index", &BoolVar::index)
+    .define_method(
+      "inspect",
+      *[](BoolVar& self) {
+        String name(self.Name());
+        return "#<ORTools::BoolVar @name=" + name.inspect().str() + ">";
+      });
 
   define_class_under<CpModelBuilder>(rb_mORTools, "CpModel")
     .define_constructor(Constructor<CpModelBuilder>())
@@ -449,6 +468,25 @@ void Init_ext()
       });
 
   define_class_under(rb_mORTools, "CpSolver")
+    .define_method(
+      "_solve_with_observer",
+      *[](Object self, CpModelBuilder& model, Object callback) {
+        operations_research::sat::Model m;
+
+        // set parameters for SearchForAllSolutions
+        SatParameters parameters;
+        parameters.set_enumerate_all_solutions(true);
+        m.Add(NewSatParameters(parameters));
+
+        m.Add(NewFeasibleSolutionObserver(
+          [callback](const CpSolverResponse& r) {
+            // TODO find a better way to do this
+            callback.call("response=", r);
+            callback.call("on_solution_callback");
+          })
+        );
+        return SolveCpModel(model.Build(), &m);
+      })
     .define_method(
       "_solve",
       *[](Object self, CpModelBuilder& model) {
@@ -462,6 +500,11 @@ void Init_ext()
 
   define_class_under<CpSolverResponse>(rb_mORTools, "CpSolverResponse")
     .define_method("objective_value", &CpSolverResponse::objective_value)
+    .define_method("num_conflicts", &CpSolverResponse::num_conflicts)
+    .define_method("num_branches", &CpSolverResponse::num_branches)
+    .define_method("wall_time", &CpSolverResponse::wall_time)
+    // .define_method("solution_integer_value", &SolutionIntegerValue)
+    .define_method("solution_boolean_value", &operations_research::sat::SolutionBooleanValue)
     .define_method(
       "status",
       *[](CpSolverResponse& self) {

data/lib/or-tools.rb

@@ -6,6 +6,7 @@ require "or_tools/comparison"
 require "or_tools/comparison_operators"
 require "or_tools/cp_model"
 require "or_tools/cp_solver"
+require "or_tools/cp_solver_solution_callback"
 require "or_tools/knapsack_solver"
 require "or_tools/linear_expr"
 require "or_tools/routing_model"

data/lib/or_tools/comparison.rb

@@ -7,5 +7,9 @@ module ORTools
       @left = left
       @right = right
     end
+
+    def inspect
+      "#{left.inspect} #{operator} #{right.inspect}"
+    end
   end
 end

data/lib/or_tools/cp_solver.rb

@@ -1,5 +1,11 @@
+require "forwardable"
+
 module ORTools
   class CpSolver
+    extend Forwardable
+
+    def_delegators :@response, :objective_value, :num_conflicts, :num_branches, :wall_time
+
     def solve(model)
       @response = _solve(model)
       @response.status
@@ -9,8 +15,9 @@ module ORTools
       _solution_integer_value(@response, var)
     end
 
-    def objective_value
-      @response.objective_value
+    def search_for_all_solutions(model, observer)
+      @response = _solve_with_observer(model, observer)
+      @response.status
     end
   end
 end

data/lib/or_tools/cp_solver_solution_callback.rb

@@ -0,0 +1,9 @@
+module ORTools
+  class CpSolverSolutionCallback
+    attr_writer :response
+
+    def value(expr)
+      @response.solution_boolean_value(expr)
+    end
+  end
+end

data/lib/or_tools/sat_linear_expr.rb

@@ -16,6 +16,10 @@ module ORTools
       add(other, -1)
     end
 
+    def inspect
+      vars.map { |v| v[0].is_a?(BoolVar) ? v[0].name : v[0].name + " * " + v[1] }.join(" + ")
+    end
+
     private
 
     def add(other, sign)

data/lib/or_tools/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-16 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -98,6 +98,7 @@ files:
 - lib/or_tools/comparison_operators.rb
 - lib/or_tools/cp_model.rb
 - lib/or_tools/cp_solver.rb
+- lib/or_tools/cp_solver_solution_callback.rb
 - lib/or_tools/ext.bundle
 - lib/or_tools/knapsack_solver.rb
 - lib/or_tools/linear_expr.rb