rulp 0.0.46 → 0.0.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e259317b851f96717dc4e0e66b07f08cf035efc420eeef915db1f40d7b5389
-  data.tar.gz: 68cfcdf7d345b9e1ee0c66b70b822a3edcac50af649a906902ef08db4f673f87
+  metadata.gz: 85bd89961eddfceba98245a2ac9882467ae8363209242a3b87bf092afc746d28
+  data.tar.gz: 7fdaf681f33655e4fbd461363ca4d94c581362080958b50fef21050f6562d29c
 SHA512:
-  metadata.gz: 0fe7414a15de24cd86043956491056cda383ce81ab21a7010add8715fbb2d2a376ff284faade9f7e66a512b1ae3c62926dcceb9dcf9a2dfe3e497eb11f558b8e
-  data.tar.gz: 3596934464b9aa30a43467fdc08e69a935f8d53219d2edf1b8110ca1806e71d5507802bd79d770df4d17be1d35f905e5b1b2a6554f3cbb4b5e78548864ebe9ee
+  metadata.gz: 1e676c5a658047114c59e29bab30fcb43f61a3fe2ddb8156234f034d475a1a2d50e78d232fa006bb723a84e453727857dc5963bee096c9db4f7b033119d6c96c
+  data.tar.gz: 58584bcfe586ac5ae4603b54ed1a1c2de520e95bb41a06cb0a553d510fb2c6c914fda5bcb820d8d23348259e9c623face707c5ec06ab75f35ee52a391928a9c8

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.46'
+  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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulp
 version: !ruby/object:Gem::Version
-  version: 0.0.46
+  version: 0.0.50
 platform: ruby
 authors:
 - Wouter Coppieters
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 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,6 +36,7 @@ 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
@@ -64,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