rulp 0.0.45 → 0.0.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a47250456efb480a41ea21a923355242c38c27d1e9eb04d17782493a51b083
-  data.tar.gz: e7b05a98c43d57035049cd1b2537fd3ecb42792e08114d8dd0729229092e96ac
+  metadata.gz: 85bd89961eddfceba98245a2ac9882467ae8363209242a3b87bf092afc746d28
+  data.tar.gz: 7fdaf681f33655e4fbd461363ca4d94c581362080958b50fef21050f6562d29c
 SHA512:
-  metadata.gz: d12655f339c1095d9bc5f3c4620829965e3375ae4025fceeaea0438d97e6f334bdc0b727e0ac975d03ef8b688da4775c6c34cc9b56c0885cfa6fe38cd757d2dc
-  data.tar.gz: 9a3bd500cabd00c9118ff81cd79da588d629f5ee5788eae993d986161cd2ce3da715965534491f3d088b202154e53f124f7053dea671df606b028db96e24cdb4
+  metadata.gz: 1e676c5a658047114c59e29bab30fcb43f61a3fe2ddb8156234f034d475a1a2d50e78d232fa006bb723a84e453727857dc5963bee096c9db4f7b033119d6c96c
+  data.tar.gz: 58584bcfe586ac5ae4603b54ed1a1c2de520e95bb41a06cb0a553d510fb2c6c914fda5bcb820d8d23348259e9c623face707c5ec06ab75f35ee52a391928a9c8

data/lib/rulp/expression.rb

@@ -21,15 +21,14 @@ class Expressions
     @expressions.map(&:variable)
   end
 
-  [:==, :<, :<=, :>, :>=].each do |constraint_type|
-    define_method(constraint_type){|value|
+  %i[== < <= > >=].each do |constraint_type|
+    define_method(constraint_type) do |value|
       Constraint.new(self, constraint_type, value)
-    }
+    end
   end
 
   def -@
-    -self.expressions[0]
-    self
+    self.class.new(expressions.map(&:-@))
   end
 
   def -(other)
@@ -38,7 +37,7 @@ class Expressions
   end
 
   def +(other)
-    Expressions.new(self.expressions + Expressions[other].expressions)
+    Expressions.new(expressions + Expressions[other].expressions)
   end
 
   def self.[](value)
@@ -50,7 +49,7 @@ class Expressions
   end
 
   def evaluate
-    self.expressions.map(&:evaluate).inject(:+)
+    expressions.map(&:evaluate).inject(:+)
   end
 end
 
@@ -66,19 +65,19 @@ class Fragment
   end
 
   def +(other)
-    return Expressions.new([self] + Expressions[other].expressions)
+    Expressions.new([self] + Expressions[other].expressions)
   end
 
   def -(other)
     self.+(-other)
   end
 
-  def *(value)
-    Fragment.new(@lv, @operand * value)
+  def *(other)
+    Fragment.new(@lv, @operand * other)
   end
 
   def evaluate
-    if [TrueClass,FalseClass].include? @lv.value.class
+    if [TrueClass, FalseClass].include? @lv.value.class
       @operand * (@lv.value ? 1 : 0)
     else
       @operand * @lv.value
@@ -94,20 +93,18 @@ class Fragment
     @lv
   end
 
-  [:==, :<, :<=, :>, :>=].each do |constraint_type|
-    define_method(constraint_type){|value|
+  %i[== < <= > >=].each do |constraint_type|
+    define_method(constraint_type) do |value|
       Constraint.new(Expressions.new(self), constraint_type, value)
-    }
+    end
   end
 
   def to_s
-    @as_str ||= begin
-      case @operand
-      when -1 then " - #{@lv}"
-      when 1 then " + #{@lv}"
-      when ->(op){ op < 0} then " - #{@operand.abs} #{@lv}"
-      else " + #{@operand} #{@lv}"
-      end
-    end
+    @as_str ||= case @operand
+                when -1 then " - #{@lv}"
+                when 1 then " + #{@lv}"
+                when ->(op) { op < 0 } then " - #{@operand.abs} #{@lv}"
+                else " + #{@operand} #{@lv}"
+                end
   end
-end
+end

data/lib/rulp/lv.rb

@@ -40,7 +40,7 @@ class LV
     end
   end
 
-  def * (numeric)
+  def *(numeric)
     self.nocoerce
     Expressions.new([Fragment.new(self, numeric)])
   end
@@ -53,7 +53,7 @@ class LV
     self + (-other)
   end
 
-  def + (expressions)
+  def +(expressions)
     Expressions[self] + Expressions[expressions]
   end
 

data/lib/rulp/rulp.rb

@@ -18,6 +18,7 @@ GLPK  = "glpsol"
 SCIP  = "scip"
 CBC   = "cbc"
 GUROBI = "gurobi_cl"
+HIGHS = "highs"
 
 module Rulp
   attr_accessor :expressions
@@ -31,12 +32,14 @@ module Rulp
   GUROBI  = ::GUROBI
   SCIP  = ::SCIP
   CBC   = ::CBC
+  HIGHS = ::HIGHS
 
   SOLVERS = {
     GLPK     => Glpk,
     SCIP     => Scip,
     CBC      => Cbc,
     GUROBI   => Gurobi,
+    HIGHS    => Highs
   }
 
 
@@ -56,6 +59,10 @@ module Rulp
     lp.solve_with(GUROBI, opts)
   end
 
+  def self.Highs(lp, opts={})
+    lp.solve_with(HIGHS, opts)
+  end
+
   def self.Max(objective_expression)
     Rulp.log(Logger::INFO, "Creating maximization problem")
     Problem.new(Rulp::MAX, objective_expression)
@@ -185,6 +192,8 @@ module Rulp
       solver.store_results(@variables)
 
       if solver.unsuccessful
+        raise "Solve failed: #{solver.model_status}" if solver.model_status
+
         outfile_contents = IO.read(solver.outfile)
         raise "Solve failed: solution infeasible" if outfile_contents.downcase.include?("infeasible") || outfile_contents.strip.length.zero?
         raise "Solve failed: all units undefined"

data/lib/rulp/version.rb

@@ -1,3 +1,3 @@
 module Rulp
-  VERSION = '0.0.45'
-end
+  VERSION = '0.0.50'
+end

data/lib/solvers/glpk.rb

@@ -4,7 +4,7 @@ class Glpk < Solver
     command %= [
       options[:gap] ? "--mipgap #{options[:gap]}" : "",
       options[:time_limit] ? "--tmlim #{options[:time_limit]}" : ""
-    ]
+      ].join(" ")
     exec(command)
   end
 
@@ -30,4 +30,4 @@ class Glpk < Solver
     self.unsuccessful = rows[-3].downcase.include?('infeasible')
     return objective_str.to_f
   end
-end
+end

data/lib/solvers/highs.rb

@@ -0,0 +1,70 @@
+class Highs < Solver
+  HIGHS_SUPPORTED_OPTIONS = {
+    gap: :mip_rel_gap
+  }.freeze
+
+  def solve
+    options_file = create_highs_options_file
+
+    command = "#{executable} --model_file #{@filename} --solution_file #{@outfile} %s %s"
+    command %= [
+      options[:time_limit] ? "--time_limit #{options[:time_limit]}" : '',
+      options_file.length.positive? ? "--options_file #{options_file}" : ''
+    ]
+
+    exec(command)
+
+    # Remove options file as HiGHS requires additional params in file format instead of command line arguments
+    FileUtils.rm(options_file) unless options_file.empty?
+  end
+
+  def self.executable
+    :highs
+  end
+
+  def store_results(variables)
+    rows = IO.read(@outfile).split("\n")
+    self.model_status = rows[1]
+
+    if model_status.downcase.include?('infeasible') ||
+       model_status.downcase.include?('time limit reached')
+      self.unsuccessful = true
+      return
+    end
+
+    columns_idx = rows.index { |r| r.match?(/# Columns/) }
+    rows_idx = rows.index { |r| r.match?(/# Rows/) }
+
+    vars_by_name = {}
+
+    rows[(columns_idx + 1)...rows_idx].each do |row|
+      var_name, var_value = row.strip.split(/\s+/)
+      vars_by_name[var_name] = var_value
+    end
+
+    variables.each do |var|
+      var.value = vars_by_name[var.to_s].to_f
+    end
+
+    rows.find { |r| r.match?(/Objective/) }.to_s.split(/\s+/).last.to_f
+  end
+
+  private
+
+  def create_highs_options_file
+    options_str = ''
+
+    HIGHS_SUPPORTED_OPTIONS.each do |rulp_key, highs_key|
+      next unless options[rulp_key]
+
+      options_str += "#{highs_key} = #{options[rulp_key]}\n"
+    end
+
+    return '' if options_str.empty?
+
+    options_file = "/tmp/highs-#{Random.rand(0..1_000_000)}.opt"
+    IO.write(options_file, options_str)
+
+    options_file
+  end
+end

data/lib/solvers/solver.rb

@@ -1,6 +1,8 @@
+require 'fileutils'
+
 class Solver
   attr_reader :options, :outfile, :filename
-  attr_accessor :unsuccessful
+  attr_accessor :unsuccessful, :model_status
 
   def initialize(filename, options)
     @options = options
@@ -61,3 +63,4 @@ require_relative 'cbc'
 require_relative 'scip'
 require_relative 'glpk'
 require_relative 'gurobi'
+require_relative 'highs'

data/test/test_basic_suite.rb

@@ -55,4 +55,4 @@ class BasicSuite < Minitest::Test
       assert_in_delta X_f.value, 345.4321, 0.001
     end
   end
-end
+end

data/test/test_helper.rb

@@ -8,7 +8,7 @@ Rulp::log_level = Logger::UNKNOWN
 Rulp::print_solver_outputs = false
 
 def each_solver
-  [:scip, :cbc, :glpk, :gurobi].each do |solver|
+  [:scip, :cbc, :glpk, :gurobi, :highs].each do |solver|
     LV::clear
     if Rulp::solver_exists?(solver)
       yield(solver)

data/test/test_negate_expression.rb

@@ -0,0 +1,30 @@
+require_relative 'test_helper'
+
+class NegateExpressionTest < Minitest::Test
+
+  def test_negate_expression
+    @problem = Rulp::Max(- (X1_i + 2 * X2_i))
+    @problem[
+       X1_i + X2_i == 10,
+       X1_i >= 0,
+       X2_i >= 0
+    ]
+
+    @problem.solve
+    assert X1_i.value == 10
+    assert X2_i.value == 0
+  end
+
+  def test_double_negate_expression
+    @problem = Rulp::Max(-(-(X1_i + 2 * X2_i)))
+    @problem[
+       X1_i + X2_i == 10,
+       X1_i >= 0,
+       X2_i >= 0
+    ]
+
+    @problem.solve
+    assert X1_i.value == 0
+    assert X2_i.value == 10
+  end
+end

data/test/test_negate_term.rb

@@ -0,0 +1,19 @@
+require_relative 'test_helper'
+
+class NegateTerm < Minitest::Test
+  def setup
+    @problem = Rulp::Max(-X1_i + 2 * X2_i)
+    @problem[
+      X1_i + X2_i == 10,
+      X1_i >= 0,
+      X2_i >= 0
+    ]
+
+    @problem.solve
+  end
+
+  def test_negate_term
+    assert X1_i.value == 0
+    assert X2_i.value == 10
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulp
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 0.0.50
 platform: ruby
 authors:
 - Wouter Coppieters
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies: []
 description: A simple Ruby LP description DSL
 email: wc@pico.net.nz
@@ -36,12 +36,15 @@ files:
 - lib/solvers/cbc.rb
 - lib/solvers/glpk.rb
 - lib/solvers/gurobi.rb
+- lib/solvers/highs.rb
 - lib/solvers/scip.rb
 - lib/solvers/solver.rb
 - test/test_basic_suite.rb
 - test/test_boolean.rb
 - test/test_helper.rb
 - test/test_infeasible.rb
+- test/test_negate_expression.rb
+- test/test_negate_term.rb
 - test/test_save_to_file.rb
 - test/test_simple.rb
 homepage:
@@ -62,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Ruby Linear Programming
@@ -71,5 +74,7 @@ test_files:
 - test/test_boolean.rb
 - test/test_helper.rb
 - test/test_infeasible.rb
+- test/test_negate_expression.rb
+- test/test_negate_term.rb
 - test/test_save_to_file.rb
 - test/test_simple.rb