or-tools 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e179505f9df7d80af6a316ca719594fa2a99839c8c26b0f33ee1551b4e7b2d3
-  data.tar.gz: b05dc3c553d11112e55855bb91b0382a3a648a14848e5c9d6e3805bf52e009fb
+  metadata.gz: '018061d137668676a2aca20c0ea0b1bbf01cfb19e02e0f7a532e9e4d800fb735'
+  data.tar.gz: 05e1f19947935d6ccf13c551cbf24cccd4fe3aa989d9bbbb31612c15837eb837
 SHA512:
-  metadata.gz: fa77b818baf408c3cf30b56065f0b9b7f877358e1f0d39718a3ebc1f49fc4dae78da9678875c340895427f189074939e220ffa320207bea76bd0d7921f0675d7
-  data.tar.gz: 7c174df348ad0835c93a56ecb51a6f9763aaba43f0d3fc3eaf0b8b745922a204d86ee6fae6ba3fba632b284179251decbbfce17b2a1dd1e608d91b96cf3ff9ec
+  metadata.gz: 4c32d4c6171f9c67011c4be7ec730583b1ea81cff00ab4ef865185b42fc5b0b7f843305e8bad31bcf22ad054fc0f7813e4d2ef84d0416bf42612c91800df699d
+  data.tar.gz: e13cb7b42a02d010f733e7f1b12d36fc79abf1718c3a8064b5d2d97d63b93f6e80c73f54743d6a290856d014c5f6a1141328e671c78fc9679a543fcc178ee2d5

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.6.1 (2022-01-22)
+
+- Added installation instructions for Mac ARM
+- Removed dependency on `lsb_release` for binary installation on Linux
+
+## 0.6.0 (2021-12-16)
+
+- Updated OR-Tools to 9.2
+- Renamed `add_product_equality` to `add_multiplication_equality`
+- Removed `scale_objective_by`
+
+## 0.5.4 (2021-10-01)
+
+- Updated OR-Tools to 9.1
+- Added binary installation for Debian 11
+- Deprecated `solve_with_solution_callback` and `search_for_all_solutions`
+
+## 0.5.3 (2021-08-02)
+
+- Added more methods to `IntVar`, `IntervalVar`, and `Constraint`
+- Added `RoutingModelParameters`
+
 ## 0.5.2 (2021-07-07)
 
 - Added `export_model_as_lp_format` and `export_model_as_mps_format` to `Solver`

data/README.md

@@ -1,8 +1,8 @@
-# OR-Tools
+# OR-Tools Ruby
 
 [OR-Tools](https://github.com/google/or-tools) - operations research tools - for Ruby
 
-[![Build Status](https://github.com/ankane/or-tools/workflows/build/badge.svg?branch=master)](https://github.com/ankane/or-tools/actions)
+[![Build Status](https://github.com/ankane/or-tools-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/or-tools-ruby/actions)
 
 ## Installation
 
@@ -12,7 +12,7 @@ Add this line to your application’s Gemfile:
 gem 'or-tools'
 ```
 
-Installation can take a few minutes as OR-Tools downloads and builds.
+Installation can take a few minutes as OR-Tools downloads and builds. For Mac ARM, also follow [these instructions](#additional-instructions).
 
 ## Higher Level Interfaces
 
@@ -2139,7 +2139,7 @@ model.add(seats[[0, 0]] == 1)
 # Solve model
 solver = ORTools::CpSolver.new
 solution_printer = WeddingChartPrinter.new(seats, names, num_tables, num_guests)
-solver.solve_with_solution_callback(model, solution_printer)
+solver.solve(model, solution_printer)
 
 puts "Statistics"
 puts "  - conflicts    : %i" % solver.num_conflicts
@@ -2201,24 +2201,35 @@ possible_tables.each do |table|
 end
 ```
 
+## Additional Instructions
+
+### Mac ARM
+
+ARM binaries are not available for Mac yet, so use Homebrew to install OR-Tools before installing the gem.
+
+```sh
+brew install or-tools
+bundle config build.or-tools --with-or-tools-dir=/opt/homebrew
+```
+
 ## History
 
-View the [changelog](https://github.com/ankane/or-tools/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/or-tools-ruby/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/or-tools/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/or-tools/pulls)
+- [Report bugs](https://github.com/ankane/or-tools-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/or-tools-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone https://github.com/ankane/or-tools.git
-cd or-tools
+git clone https://github.com/ankane/or-tools-ruby.git
+cd or-tools-ruby
 bundle install
 bundle exec rake compile
 bundle exec rake test

data/ext/or-tools/constraint.cpp

@@ -131,10 +131,21 @@ void init_constraint(Rice::Module& m) {
 
   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>())
@@ -276,9 +287,9 @@ void init_constraint(Rice::Module& m) {
         return self.AddModuloEquality(target, var, mod);
       })
     .define_method(
-      "add_product_equality",
+      "add_multiplication_equality",
       [](CpModelBuilder& self, IntVar target, std::vector<IntVar> vars) {
-        return self.AddProductEquality(target, vars);
+        return self.AddMultiplicationEquality(target, vars);
       })
     .define_method(
       "add_no_overlap",
@@ -295,11 +306,6 @@ void init_constraint(Rice::Module& m) {
       [](CpModelBuilder& self, LinearExpr expr) {
         self.Minimize(expr);
       })
-    .define_method(
-      "scale_objective_by",
-      [](CpModelBuilder& self, double scaling) {
-        self.ScaleObjectiveBy(scaling);
-      })
     .define_method(
       "add_hint",
       [](CpModelBuilder& self, IntVar var, int64_t value) {
@@ -377,29 +383,23 @@ void init_constraint(Rice::Module& m) {
 
   Rice::define_class_under(m, "CpSolver")
     .define_method(
-      "_solve_with_observer",
-      [](Object self, CpModelBuilder& model, SatParameters& parameters, Object callback, bool all_solutions) {
+      "_solve",
+      [](Object self, CpModelBuilder& model, SatParameters& parameters, Object callback) {
         Model m;
 
-        if (all_solutions) {
-          // set parameters for SearchForAllSolutions
-          parameters.set_enumerate_all_solutions(true);
+        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));
 
-        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);
       })

data/ext/or-tools/routing.cpp

@@ -4,12 +4,14 @@
 #include "ext.h"
 
 using operations_research::Assignment;
+using operations_research::ConstraintSolverParameters;
 using operations_research::DefaultRoutingSearchParameters;
 using operations_research::FirstSolutionStrategy;
 using operations_research::LocalSearchMetaheuristic;
 using operations_research::RoutingDimension;
 using operations_research::RoutingIndexManager;
 using operations_research::RoutingModel;
+using operations_research::RoutingModelParameters;
 using operations_research::RoutingNodeIndex;
 using operations_research::RoutingSearchParameters;
 
@@ -163,19 +165,45 @@ void init_routing(Rice::Module& m) {
 
   // not to be confused with operations_research::sat::IntVar
   rb_cIntVar
+    .define_method("var?", &operations_research::IntVar::IsVar)
+    .define_method("value", &operations_research::IntVar::Value)
+    .define_method("remove_value", &operations_research::IntVar::RemoveValue)
+    .define_method("remove_interval", &operations_research::IntVar::RemoveInterval)
+    .define_method("remove_values", &operations_research::IntVar::RemoveValues)
+    .define_method("set_values", &operations_research::IntVar::SetValues)
+    .define_method("size", &operations_research::IntVar::Size)
+    .define_method("contains", &operations_research::IntVar::Contains)
+    .define_method("old_min", &operations_research::IntVar::OldMin)
+    .define_method("old_max", &operations_research::IntVar::OldMax)
     .define_method(
       "set_range",
       [](operations_research::IntVar& self, int64_t new_min, int64_t new_max) {
         self.SetRange(new_min, new_max);
       });
 
-  Rice::define_class_under<operations_research::IntervalVar>(m, "IntervalVar");
+  Rice::define_class_under<operations_research::IntervalVar>(m, "IntervalVar")
+    .define_method("start_min", &operations_research::IntervalVar::StartMin)
+    .define_method("start_max", &operations_research::IntervalVar::StartMax)
+    .define_method("set_start_min", &operations_research::IntervalVar::SetStartMin)
+    .define_method("set_start_max", &operations_research::IntervalVar::SetStartMax)
+    .define_method("set_start_range", &operations_research::IntervalVar::SetStartRange)
+    .define_method("old_start_min", &operations_research::IntervalVar::OldStartMin)
+    .define_method("old_start_max", &operations_research::IntervalVar::OldStartMax)
+    .define_method("end_min", &operations_research::IntervalVar::EndMin)
+    .define_method("end_max", &operations_research::IntervalVar::EndMax)
+    .define_method("set_end_min", &operations_research::IntervalVar::SetEndMin)
+    .define_method("set_end_max", &operations_research::IntervalVar::SetEndMax)
+    .define_method("set_end_range", &operations_research::IntervalVar::SetEndRange)
+    .define_method("old_end_min", &operations_research::IntervalVar::OldEndMin)
+    .define_method("old_end_max", &operations_research::IntervalVar::OldEndMax);
 
   Rice::define_class_under<RoutingDimension>(m, "RoutingDimension")
     .define_method("global_span_cost_coefficient=", &RoutingDimension::SetGlobalSpanCostCoefficient)
     .define_method("cumul_var", &RoutingDimension::CumulVar);
 
-  Rice::define_class_under<operations_research::Constraint>(m, "Constraint");
+  Rice::define_class_under<operations_research::Constraint>(m, "Constraint")
+    .define_method("post", &operations_research::Constraint::Post)
+    .define_method("debug_string", &operations_research::Constraint::DebugString);
 
   Rice::define_class_under<operations_research::Solver>(m, "Solver2")
     .define_method(
@@ -209,8 +237,33 @@ void init_routing(Rice::Module& m) {
         return self.MakeCumulative(intervals, demands, capacity, name);
       });
 
+  Rice::define_class_under<ConstraintSolverParameters>(m, "ConstraintSolverParameters")
+    .define_method(
+      "trace_propagation=",
+      [](ConstraintSolverParameters& self, bool value) {
+        self.set_trace_propagation(value);
+      })
+    .define_method(
+      "trace_search=",
+      [](ConstraintSolverParameters& self, bool value) {
+        self.set_trace_search(value);
+      });
+
+  Rice::define_class_under<RoutingModelParameters>(m, "RoutingModelParameters")
+    .define_method(
+      "solver_parameters",
+      [](RoutingModelParameters& self) {
+        return self.mutable_solver_parameters();
+      });
+
+  m.define_singleton_function(
+    "default_routing_model_parameters",
+    []() {
+      return operations_research::DefaultRoutingModelParameters();
+    });
+
   Rice::define_class_under<RoutingModel>(m, "RoutingModel")
-    .define_constructor(Rice::Constructor<RoutingModel, RoutingIndexManager>())
+    .define_constructor(Rice::Constructor<RoutingModel, RoutingIndexManager, RoutingModelParameters>(), Rice::Arg("index_manager"), Rice::Arg("parameters") = operations_research::DefaultRoutingModelParameters())
     .define_method(
       "register_transit_callback",
       [](RoutingModel& self, Object callback) {

data/ext/or-tools/vendor.rb

@@ -1,31 +1,54 @@
+require "csv"
 require "digest"
 require "fileutils"
 require "net/http"
 require "tmpdir"
 
-version = "9.0.9048"
+version = "9.2.9972"
 
 if RbConfig::CONFIG["host_os"] =~ /darwin/i
-  filename = "or-tools_MacOsX-11.2.3_v#{version}.tar.gz"
-  checksum = "adf73a00d4ec49558b67be5ce3cfc8f30268da2253b35feb11d0d40700550bf6"
+  if RbConfig::CONFIG["host_cpu"] =~ /arm|aarch64/i
+    raise <<~MSG
+      Binary installation not available for this platform: Mac ARM
+
+      Run:
+      brew install or-tools
+      bundle config build.or-tools --with-or-tools-dir=/opt/homebrew
+
+    MSG
+  else
+    filename = "or-tools_MacOsX-12.0.1_v#{version}.tar.gz"
+    checksum = "796791a8ef84507d62e193e647cccb1c7725dae4f1474476e1777fe4a44ee3e0"
+  end
 else
-  os = %x[lsb_release -is].chomp rescue nil
-  os_version = %x[lsb_release -rs].chomp rescue nil
-  if os == "Ubuntu" && os_version == "20.04"
-    filename = "or-tools_ubuntu-20.04_v#{version}.tar.gz"
-    checksum = "5565343c1c310d2885a40ce850ae7e3468299b3fee97ae8eed8425ce06bd4960"
-  elsif os == "Ubuntu" && os_version == "18.04"
-    filename = "or-tools_ubuntu-18.04_v#{version}.tar.gz"
-    checksum = "08cf548d0179f7fa814bb7458be94cd1b8a3de14985e6a9faf6118a1d8571539"
-  elsif os == "Debian" && os_version == "10"
-    filename = "or-tools_debian-10_v#{version}.tar.gz"
-    checksum = "063fb1d8765ae23b0bb25b9c561e904532713416fe0458f7db45a0f72190eb50"
-  elsif os == "CentOS" && os_version == "8"
-    filename = "or-tools_centos-8_v#{version}.tar.gz"
-    checksum = "c98212ed4fc699d8ae70c1f53cd1d8dacd28e52970336fab5b86dedf7406f215"
-  elsif os == "CentOS" && os_version == "7"
-    filename = "or-tools_centos-7_v#{version}.tar.gz"
-    checksum = "b992bda4614bbc703583b0e9edcd2ade54bacfb9909399b20c8aa95ff7197d68"
+  # try /etc/os-release with fallback to /usr/lib/os-release
+  # https://www.freedesktop.org/software/systemd/man/os-release.html
+  os_filename = File.exist?("/etc/os-release") ? "/etc/os-release" : "/usr/lib/os-release"
+
+  # for safety, parse rather than source
+  os_info = CSV.read(os_filename, col_sep: "=").to_h rescue {}
+
+  os = os_info["ID"]
+  os_version = os_info["VERSION_ID"]
+
+  if os == "ubuntu" && os_version == "20.04"
+    filename = "or-tools_amd64_ubuntu-20.04_v#{version}.tar.gz"
+    checksum = "985e3036eaecacfc8a0258ec2ebef429240491577d4e0896d68fc076e65451ec"
+  elsif os == "ubuntu" && os_version == "18.04"
+    filename = "or-tools_amd64_ubuntu-18.04_v#{version}.tar.gz"
+    checksum = "e36406c4fe8c111e1ace0ede9d0787ff0e98f11afd7db9cc074adfd0f55628a6"
+  elsif os == "debian" && os_version == "11"
+    filename = "or-tools_amd64_debian-11_v#{version}.tar.gz"
+    checksum = "bd49ee916213b2140ab255414d35a28f19dff7caf87632309753d3fc553f85dd"
+  elsif os == "debian" && os_version == "10"
+    filename = "or-tools_amd64_debian-10_v#{version}.tar.gz"
+    checksum = "b152fee584f0c8228fe2ff21b74c789870ff9b7064e42ca26305c6b5653f0064"
+  elsif os == "centos" && os_version == "8"
+    filename = "or-tools_amd64_centos-8_v#{version}.tar.gz"
+    checksum = "66ed4bb800acf92c672f7e68acdf4ea27bbfdb17bbddc02f8326cd55a97305f6"
+  elsif os == "centos" && os_version == "7"
+    filename = "or-tools_amd64_centos-7_v#{version}.tar.gz"
+    checksum = "4a5c1b1639a2828cd7e1ba82a574ef37876557b59e8aab8b81811bb750d53035"
   else
     platform =
       if Gem.win_platform?

data/lib/or_tools/cp_solver.rb

@@ -6,8 +6,8 @@ module ORTools
 
     def_delegators :@response, :objective_value, :num_conflicts, :num_branches, :wall_time
 
-    def solve(model)
-      @response = _solve(model, parameters)
+    def solve(model, observer = nil)
+      @response = _solve(model, parameters, observer)
       @response.status
     end
 
@@ -20,13 +20,19 @@ module ORTools
     end
 
     def solve_with_solution_callback(model, observer)
-      @response = _solve_with_observer(model, parameters, observer, false)
-      @response.status
+      warn "[or-tools] solve_with_solution_callback is deprecated; use solve(model, callback)"
+      solve(model, observer)
     end
 
     def search_for_all_solutions(model, observer)
-      @response = _solve_with_observer(model, parameters, observer, true)
-      @response.status
+      warn "[or-tools] search_for_all_solutions is deprecated; use solve() with solver.parameters.enumerate_all_solutions = true"
+      previous_value = parameters.enumerate_all_solutions
+      begin
+        parameters.enumerate_all_solutions = true
+        solve(model, observer)
+      ensure
+        parameters.enumerate_all_solutions = previous_value
+      end
     end
 
     def sufficient_assumptions_for_infeasibility

data/lib/or_tools/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.5.2"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -68,7 +68,7 @@ files:
 - lib/or_tools/var_array_and_objective_solution_printer.rb
 - lib/or_tools/var_array_solution_printer.rb
 - lib/or_tools/version.rb
-homepage: https://github.com/ankane/or-tools
+homepage: https://github.com/ankane/or-tools-ruby
 licenses:
 - MIT
 metadata: {}
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Operations research tools for Ruby