or-tools 0.6.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1775ae46a18be137ae64fce870d29c17c3ae385c61f295f79d7ded40ed0be0bd
-  data.tar.gz: 28262f8b77a8dd0dc085e16a261005a47e1352d8f9f5c148ed524c348daec8db
+  metadata.gz: a94dfe67ccc7166a4ab27cbf5747d332452715db7ad302fa325ef7b5b270ef12
+  data.tar.gz: 36aacbdbf3be07f26e8711bc0ec00d8c1ac929288c62661f7425c721eb827c5d
 SHA512:
-  metadata.gz: 771d9a78ace00ce16d8f5e71f595a4523fd8613c81b8e09691d231cb1e7881ce94e8cdd0e21dd60168a58d40e0135891988cfc47fac33d511b551cf932819bae
-  data.tar.gz: 5231109d9afb080481f608bd784b3e86cdfc0b336f828d9fad714b5fa37eda0c4f02495e3718eeb9b0c05135b5b344a7084df55c7f26674ef2e73653ad7d8a3d
+  metadata.gz: 9c66c41c7b34b75f09725bbf74c04e7d7a9c2eee5251cc294480baa9a4f8a1a0fcde3534f75f3462d69fdc7c97ec5367dac1cf5fae210351ae731c1cb3c4d5f3
+  data.tar.gz: c8cc4f3c87e7199f9322caa714435699e000be1888f33e2c6b1121aa72dfab1d8b10ba8100fd3ff64b6dcc43853c2b36485922cab2f3b0268ec8cddb1fe15bdc

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.6.3 (2022-03-13)
+
+- Reduced gem size
+
+## 0.6.2 (2022-02-09)
+
+- Fixed segfaults with `Solver`
+
+## 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

data/NOTICE.txt

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

@@ -9,10 +9,10 @@
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'or-tools'
+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
 
@@ -2201,6 +2201,17 @@ 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-ruby/blob/master/CHANGELOG.md)

data/ext/or-tools/extconf.rb

@@ -25,12 +25,7 @@ end
 
 $INCFLAGS << " -I#{inc}"
 
-$LDFLAGS << " -Wl,-rpath,#{rpath}"
-$LDFLAGS << " -L#{lib}"
+$LDFLAGS.prepend("-Wl,-rpath,#{rpath} -L#{lib} ")
 raise "OR-Tools not found" unless have_library("ortools")
 
-Dir["#{lib}/libabsl_*.a"].each do |lib|
-  $LDFLAGS << " #{lib}"
-end
-
 create_makefile("or_tools/ext")

data/ext/or-tools/linear.cpp

@@ -46,86 +46,14 @@ namespace Rice::detail
 
 void init_linear(Rice::Module& m) {
   Rice::define_class_under<LinearRange>(m, "LinearRange");
+
+  // TODO remove in 0.7.0
   auto rb_cLinearExpr = Rice::define_class_under<LinearExpr>(m, "LinearExpr");
+  rb_cLinearExpr.define_constructor(Rice::Constructor<LinearExpr>());
 
-  Rice::define_class_under<MPVariable>(m, "MPVariable")
+  Rice::define_class_under<MPVariable, LinearExpr>(m, "MPVariable")
     .define_method("name", &MPVariable::name)
-    .define_method("solution_value", &MPVariable::solution_value)
-    .define_method(
-      "+",
-      [](MPVariable& self, LinearExpr& other) {
-        LinearExpr s(&self);
-        return s + other;
-      })
-    .define_method(
-      "-",
-      [](MPVariable& self, LinearExpr& other) {
-        LinearExpr s(&self);
-        return s - other;
-      })
-    .define_method(
-      "*",
-      [](MPVariable& self, double other) {
-        LinearExpr s(&self);
-        return s * other;
-      })
-    .define_method(
-      "inspect",
-      [](MPVariable& self) {
-        return "#<ORTools::MPVariable @name=\"" + self.name() + "\">";
-      });
-
-  rb_cLinearExpr
-    .define_constructor(Rice::Constructor<LinearExpr>())
-    .define_method(
-      "_add_linear_expr",
-      [](LinearExpr& self, LinearExpr& other) {
-        return self + other;
-      })
-    .define_method(
-      "_add_mp_variable",
-      [](LinearExpr& self, MPVariable &other) {
-        LinearExpr o(&other);
-        return self + o;
-      })
-    .define_method(
-      "_gte_double",
-      [](LinearExpr& self, double other) {
-        LinearExpr o(other);
-        return self >= o;
-      })
-    .define_method(
-      "_gte_linear_expr",
-      [](LinearExpr& self, LinearExpr& other) {
-        return self >= other;
-      })
-    .define_method(
-      "_lte_double",
-      [](LinearExpr& self, double other) {
-        LinearExpr o(other);
-        return self <= o;
-      })
-    .define_method(
-      "_lte_linear_expr",
-      [](LinearExpr& self, LinearExpr& other) {
-        return self <= other;
-      })
-    .define_method(
-      "==",
-      [](LinearExpr& self, double other) {
-        LinearExpr o(other);
-        return self == o;
-      })
-    .define_method(
-      "to_s",
-      [](LinearExpr& self) {
-        return self.ToString();
-      })
-    .define_method(
-      "inspect",
-      [](LinearExpr& self) {
-        return "#<ORTools::LinearExpr \"" + self.ToString() + "\">";
-      });
+    .define_method("solution_value", &MPVariable::solution_value);
 
   Rice::define_class_under<MPConstraint>(m, "MPConstraint")
     .define_method("set_coefficient", &MPConstraint::SetCoefficient);
@@ -133,7 +61,8 @@ void init_linear(Rice::Module& m) {
   Rice::define_class_under<MPObjective>(m, "MPObjective")
     .define_method("value", &MPObjective::Value)
     .define_method("set_coefficient", &MPObjective::SetCoefficient)
-    .define_method("set_maximization", &MPObjective::SetMaximization);
+    .define_method("set_maximization", &MPObjective::SetMaximization)
+    .define_method("set_minimization", &MPObjective::SetMinimization);
 
   Rice::define_class_under<MPSolver>(m, "Solver")
     .define_constructor(Rice::Constructor<MPSolver, std::string, MPSolver::OptimizationProblemType>())
@@ -155,21 +84,6 @@ void init_linear(Rice::Module& m) {
     .define_method("iterations", &MPSolver::iterations)
     .define_method("nodes", &MPSolver::nodes)
     .define_method("objective", &MPSolver::MutableObjective)
-    .define_method(
-      "maximize",
-      [](MPSolver& self, LinearExpr& expr) {
-        return self.MutableObjective()->MaximizeLinearExpr(expr);
-      })
-    .define_method(
-      "minimize",
-      [](MPSolver& self, LinearExpr& expr) {
-        return self.MutableObjective()->MinimizeLinearExpr(expr);
-      })
-    .define_method(
-      "add",
-      [](MPSolver& self, const LinearRange& range) {
-        return self.MakeRowConstraint(range);
-      })
     .define_method(
       "constraint",
       [](MPSolver& self, double lb, double ub) {

data/ext/or-tools/vendor.rb

@@ -1,3 +1,4 @@
+require "csv"
 require "digest"
 require "fileutils"
 require "net/http"
@@ -6,27 +7,46 @@ require "tmpdir"
 version = "9.2.9972"
 
 if RbConfig::CONFIG["host_os"] =~ /darwin/i
-  filename = "or-tools_MacOsX-12.0.1_v#{version}.tar.gz"
-  checksum = "796791a8ef84507d62e193e647cccb1c7725dae4f1474476e1777fe4a44ee3e0"
+  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"
+  # 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"
+  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"
+  elsif os == "debian" && os_version == "11"
     filename = "or-tools_amd64_debian-11_v#{version}.tar.gz"
     checksum = "bd49ee916213b2140ab255414d35a28f19dff7caf87632309753d3fc553f85dd"
-  elsif os == "Debian" && os_version == "10"
+  elsif os == "debian" && os_version == "10"
     filename = "or-tools_amd64_debian-10_v#{version}.tar.gz"
     checksum = "b152fee584f0c8228fe2ff21b74c789870ff9b7064e42ca26305c6b5653f0064"
-  elsif os == "CentOS" && os_version == "8"
+  elsif os == "centos" && os_version == "8"
     filename = "or-tools_amd64_centos-8_v#{version}.tar.gz"
     checksum = "66ed4bb800acf92c672f7e68acdf4ea27bbfdb17bbddc02f8326cd55a97305f6"
-  elsif os == "CentOS" && os_version == "7"
+  elsif os == "centos" && os_version == "7"
     filename = "or-tools_amd64_centos-7_v#{version}.tar.gz"
     checksum = "4a5c1b1639a2828cd7e1ba82a574ef37876557b59e8aab8b81811bb750d53035"
   else
@@ -101,12 +121,33 @@ end
 download_checksum = Digest::SHA256.file(download_path).hexdigest
 raise "Bad checksum: #{download_checksum}" if download_checksum != checksum
 
-# extract - can't use Gem::Package#extract_tar_gz from RubyGems
-# since it limits filenames to 100 characters (doesn't support UStar format)
 path = File.expand_path("../../tmp/or-tools", __dir__)
 FileUtils.mkdir_p(path)
-tar_args = Gem.win_platform? ? ["--force-local"] : []
-system "tar", "zxf", download_path, "-C", path, "--strip-components=1", *tar_args
+
+# extract - can't use Gem::Package#extract_tar_gz from RubyGems
+# since it limits filenames to 100 characters (doesn't support UStar format)
+# for space, only keep licenses, include, and shared library
+Dir.mktmpdir do |extract_path|
+  tar_args = Gem.win_platform? ? ["--force-local"] : []
+  system "tar", "zxf", download_path, "-C", extract_path, "--strip-components=1", *tar_args
+
+  # licenses
+  license_files = Dir.glob("**/*{LICENSE,LICENCE,NOTICE,COPYING,license,licence,notice,copying}*", base: extract_path)
+  raise "License not found" unless license_files.any?
+  license_files.each do |file|
+    FileUtils.mkdir_p(File.join(path, File.dirname(file)))
+    FileUtils.cp(File.join(extract_path, file), File.join(path, file))
+  end
+
+  # include
+  FileUtils.cp_r(File.join(extract_path, "include"), File.join(path, "include"))
+
+  # shared library
+  FileUtils.mkdir(File.join(path, "lib"))
+  Dir.glob("lib/libortools.{dylib,so}", base: extract_path) do |file|
+    FileUtils.cp(File.join(extract_path, file), File.join(path, file))
+  end
+end
 
 # export
 $vendor_path = path

data/lib/or-tools.rb

@@ -5,17 +5,22 @@ require "or_tools/ext"
 require "or_tools/comparison"
 require "or_tools/comparison_operators"
 require "or_tools/bool_var"
+require "or_tools/constant"
 require "or_tools/cp_model"
 require "or_tools/cp_solver"
 require "or_tools/cp_solver_solution_callback"
 require "or_tools/int_var"
 require "or_tools/knapsack_solver"
+require "or_tools/linear_constraint"
 require "or_tools/linear_expr"
+require "or_tools/mp_variable"
+require "or_tools/product_cst"
 require "or_tools/routing_index_manager"
 require "or_tools/routing_model"
 require "or_tools/sat_linear_expr"
 require "or_tools/sat_int_var"
 require "or_tools/solver"
+require "or_tools/sum_array"
 require "or_tools/version"
 
 # solution printers

data/lib/or_tools/comparison.rb

@@ -8,8 +8,13 @@ module ORTools
       @right = right
     end
 
-    def inspect
+    def to_s
       "#{left.inspect} #{operator} #{right.inspect}"
     end
+
+    # TODO add class
+    def inspect
+      to_s
+    end
   end
 end

data/lib/or_tools/constant.rb

@@ -0,0 +1,23 @@
+module ORTools
+  class Constant < LinearExpr
+    def initialize(val)
+      @val = val
+    end
+
+    def to_s
+      @val.to_s
+    end
+
+    def add_self_to_coeff_map_or_stack(coeffs, multiplier, stack)
+      coeffs[OFFSET_KEY] += @val * multiplier
+    end
+  end
+
+  class FakeMPVariableRepresentingTheConstantOffset
+    def solution_value
+      1
+    end
+  end
+
+  OFFSET_KEY = FakeMPVariableRepresentingTheConstantOffset.new
+end

data/lib/or_tools/linear_constraint.rb

@@ -0,0 +1,50 @@
+module ORTools
+  class LinearConstraint
+    attr_reader :expr, :lb, :ub
+
+    def initialize(expr, lb, ub)
+      @expr = expr
+      @lb = lb
+      @ub = ub
+    end
+
+    def to_s
+      if @lb > -Float::INFINITY && @ub < Float::INFINITY
+        if @lb == @ub
+          "#{@expr} == #{@lb}"
+        else
+          "#{@lb} <= #{@expr} <= #{@ub}"
+        end
+      elsif @lb > -Float::INFINITY
+        "#{@expr} >= #{@lb}"
+      elsif @ub < Float::INFINITY
+        "#{@expr} <= #{@ub}"
+      else
+        "Trivial inequality (always true)"
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} #{to_s}>"
+    end
+
+    def extract(solver)
+      coeffs = @expr.coeffs
+      constant = coeffs.delete(OFFSET_KEY) || 0.0
+      lb = -solver.infinity
+      ub = solver.infinity
+      if @lb > -Float::INFINITY
+        lb = @lb - constant
+      end
+      if @ub < Float::INFINITY
+        ub = @ub - constant
+      end
+
+      constraint = solver.constraint(lb, ub)
+      coeffs.each do |v, c|
+        constraint.set_coefficient(v, c.to_f)
+      end
+      constraint
+    end
+  end
+end

data/lib/or_tools/linear_expr.rb

@@ -1,27 +1,73 @@
 module ORTools
   class LinearExpr
-    def +(other)
-      if other.is_a?(LinearExpr)
-        _add_linear_expr(other)
+    def solution_value
+      coeffs.sum { |var, coeff| var.solution_value * coeff }
+    end
+
+    def coeffs
+      coeffs = Hash.new(0.0)
+      stack = [[1.0, self]]
+      while stack.any?
+        current_multiplier, current_expression = stack.pop
+
+        # skip empty LinearExpr for backwards compatibility
+        next if current_expression.instance_of?(LinearExpr)
+
+        current_expression.add_self_to_coeff_map_or_stack(coeffs, current_multiplier, stack)
+      end
+      coeffs
+    end
+
+    def +(expr)
+      SumArray.new([self, expr])
+    end
+
+    def -(expr)
+      SumArray.new([self, -expr])
+    end
+
+    def *(other)
+      ProductCst.new(self, other)
+    end
+
+    def /(cst)
+      ProductCst.new(self, 1.0 / other)
+    end
+
+    def -@
+      ProductCst.new(self, -1)
+    end
+
+    def ==(arg)
+      if arg.is_a?(Numeric)
+        LinearConstraint.new(self, arg, arg)
       else
-        _add_mp_variable(other)
+        LinearConstraint.new(self - arg, 0.0, 0.0)
       end
     end
 
-    def >=(other)
-      if other.is_a?(LinearExpr)
-        _gte_linear_expr(other)
+    def >=(arg)
+      if arg.is_a?(Numeric)
+        LinearConstraint.new(self, arg, Float::INFINITY)
       else
-        _gte_double(other)
+        LinearConstraint.new(self - arg, 0.0, Float::INFINITY)
       end
     end
 
-    def <=(other)
-      if other.is_a?(LinearExpr)
-        _lte_linear_expr(other)
+    def <=(arg)
+      if arg.is_a?(Numeric)
+        LinearConstraint.new(self, -Float::INFINITY, arg)
       else
-        _lte_double(other)
+        LinearConstraint.new(self - arg, -Float::INFINITY, 0.0)
       end
     end
+
+    def to_s
+      "(empty)"
+    end
+
+    def inspect
+      "#<#{self.class.name} #{to_s}>"
+    end
   end
 end

data/lib/or_tools/mp_variable.rb

@@ -0,0 +1,12 @@
+module ORTools
+  # TODO change to VariableExpr in 0.7.0
+  class MPVariable < LinearExpr
+    def add_self_to_coeff_map_or_stack(coeffs, multiplier, stack)
+      coeffs[self] += multiplier
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/or_tools/product_cst.rb

@@ -0,0 +1,31 @@
+module ORTools
+  class ProductCst < LinearExpr
+    attr_reader :expr, :coef
+
+    def initialize(expr, coef)
+      @expr = cast_to_lin_exp(expr)
+      # TODO improve message
+      raise TypeError, "expected numeric" unless coef.is_a?(Numeric)
+      @coef = coef
+    end
+
+    def to_s
+      if @coef == -1
+        "-#{@expr}"
+      else
+        "(#{@coef} * #{@expr})"
+      end
+    end
+
+    def add_self_to_coeff_map_or_stack(coeffs, multiplier, stack)
+      current_multiplier = multiplier * @coef
+      if current_multiplier
+        stack << [current_multiplier, @expr]
+      end
+    end
+
+    def cast_to_lin_exp(v)
+      v.is_a?(Numeric) ? Constant.new(v) : v
+    end
+  end
+end

data/lib/or_tools/sat_int_var.rb

@@ -18,9 +18,13 @@ module ORTools
       SatLinearExpr.new([[self, -1]])
     end
 
-    # for now
-    def inspect
+    def to_s
       name
     end
+
+    # TODO add class
+    def inspect
+      to_s
+    end
   end
 end

data/lib/or_tools/sat_linear_expr.rb

@@ -24,7 +24,7 @@ module ORTools
       end
     end
 
-    def inspect
+    def to_s
       vars.map do |v|
         k = v[0]
         k = k.respond_to?(:name) ? k.name : k.inspect
@@ -36,6 +36,11 @@ module ORTools
       end.join(" + ").sub(" + -", " - ")
     end
 
+    # TODO add class
+    def inspect
+      to_s
+    end
+
     private
 
     def add(other, sign)

data/lib/or_tools/solver.rb

@@ -1,7 +1,25 @@
 module ORTools
   class Solver
     def sum(arr)
-      arr.sum(LinearExpr.new)
+      SumArray.new(arr)
+    end
+
+    def add(expr)
+      expr.extract(self)
+    end
+
+    def maximize(expr)
+      expr.coeffs.each do |v, c|
+        objective.set_coefficient(v, c)
+      end
+      objective.set_maximization
+    end
+
+    def minimize(expr)
+      expr.coeffs.each do |v, c|
+        objective.set_coefficient(v, c)
+      end
+      objective.set_minimization
     end
   end
 end

data/lib/or_tools/sum_array.rb

@@ -0,0 +1,23 @@
+module ORTools
+  class SumArray < LinearExpr
+    attr_reader :array
+
+    def initialize(array)
+      @array = array.map { |v| cast_to_lin_exp(v) }
+    end
+
+    def add_self_to_coeff_map_or_stack(coeffs, multiplier, stack)
+      @array.reverse.each do |arg|
+        stack << [multiplier, arg]
+      end
+    end
+
+    def cast_to_lin_exp(v)
+      v.is_a?(Numeric) ? Constant.new(v) : v
+    end
+
+    def to_s
+      "(#{@array.map(&:to_s).join(" + ")})"
+    end
+  end
+end

data/lib/or_tools/version.rb

@@ -1,3 +1,3 @@
 module ORTools
-  VERSION = "0.6.0"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rice
@@ -50,13 +50,17 @@ files:
 - lib/or_tools/bool_var.rb
 - lib/or_tools/comparison.rb
 - lib/or_tools/comparison_operators.rb
+- lib/or_tools/constant.rb
 - lib/or_tools/cp_model.rb
 - lib/or_tools/cp_solver.rb
 - lib/or_tools/cp_solver_solution_callback.rb
 - lib/or_tools/int_var.rb
 - lib/or_tools/knapsack_solver.rb
+- lib/or_tools/linear_constraint.rb
 - lib/or_tools/linear_expr.rb
+- lib/or_tools/mp_variable.rb
 - lib/or_tools/objective_solution_printer.rb
+- lib/or_tools/product_cst.rb
 - lib/or_tools/routing_index_manager.rb
 - lib/or_tools/routing_model.rb
 - lib/or_tools/sat_int_var.rb
@@ -64,6 +68,7 @@ files:
 - lib/or_tools/seating.rb
 - lib/or_tools/solver.rb
 - lib/or_tools/sudoku.rb
+- lib/or_tools/sum_array.rb
 - lib/or_tools/tsp.rb
 - lib/or_tools/var_array_and_objective_solution_printer.rb
 - lib/or_tools/var_array_solution_printer.rb
@@ -87,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Operations research tools for Ruby