or-tools 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18b9ab384a5aa4b8d27a3415de9ba751085e63b95cbdc431d1fee206b05e1c37
-  data.tar.gz: 4b8d29c3f6b5fff8181a817737a818e2c3d7cf6cd0184d82078d4606c2c94740
+  metadata.gz: e557f98fc061c46799334f589a41f1592da361bce8a6e199120d3425efe67c0a
+  data.tar.gz: be6fa049625b6d9aae8134b34a4731053b1e3b12c7481dd041bdb98e40648c1d
 SHA512:
-  metadata.gz: 26e5b155bdd5c0d37aaf13fe26c674ac15ac693933999056a477e340823ced7e86b8565c00c941d4ecdfd35e0b5a4716465e2418bf1e44ca7c1586d171e77515
-  data.tar.gz: 1c87b6df5082d9ab61b1ab63d154e563fdd9405fa3dda5fd00df2f6aafc65c7f5f8d251938cab9cba58de04efb7f38b11893701c128833059b8290b3a3dfb0da
+  metadata.gz: 5f5542b967fc7fd25afa4598bcfa99c17978e8020ced4af449ca00e8e7e20f2aeb1e5de2b6d562a60cd880afa14f9ea383c12a3d3fe7434dc2f4837d98e18d24
+  data.tar.gz: 69506b406afe60200592f5b526ce617fba45d8581e253ca12b143d243aa1d9fdda5c2e122e24d5dd516e9e141a542ed5eaef834861ccfa3917693d8f1971ffca

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 0.4.0 (2021-01-14)
+
+- Updated OR-Tools to 8.1
+
+## 0.3.4 (2021-01-14)
+
+- Added support for time limit for `CpSolver`
+- Added `add_dimension_with_vehicle_transits` and `status` methods to `RoutingModel`
+
+## 0.3.3 (2020-10-12)
+
+- Added support for start and end points for routing
+
+## 0.3.2 (2020-08-04)
+
+- Updated OR-Tools to 7.8
+- Added binary installation for Ubuntu 20.04
+
+## 0.3.1 (2020-07-21)
+
+- Reduced gem size
+
 ## 0.3.0 (2020-07-21)
 
 - Updated OR-Tools to 7.7

data/NOTICE.txt

@@ -1,4 +1,5 @@
-Copyright 2020 Andrew Kane
+Copyright 2010-2018 Google LLC
+Copyright 2020-2021 Andrew Kane
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -2,7 +2,7 @@
 
 [OR-Tools](https://github.com/google/or-tools) - operations research tools - for Ruby
 
-[![Build Status](https://travis-ci.org/ankane/or-tools.svg?branch=master)](https://travis-ci.org/ankane/or-tools)
+[![Build Status](https://github.com/ankane/or-tools/workflows/build/badge.svg?branch=master)](https://github.com/ankane/or-tools/actions)
 
 ## Installation
 
@@ -267,6 +267,7 @@ Constraint Optimization
 - [Solving an Optimization Problem](#solving-an-optimization-problem)
 - [Cryptarithmetic](#cryptarithmetic)
 - [The N-queens Problem](#the-n-queens-problem)
+- [Setting Solver Limits](#setting-solver-limits) [master]
 
 Assignment
 
@@ -578,6 +579,39 @@ puts
 puts "Solutions found : %i" % solution_printer.solution_count
 ```
 
+### Setting Solver Limits
+
+[Guide](https://developers.google.com/optimization/cp/cp_tasks)
+
+```ruby
+# create the model
+model = ORTools::CpModel.new
+
+# create the variables
+num_vals = 3
+x = model.new_int_var(0, num_vals - 1, "x")
+y = model.new_int_var(0, num_vals - 1, "y")
+z = model.new_int_var(0, num_vals - 1, "z")
+
+# add an all-different constraint
+model.add(x != y)
+
+# create the solver
+solver = ORTools::CpSolver.new
+
+# set a time limit of 10 seconds.
+solver.parameters.max_time_in_seconds = 10
+
+# solve the model
+status = solver.solve(model)
+
+# display the first solution
+if status == :optimal
+  puts "x = #{solver.value(x)}"
+  puts "y = #{solver.value(y)}"
+  puts "z = #{solver.value(z)}"
+end
+```
 
 ### Assignment
 

data/ext/or-tools/ext.cpp

@@ -101,6 +101,14 @@ Object to_ruby<RoutingNodeIndex>(RoutingNodeIndex const &x)
   return to_ruby<int>(x.value());
 }
 
+std::vector<RoutingNodeIndex> nodeIndexVector(Array x) {
+  std::vector<RoutingNodeIndex> res;
+  for (auto const& v : x) {
+    res.push_back(from_ruby<RoutingNodeIndex>(v));
+  }
+  return res;
+}
+
 template<>
 inline
 operations_research::sat::LinearExpr from_ruby<operations_research::sat::LinearExpr>(Object x)
@@ -630,18 +638,24 @@ void Init_ext()
         self.Minimize(expr);
       });
 
+  define_class_under<SatParameters>(rb_mORTools, "SatParameters")
+    .define_constructor(Constructor<SatParameters>())
+    .define_method("max_time_in_seconds=",
+    *[](SatParameters& self, double value) {
+      self.set_max_time_in_seconds(value);
+    });
+
   define_class_under(rb_mORTools, "CpSolver")
     .define_method(
       "_solve_with_observer",
-      *[](Object self, CpModelBuilder& model, Object callback, bool all_solutions) {
+      *[](Object self, CpModelBuilder& model, SatParameters& parameters, Object callback, bool all_solutions) {
         operations_research::sat::Model m;
 
         if (all_solutions) {
           // set parameters for SearchForAllSolutions
-          SatParameters parameters;
           parameters.set_enumerate_all_solutions(true);
-          m.Add(NewSatParameters(parameters));
         }
+        m.Add(NewSatParameters(parameters));
 
         m.Add(NewFeasibleSolutionObserver(
           [callback](const CpSolverResponse& r) {
@@ -654,8 +668,10 @@ void Init_ext()
       })
     .define_method(
       "_solve",
-      *[](Object self, CpModelBuilder& model) {
-        return Solve(model.Build());
+      *[](Object self, CpModelBuilder& model, SatParameters& parameters) {
+        operations_research::sat::Model m;
+        m.Add(NewSatParameters(parameters));
+        return SolveCpModel(model.Build(), &m);
       })
     .define_method(
       "_solution_integer_value",
@@ -693,13 +709,24 @@ void Init_ext()
           return Symbol("infeasible");
         } else if (status == CpSolverStatus::MODEL_INVALID) {
           return Symbol("model_invalid");
+        } else if (status == CpSolverStatus::UNKNOWN) {
+          return Symbol("unknown");
         } else {
           throw std::runtime_error("Unknown solver status");
         }
       });
 
   define_class_under<RoutingIndexManager>(rb_mORTools, "RoutingIndexManager")
-    .define_constructor(Constructor<RoutingIndexManager, int, int, RoutingNodeIndex>())
+    .define_singleton_method(
+      "_new_depot",
+      *[](int num_nodes, int num_vehicles, RoutingNodeIndex depot) {
+        return RoutingIndexManager(num_nodes, num_vehicles, depot);
+      })
+    .define_singleton_method(
+      "_new_starts_ends",
+      *[](int num_nodes, int num_vehicles, Array starts, Array ends) {
+        return RoutingIndexManager(num_nodes, num_vehicles, nodeIndexVector(starts), nodeIndexVector(ends));
+      })
     .define_method("index_to_node", &RoutingIndexManager::IndexToNode)
     .define_method("node_to_index", &RoutingIndexManager::NodeToIndex);
 
@@ -789,6 +816,23 @@ void Init_ext()
       })
     .define_method("depot", &RoutingModel::GetDepot)
     .define_method("size", &RoutingModel::Size)
+    .define_method("status", *[](RoutingModel& self) {
+        auto status = self.status();
+
+        if (status == RoutingModel::ROUTING_NOT_SOLVED) {
+          return Symbol("not_solved");
+        } else if (status == RoutingModel::ROUTING_SUCCESS) {
+          return Symbol("success");
+        } else if (status == RoutingModel::ROUTING_FAIL) {
+          return Symbol("fail");
+        } else if (status == RoutingModel::ROUTING_FAIL_TIMEOUT) {
+          return Symbol("fail_timeout");
+        } else if (status == RoutingModel::ROUTING_INVALID) {
+          return Symbol("invalid");
+        } else {
+          throw std::runtime_error("Unknown solver status");
+        }
+      })
     .define_method("vehicle_var", &RoutingModel::VehicleVar)
     .define_method("set_arc_cost_evaluator_of_all_vehicles", &RoutingModel::SetArcCostEvaluatorOfAllVehicles)
     .define_method("set_arc_cost_evaluator_of_vehicle", &RoutingModel::SetArcCostEvaluatorOfVehicle)
@@ -805,6 +849,15 @@ void Init_ext()
         }
         self.AddDimensionWithVehicleCapacity(evaluator_index, slack_max, vehicle_capacities, fix_start_cumul_to_zero, name);
       })
+    .define_method(
+      "add_dimension_with_vehicle_transits",
+      *[](RoutingModel& self, Array rb_indices, int64 slack_max, int64 capacity, bool fix_start_cumul_to_zero, const std::string& name) {
+        std::vector<int> evaluator_indices;
+        for (std::size_t i = 0; i < rb_indices.size(); ++i) {
+          evaluator_indices.push_back(from_ruby<int>(rb_indices[i]));
+        }
+        self.AddDimensionWithVehicleTransits(evaluator_indices, slack_max, capacity, fix_start_cumul_to_zero, name);
+      })
     .define_method(
       "add_disjunction",
       *[](RoutingModel& self, Array rb_indices, int64 penalty) {

data/ext/or-tools/extconf.rb

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

data/ext/or-tools/vendor.rb

@@ -3,26 +3,26 @@ require "fileutils"
 require "net/http"
 require "tmpdir"
 
-version = "7.7.7810"
+version = "8.1.8487"
 
 if RbConfig::CONFIG["host_os"] =~ /darwin/i
-  filename = "or-tools_MacOsX-10.15.5_v#{version}.tar.gz"
-  checksum = "764f290f6d916bc366913a37d93e6f83bd7969ad33515ccc1ca390f544d65721"
+  filename = "or-tools_MacOsX-10.15.7_v#{version}.tar.gz"
+  checksum = "cdf5d5c4dd10ddfa39eb951e6b8122b2a48c7d1dbd87bb5f792a7596aea8b8bb"
 else
   os = %x[lsb_release -is].chomp rescue nil
   os_version = %x[lsb_release -rs].chomp rescue nil
-  if os == "Ubuntu" && os_version == "18.04"
+  if os == "Ubuntu" && os_version == "20.04"
+    filename = "or-tools_ubuntu-20.04_v#{version}.tar.gz"
+    checksum = "2de596d649d9a0f0dfec8007d6e1018d8fdddced7aa340b4e68d02e61df89a2e"
+  elsif os == "Ubuntu" && os_version == "18.04"
     filename = "or-tools_ubuntu-18.04_v#{version}.tar.gz"
-    checksum = "12bdac29144b077b3f9ba602f947e4b9b9ce63ed3df4e325cda1333827edbcf8"
-  elsif os == "Ubuntu" && os_version == "16.04"
-    filename = "or-tools_ubuntu-16.04_v#{version}.tar.gz"
-    checksum = "cc696d342b97aa6cf7c62b6ae2cae95dfc665f2483d147c4117fdba434b13a53"
+    checksum = "201cf1d17379240311208f4c641bb5263ae19d8c4c1a6091d2778948fd375f48"
   elsif os == "Debian" && os_version == "10"
     filename = "or-tools_debian-10_v#{version}.tar.gz "
-    checksum = "3dd0299e9ad8d12fe6d186bfd59e63080c8e9f3c6b0489af9900c389cf7e4224"
+    checksum = "18028ef7287cd83eed3dafeae1243a9adb445675f45984e8d3c60ab9e2aa75bd"
   elsif os == "CentOS" && os_version == "8"
     filename = "or-tools_centos-8_v#{version}.tar.gz"
-    checksum = "1f7d8bce56807c4283374e05024ffac8afd81ff99063217418d02d626cf03088"
+    checksum = "e26229320f9b78315f0122b55d16093c79e2dc6c95d591f4788f323f27cfd3bf"
   else
     # there is a binary download for Windows
     # however, it's compiled with Visual Studio rather than MinGW (which RubyInstaller uses)

data/lib/or-tools.rb

@@ -11,6 +11,7 @@ require "or_tools/cp_solver_solution_callback"
 require "or_tools/int_var"
 require "or_tools/knapsack_solver"
 require "or_tools/linear_expr"
+require "or_tools/routing_index_manager"
 require "or_tools/routing_model"
 require "or_tools/sat_linear_expr"
 require "or_tools/sat_int_var"

data/lib/or_tools/cp_solver.rb

@@ -7,7 +7,7 @@ module ORTools
     def_delegators :@response, :objective_value, :num_conflicts, :num_branches, :wall_time
 
     def solve(model)
-      @response = _solve(model)
+      @response = _solve(model, parameters)
       @response.status
     end
 
@@ -20,13 +20,17 @@ module ORTools
     end
 
     def solve_with_solution_callback(model, observer)
-      @response = _solve_with_observer(model, observer, false)
+      @response = _solve_with_observer(model, parameters, observer, false)
       @response.status
     end
 
     def search_for_all_solutions(model, observer)
-      @response = _solve_with_observer(model, observer, true)
+      @response = _solve_with_observer(model, parameters, observer, true)
       @response.status
     end
+
+    def parameters
+      @parameters ||= SatParameters.new
+    end
   end
 end

data/lib/or_tools/routing_index_manager.rb

@@ -0,0 +1,11 @@
+module ORTools
+  class RoutingIndexManager
+    def self.new(num_nodes, num_vehicles, starts, ends = nil)
+      if ends
+        _new_starts_ends(num_nodes, num_vehicles, starts, ends)
+      else
+        _new_depot(num_nodes, num_vehicles, starts)
+      end
+    end
+  end
+end

data/lib/or_tools/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-description: 
+description:
 email: andrew@chartkick.com
 executables: []
 extensions:
@@ -102,10 +102,10 @@ files:
 - 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/int_var.rb
 - lib/or_tools/knapsack_solver.rb
 - lib/or_tools/linear_expr.rb
+- lib/or_tools/routing_index_manager.rb
 - lib/or_tools/routing_model.rb
 - lib/or_tools/sat_int_var.rb
 - lib/or_tools/sat_linear_expr.rb
@@ -118,7 +118,7 @@ homepage: https://github.com/ankane/or-tools
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,15 +126,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Operations research tools for Ruby
 test_files: []