or-tools 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0af0b1dc8198bf30ff09350e3c4da587735d5ece10204bf19c6dfc8916e2135
-  data.tar.gz: 6b685437c9d8cefcb91d52b24d090179a0884ad9a8edf966131493f3c8bc1dbf
+  metadata.gz: dba74899e2a57b086643657e5093f12e67fd4fcdda7e22c2b533911f9991e43a
+  data.tar.gz: 963c0b75f55b4b772ead3a8402ec8bb4b90570c23de1c7dc3a437758e8949af2
 SHA512:
-  metadata.gz: 80ed4a17f6079d997ef42b8659cea3879f4b0935e8bbfa7e566a76937b2ea0f86f906b3bb236bd43f17cecb6364c3025916074438f768c7853e60a87a025d150
-  data.tar.gz: 9b9e085b2cf01a3dc7d1f77363c903dfb7d6e41280626c37408da9889534ac7c5c85d49c73714022461ae55df36abb10932b4ae9272d10d910e95a6681cddad6
+  metadata.gz: a5dc8662ec580c97a905817867346615e2fbb187d5b75d6b2b839a86e7385a20b2ed4f9f4c13ed536079c6141cdd0bf95bfad7ea6408d4eb81d8f0ed09e32a68
+  data.tar.gz: 195967d1e662ba05751ff31fbec3c96ebac519cd58a343ca551f9ba6c12304542b7f4127a37f88e99cda6b214d42089df7ed9b5a3134c0ec1eb978ea72a95be4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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

data/NOTICE.txt

@@ -1,5 +1,5 @@
 Copyright 2010-2018 Google LLC
-Copyright 2020 Andrew Kane
+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

@@ -638,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) {
@@ -662,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",
@@ -701,6 +709,8 @@ 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");
         }
@@ -806,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)
@@ -822,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/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/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-description: 
+description:
 email: andrew@chartkick.com
 executables: []
 extensions:
@@ -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
@@ -133,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: []