or-tools 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018061d137668676a2aca20c0ea0b1bbf01cfb19e02e0f7a532e9e4d800fb735'
-  data.tar.gz: 05e1f19947935d6ccf13c551cbf24cccd4fe3aa989d9bbbb31612c15837eb837
+  metadata.gz: c0e0f455741da72e3a215287df4ef1858893fb31d0b4be40db6ef9ab025e339c
+  data.tar.gz: 9291933eee08f800f48f3d83ca4f2d0fc71efb0a328134ba9667ca2ac8efb185
 SHA512:
-  metadata.gz: 4c32d4c6171f9c67011c4be7ec730583b1ea81cff00ab4ef865185b42fc5b0b7f843305e8bad31bcf22ad054fc0f7813e4d2ef84d0416bf42612c91800df699d
-  data.tar.gz: e13cb7b42a02d010f733e7f1b12d36fc79abf1718c3a8064b5d2d97d63b93f6e80c73f54743d6a290856d014c5f6a1141328e671c78fc9679a543fcc178ee2d5
+  metadata.gz: 61ccc7c5f3a6c3cdf1e3dffb1ee6572d0b8cde09d4684d50353efd6f2efcb93ca4ba940343f994a3bf65992e518331bd62a02ef74ecc52f2427e12350ea7a430
+  data.tar.gz: 589423f5b52c872b453569400ff1fd60bb1fcd3b0035e70aadbb47eedefec9b7f4187a5442893e50608529f836d2009bd77333aae3f64ce1b9d700df6fe020e7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.2 (2022-02-09)
+
+- Fixed segfaults with `Solver`
+
 ## 0.6.1 (2022-01-22)
 
 - Added installation instructions for Mac ARM

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,7 +9,7 @@
 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. For Mac ARM, also follow [these instructions](#additional-instructions).

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/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.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: or-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2022-02-09 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