or-tools 0.5.0 → 0.5.4

data/ext/or-tools/constraint.cpp

@@ -1,9 +1,7 @@
 #include <google/protobuf/text_format.h>
 #include <ortools/sat/cp_model.h>
 
-#include <rice/Array.hpp>
-#include <rice/Constructor.hpp>
-#include <rice/Module.hpp>
+#include "ext.h"
 
 using operations_research::sat::BoolVar;
 using operations_research::sat::Constraint;
@@ -28,130 +26,75 @@ using Rice::Symbol;
 Class rb_cBoolVar;
 Class rb_cSatIntVar;
 
-template<>
-inline
-LinearExpr from_ruby<LinearExpr>(Object x)
+namespace Rice::detail
 {
-  LinearExpr expr;
-
-  if (x.respond_to("to_i")) {
-    expr = from_ruby<int64_t>(x.call("to_i"));
-  } else if (x.respond_to("vars")) {
-    Array vars = x.call("vars");
-    for (auto const& var: vars) {
-      auto cvar = (Array) var;
-      Object o = cvar[0];
-      if (o.is_a(rb_cBoolVar)) {
-        expr.AddTerm(from_ruby<BoolVar>(cvar[0]), from_ruby<int64_t>(cvar[1]));
-      } else if (o.is_a(rb_cInteger)) {
-        expr.AddConstant(from_ruby<int64_t>(cvar[0]) * from_ruby<int64_t>(cvar[1]));
-      } else {
-        expr.AddTerm(from_ruby<IntVar>(cvar[0]), from_ruby<int64_t>(cvar[1]));
-      }
+  template<>
+  struct Type<LinearExpr>
+  {
+    static bool verify()
+    {
+      return true;
     }
-  } else if (x.is_a(rb_cBoolVar)) {
-    expr = from_ruby<BoolVar>(x);
-  } else {
-    expr = from_ruby<IntVar>(x);
-  }
+  };
 
-  return expr;
-}
-
-// need a wrapper class since absl::Span doesn't own
-class IntVarSpan {
-  std::vector<IntVar> vec;
+  template<>
+  class From_Ruby<LinearExpr>
+  {
   public:
-    IntVarSpan(Object x) {
-      Array a = Array(x);
-      vec.reserve(a.size());
-      for (std::size_t i = 0; i < a.size(); ++i) {
-        vec.push_back(from_ruby<IntVar>(a[i]));
-      }
-    }
-    operator absl::Span<const IntVar>() {
-      return absl::Span<const IntVar>(vec);
-    }
-};
+    LinearExpr convert(VALUE v)
+    {
+      Object x(v);
+      LinearExpr expr;
 
-template<>
-inline
-IntVarSpan from_ruby<IntVarSpan>(Object x)
-{
-  return IntVarSpan(x);
-}
+      if (x.respond_to("to_i")) {
+        expr = From_Ruby<int64_t>().convert(x.call("to_i").value());
+      } else if (x.respond_to("vars")) {
+        Array vars = x.call("vars");
+        for (const auto& v : vars) {
+          // TODO clean up
+          auto cvar = (Array) v;
+          Object var = cvar[0];
+          auto coeff = From_Ruby<int64_t>().convert(cvar[1].value());
 
-// need a wrapper class since absl::Span doesn't own
-class IntervalVarSpan {
-  std::vector<IntervalVar> vec;
-  public:
-    IntervalVarSpan(Object x) {
-      Array a = Array(x);
-      vec.reserve(a.size());
-      for (std::size_t i = 0; i < a.size(); ++i) {
-        vec.push_back(from_ruby<IntervalVar>(a[i]));
+          if (var.is_a(rb_cBoolVar)) {
+            expr.AddTerm(From_Ruby<BoolVar>().convert(var.value()), coeff);
+          } else if (var.is_a(rb_cInteger)) {
+            expr.AddConstant(From_Ruby<int64_t>().convert(var.value()) * coeff);
+          } else {
+            expr.AddTerm(From_Ruby<IntVar>().convert(var.value()), coeff);
+          }
+        }
+      } else {
+        if (x.is_a(rb_cBoolVar)) {
+          expr = From_Ruby<BoolVar>().convert(x.value());
+        } else {
+          expr = From_Ruby<IntVar>().convert(x.value());
+        }
       }
-    }
-    operator absl::Span<const IntervalVar>() {
-      return absl::Span<const IntervalVar>(vec);
-    }
-};
 
-template<>
-inline
-IntervalVarSpan from_ruby<IntervalVarSpan>(Object x)
-{
-  return IntervalVarSpan(x);
-}
-
-// need a wrapper class since absl::Span doesn't own
-class LinearExprSpan {
-  std::vector<LinearExpr> vec;
-  public:
-    LinearExprSpan(Object x) {
-      Array a = Array(x);
-      vec.reserve(a.size());
-      for (std::size_t i = 0; i < a.size(); ++i) {
-        vec.push_back(from_ruby<LinearExpr>(a[i]));
-      }
-    }
-    operator absl::Span<const LinearExpr>() {
-      return absl::Span<const LinearExpr>(vec);
+      return expr;
     }
-};
+  };
 
-template<>
-inline
-LinearExprSpan from_ruby<LinearExprSpan>(Object x)
-{
-  return LinearExprSpan(x);
-}
-
-// need a wrapper class since absl::Span doesn't own
-class BoolVarSpan {
-  std::vector<BoolVar> vec;
+  template<>
+  class From_Ruby<std::vector<BoolVar>>
+  {
   public:
-    BoolVarSpan(Object x) {
-      Array a = Array(x);
+    std::vector<BoolVar> convert(VALUE v)
+    {
+      auto a = Array(v);
+      std::vector<BoolVar> vec;
       vec.reserve(a.size());
-      for (std::size_t i = 0; i < a.size(); ++i) {
-        if (((Object) a[i]).is_a(rb_cSatIntVar)) {
-          vec.push_back(from_ruby<IntVar>(a[i]).ToBoolVar());
+      for (const Object v : a) {
+        if (v.is_a(rb_cSatIntVar)) {
+          vec.push_back(From_Ruby<IntVar>().convert(v.value()).ToBoolVar());
         } else {
-          vec.push_back(from_ruby<BoolVar>(a[i]));
+          vec.push_back(From_Ruby<BoolVar>().convert(v.value()));
         }
       }
+      return vec;
     }
-    operator absl::Span<const BoolVar>() {
-      return absl::Span<const BoolVar>(vec);
-    }
-};
-
-template<>
-inline
-BoolVarSpan from_ruby<BoolVarSpan>(Object x)
-{
-  return BoolVarSpan(x);
+  };
 }
 
 void init_constraint(Rice::Module& m) {
@@ -164,14 +107,14 @@ void init_constraint(Rice::Module& m) {
   Rice::define_class_under<Constraint>(m, "SatConstraint")
     .define_method(
       "only_enforce_if",
-      *[](Constraint& self, Object literal) {
+      [](Constraint& self, Object literal) {
         if (literal.is_a(rb_cSatIntVar)) {
-          return self.OnlyEnforceIf(from_ruby<IntVar>(literal).ToBoolVar());
+          return self.OnlyEnforceIf(Rice::detail::From_Ruby<IntVar>().convert(literal).ToBoolVar());
         } else if (literal.is_a(rb_cArray)) {
           // TODO support IntVarSpan
-          return self.OnlyEnforceIf(from_ruby<BoolVarSpan>(literal));
+          return self.OnlyEnforceIf(Rice::detail::From_Ruby<std::vector<BoolVar>>().convert(literal));
         } else {
-          return self.OnlyEnforceIf(from_ruby<BoolVar>(literal));
+          return self.OnlyEnforceIf(Rice::detail::From_Ruby<BoolVar>().convert(literal));
         }
       });
 
@@ -181,254 +124,226 @@ void init_constraint(Rice::Module& m) {
     .define_method("not", &BoolVar::Not)
     .define_method(
       "inspect",
-      *[](BoolVar& self) {
+      [](BoolVar& self) {
         String name(self.Name());
         return "#<ORTools::BoolVar @name=" + name.inspect().str() + ">";
       });
 
   Rice::define_class_under<SatParameters>(m, "SatParameters")
     .define_constructor(Rice::Constructor<SatParameters>())
-    .define_method("max_time_in_seconds=",
-    *[](SatParameters& self, double value) {
-      self.set_max_time_in_seconds(value);
-    });
+    .define_method(
+      "max_time_in_seconds=",
+      [](SatParameters& self, double value) {
+        self.set_max_time_in_seconds(value);
+      })
+    .define_method(
+      "enumerate_all_solutions=",
+      [](SatParameters& self, bool value) {
+        self.set_enumerate_all_solutions(value);
+      })
+    .define_method(
+      "enumerate_all_solutions",
+      [](SatParameters& self) {
+        return self.enumerate_all_solutions();
+      });
 
   Rice::define_class_under<CpModelBuilder>(m, "CpModel")
     .define_constructor(Rice::Constructor<CpModelBuilder>())
     .define_method(
       "new_int_var",
-      *[](CpModelBuilder& self, int64_t start, int64_t end, const std::string& name) {
+      [](CpModelBuilder& self, int64_t start, int64_t end, const std::string& name) {
         const operations_research::Domain domain(start, end);
         return self.NewIntVar(domain).WithName(name);
       })
     .define_method(
       "new_bool_var",
-      *[](CpModelBuilder& self, const std::string& name) {
+      [](CpModelBuilder& self, const std::string& name) {
         return self.NewBoolVar().WithName(name);
       })
     .define_method(
       "new_constant",
-      *[](CpModelBuilder& self, int64_t value) {
+      [](CpModelBuilder& self, int64_t value) {
         return self.NewConstant(value);
       })
     .define_method(
       "true_var",
-      *[](CpModelBuilder& self) {
+      [](CpModelBuilder& self) {
         return self.TrueVar();
       })
     .define_method(
       "false_var",
-      *[](CpModelBuilder& self) {
+      [](CpModelBuilder& self) {
         return self.FalseVar();
       })
     .define_method(
       "new_interval_var",
-      *[](CpModelBuilder& self, IntVar start, IntVar size, IntVar end, const std::string& name) {
+      [](CpModelBuilder& self, IntVar start, IntVar size, IntVar end, const std::string& name) {
         return self.NewIntervalVar(start, size, end).WithName(name);
       })
     .define_method(
       "new_optional_interval_var",
-      *[](CpModelBuilder& self, IntVar start, IntVar size, IntVar end, BoolVar presence, const std::string& name) {
+      [](CpModelBuilder& self, IntVar start, IntVar size, IntVar end, BoolVar presence, const std::string& name) {
         return self.NewOptionalIntervalVar(start, size, end, presence).WithName(name);
       })
     .define_method(
       "add_bool_or",
-      *[](CpModelBuilder& self, BoolVarSpan literals) {
+      [](CpModelBuilder& self, std::vector<BoolVar> literals) {
         return self.AddBoolOr(literals);
       })
     .define_method(
       "add_bool_and",
-      *[](CpModelBuilder& self, BoolVarSpan literals) {
+      [](CpModelBuilder& self, std::vector<BoolVar> literals) {
         return self.AddBoolAnd(literals);
       })
     .define_method(
       "add_bool_xor",
-      *[](CpModelBuilder& self, BoolVarSpan literals) {
+      [](CpModelBuilder& self, std::vector<BoolVar> literals) {
         return self.AddBoolXor(literals);
       })
     .define_method(
       "add_implication",
-      *[](CpModelBuilder& self, BoolVar a, BoolVar b) {
+      [](CpModelBuilder& self, BoolVar a, BoolVar b) {
         return self.AddImplication(a, b);
       })
     .define_method(
       "add_equality",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddEquality(x, y);
       })
     .define_method(
       "add_greater_or_equal",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddGreaterOrEqual(x, y);
       })
     .define_method(
       "add_greater_than",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddGreaterThan(x, y);
       })
     .define_method(
       "add_less_or_equal",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddLessOrEqual(x, y);
       })
     .define_method(
       "add_less_than",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddLessThan(x, y);
       })
     // TODO add domain
     // .define_method(
     //   "add_linear_constraint",
-    //   *[](CpModelBuilder& self, LinearExpr expr, Domain domain) {
+    //   [](CpModelBuilder& self, LinearExpr expr, Domain domain) {
     //     return self.AddLinearConstraint(expr, domain);
     //   })
     .define_method(
       "add_not_equal",
-      *[](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
+      [](CpModelBuilder& self, LinearExpr x, LinearExpr y) {
         return self.AddNotEqual(x, y);
       })
     .define_method(
       "add_all_different",
-      *[](CpModelBuilder& self, IntVarSpan vars) {
+      [](CpModelBuilder& self, std::vector<IntVar> vars) {
         return self.AddAllDifferent(vars);
       })
     .define_method(
       "add_inverse_constraint",
-      *[](CpModelBuilder& self, IntVarSpan variables, IntVarSpan inverse_variables) {
+      [](CpModelBuilder& self, std::vector<IntVar> variables, std::vector<IntVar> inverse_variables) {
         return self.AddInverseConstraint(variables, inverse_variables);
       })
     .define_method(
       "add_min_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVarSpan vars) {
+      [](CpModelBuilder& self, IntVar target, std::vector<IntVar> vars) {
         return self.AddMinEquality(target, vars);
       })
     .define_method(
       "add_lin_min_equality",
-      *[](CpModelBuilder& self, LinearExpr target, LinearExprSpan exprs) {
+      [](CpModelBuilder& self, LinearExpr target, std::vector<LinearExpr> exprs) {
         return self.AddLinMinEquality(target, exprs);
       })
     .define_method(
       "add_max_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVarSpan vars) {
+      [](CpModelBuilder& self, IntVar target, std::vector<IntVar> vars) {
         return self.AddMaxEquality(target, vars);
       })
     .define_method(
       "add_lin_max_equality",
-      *[](CpModelBuilder& self, LinearExpr target, LinearExprSpan exprs) {
+      [](CpModelBuilder& self, LinearExpr target, std::vector<LinearExpr> exprs) {
         return self.AddLinMaxEquality(target, exprs);
       })
     .define_method(
       "add_division_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVar numerator, IntVar denominator) {
+      [](CpModelBuilder& self, IntVar target, IntVar numerator, IntVar denominator) {
         return self.AddDivisionEquality(target, numerator, denominator);
       })
     .define_method(
       "add_abs_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVar var) {
+      [](CpModelBuilder& self, IntVar target, IntVar var) {
         return self.AddAbsEquality(target, var);
       })
     .define_method(
       "add_modulo_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVar var, IntVar mod) {
+      [](CpModelBuilder& self, IntVar target, IntVar var, IntVar mod) {
         return self.AddModuloEquality(target, var, mod);
       })
     .define_method(
       "add_product_equality",
-      *[](CpModelBuilder& self, IntVar target, IntVarSpan vars) {
+      [](CpModelBuilder& self, IntVar target, std::vector<IntVar> vars) {
         return self.AddProductEquality(target, vars);
       })
     .define_method(
       "add_no_overlap",
-      *[](CpModelBuilder& self, IntervalVarSpan vars) {
+      [](CpModelBuilder& self, std::vector<IntervalVar> vars) {
         return self.AddNoOverlap(vars);
       })
     .define_method(
       "maximize",
-      *[](CpModelBuilder& self, LinearExpr expr) {
+      [](CpModelBuilder& self, LinearExpr expr) {
         self.Maximize(expr);
       })
     .define_method(
       "minimize",
-      *[](CpModelBuilder& self, LinearExpr expr) {
+      [](CpModelBuilder& self, LinearExpr expr) {
         self.Minimize(expr);
       })
     .define_method(
       "scale_objective_by",
-      *[](CpModelBuilder& self, double scaling) {
+      [](CpModelBuilder& self, double scaling) {
         self.ScaleObjectiveBy(scaling);
       })
     .define_method(
       "add_hint",
-      *[](CpModelBuilder& self, IntVar var, int64_t value) {
+      [](CpModelBuilder& self, IntVar var, int64_t value) {
         self.AddHint(var, value);
       })
     .define_method(
       "clear_hints",
-      *[](CpModelBuilder& self) {
+      [](CpModelBuilder& self) {
         self.ClearHints();
       })
     .define_method(
       "add_assumption",
-      *[](CpModelBuilder& self, BoolVar lit) {
+      [](CpModelBuilder& self, BoolVar lit) {
         self.AddAssumption(lit);
       })
     .define_method(
       "add_assumptions",
-      *[](CpModelBuilder& self, BoolVarSpan literals) {
+      [](CpModelBuilder& self, std::vector<BoolVar> literals) {
         self.AddAssumptions(literals);
       })
     .define_method(
       "clear_assumptions",
-      *[](CpModelBuilder& self) {
+      [](CpModelBuilder& self) {
         self.ClearAssumptions();
       })
     .define_method(
       "to_s",
-      *[](CpModelBuilder& self) {
+      [](CpModelBuilder& self) {
         std::string proto_string;
         google::protobuf::TextFormat::PrintToString(self.Proto(), &proto_string);
         return proto_string;
       });
 
-  Rice::define_class_under(m, "CpSolver")
-    .define_method(
-      "_solve_with_observer",
-      *[](Object self, CpModelBuilder& model, SatParameters& parameters, Object callback, bool all_solutions) {
-        Model m;
-
-        if (all_solutions) {
-          // set parameters for SearchForAllSolutions
-          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, SatParameters& parameters) {
-        Model m;
-        m.Add(NewSatParameters(parameters));
-        return SolveCpModel(model.Build(), &m);
-      })
-    .define_method(
-      "_solution_integer_value",
-      *[](Object self, CpSolverResponse& response, IntVar& x) {
-        return SolutionIntegerValue(response, x);
-      })
-    .define_method(
-      "_solution_boolean_value",
-      *[](Object self, CpSolverResponse& response, BoolVar& x) {
-        return SolutionBooleanValue(response, x);
-      });
-
   Rice::define_class_under<CpSolverResponse>(m, "CpSolverResponse")
     .define_method("objective_value", &CpSolverResponse::objective_value)
     .define_method("num_conflicts", &CpSolverResponse::num_conflicts)
@@ -436,14 +351,14 @@ void init_constraint(Rice::Module& m) {
     .define_method("wall_time", &CpSolverResponse::wall_time)
     .define_method(
       "solution_integer_value",
-      *[](CpSolverResponse& self, IntVar& x) {
+      [](CpSolverResponse& self, IntVar& x) {
         LinearExpr expr(x);
         return SolutionIntegerValue(self, expr);
       })
     .define_method("solution_boolean_value", &SolutionBooleanValue)
     .define_method(
       "status",
-      *[](CpSolverResponse& self) {
+      [](CpSolverResponse& self) {
         auto status = self.status();
 
         if (status == CpSolverStatus::OPTIMAL) {
@@ -462,12 +377,45 @@ void init_constraint(Rice::Module& m) {
       })
     .define_method(
       "sufficient_assumptions_for_infeasibility",
-      *[](CpSolverResponse& self) {
+      [](CpSolverResponse& self) {
         auto a = Array();
         auto assumptions = self.sufficient_assumptions_for_infeasibility();
-        for (auto const& v : assumptions) {
+        for (const auto& v : assumptions) {
           a.push(v);
         }
         return a;
       });
+
+  Rice::define_class_under(m, "CpSolver")
+    .define_method(
+      "_solve",
+      [](Object self, CpModelBuilder& model, SatParameters& parameters, Object callback) {
+        Model m;
+
+        if (!callback.is_nil()) {
+          // TODO figure out how to use callback with multiple cores
+          parameters.set_num_search_workers(1);
+
+          m.Add(NewFeasibleSolutionObserver(
+            [callback](const CpSolverResponse& r) {
+              // TODO find a better way to do this
+              callback.call("response=", r);
+              callback.call("on_solution_callback");
+            })
+          );
+        }
+
+        m.Add(NewSatParameters(parameters));
+        return SolveCpModel(model.Build(), &m);
+      })
+    .define_method(
+      "_solution_integer_value",
+      [](Object self, CpSolverResponse& response, IntVar& x) {
+        return SolutionIntegerValue(response, x);
+      })
+    .define_method(
+      "_solution_boolean_value",
+      [](Object self, CpSolverResponse& response, BoolVar& x) {
+        return SolutionBooleanValue(response, x);
+      });
 }

data/ext/or-tools/ext.cpp

@@ -1,6 +1,6 @@
 #include <ortools/base/version.h>
 
-#include <rice/Module.hpp>
+#include "ext.h"
 
 void init_assignment(Rice::Module& m);
 void init_bin_packing(Rice::Module& m);
@@ -14,9 +14,9 @@ void Init_ext()
 {
   auto m = Rice::define_module("ORTools");
 
-  m.define_singleton_method(
+  m.define_singleton_function(
     "lib_version",
-    *[]() {
+    []() {
       return std::to_string(operations_research::OrToolsMajorVersion()) + "."
         + std::to_string(operations_research::OrToolsMinorVersion());
     });

data/ext/or-tools/ext.h

@@ -0,0 +1,4 @@
+#pragma once
+
+#include <rice/rice.hpp>
+#include <rice/stl.hpp>

data/ext/or-tools/extconf.rb

@@ -1,8 +1,6 @@
 require "mkmf-rice"
 
-raise "Missing stdc++" unless have_library("stdc++")
-
-$CXXFLAGS << " -std=c++17 -DUSE_CBC"
+$CXXFLAGS << " -std=c++17 $(optflags) -DUSE_CBC"
 
 # or-tools warnings
 $CXXFLAGS << " -Wno-sign-compare -Wno-shorten-64-to-32 -Wno-ignored-qualifiers"