rulp 0.0.2 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjEyMDI0ZDM1NzVhNWE3NmJkYTk5Yzg3ODQyMjRiMmYxOWFkMDdkZQ==
+    Yzk4NWFlMmYwMGQ0ZDFjZTUxMmEwNzlkNDAwZmQ4MDU3YWY2Zjg5Mg==
   data.tar.gz: !binary |-
-    YzE0NmE1YzFhNDg1YTI4YjUzNTc3YmY2NzA4NTI3MDE1NGE2MzI2NA==
+    MDI3Y2E5MjdhNTY2M2FiZDBhZGMzZTg4MzU2ZDRiMzgyOGFmZTIzMA==
 SHA512:
   metadata.gz: !binary |-
-    M2ZhODczODZkYmU4ZGQ0N2RmZGM4MzZiN2ZmYjc3NjhkZjAyOTE0MjE0MWNj
-    ZTI1MWJkYzA5YWI0NmQyMjE1NmJjNTZhMGUxYjIyNDA4NzhjZDQzZTBkNzNi
-    ZjE3ZjQwZjEyNDI4YWNmYTkwMDk5NzZkYjliYTIxMTczMGJlODY=
+    YTg0OTJlNjhiMGJkNjdlM2U1ZTQ0ZGMyMTkwMTc0ZmI5NjliZjIzM2M3NjE1
+    N2VlNTBiNDBjZmIwOTA5MWI2OGEzZjhkYzYyMmFkOTkzNWM5YTg5OWUzNTc3
+    ZmUwY2U0ODM0ZmJhNTdiNjY2M2JjZDNhNzI0MTJmZDllMDY4Y2Q=
   data.tar.gz: !binary |-
-    ODhjYmYwOGY1N2E0MDc2OTlmYjBjZTRjN2VmMDk5NjVkOGIyMDM3NDA4ZTU2
-    YWE0MWU3ODIwY2VhZmI4NWU0OTcwMDg0ZmJiMzIzNTk2OGIwZDQ2ZTUwMDFh
-    ZTIwM2EwZDVmYWMyZjdkYzgwZDZiYWQyYmJmN2Y5ZjYzMjdmNWQ=
+    MzU4YjQxNzkzNTRlMmU0NzMyNTIyNGQ0NmE1ODM1YzU0NmYyYzFiZmM2YzI1
+    YmI2MTFkNWZmMzJjZWFmZjY0ZTAzODVmNTEwZTk5MDlkYjBhMmZhNzg1NzZm
+    NzFhNTllMTM1MTIwNmJmMDk3MGYyNTRmZGY5ZGMyM2U5YWI2ZjA=

data/lib/extensions/extensions.rb

@@ -1,3 +1,5 @@
 require_relative './array_extensions'
 require_relative './kernel_extensions'
-require_relative './object_extensions'
+require_relative './object_extensions'
+require_relative './file_extensions'
+require_relative './os_extensions'

data/lib/extensions/file_extensions.rb

@@ -0,0 +1,9 @@
+def choose_file
+  case os
+  when :macosx
+    command = "osascript -e 'set the_file to choose file name with prompt \"Select an output file\"' -e 'set the result to POSIX path of the_file'"
+    File.absolute_path(`#{command}`.strip)
+  else
+    File.absolute_path(gets)
+  end
+end

data/lib/extensions/os_extensions.rb

@@ -0,0 +1,25 @@
+def os
+  @os ||= (
+    require "rbconfig"
+    host_os = RbConfig::CONFIG['host_os'].downcase
+
+    case host_os
+    when /linux/
+      :linux
+    when /darwin|mac os/
+      :macosx
+    when /mswin|msys|mingw32/
+      :windows
+    when /cygwin/
+      :cygwin
+    when /solaris|sunos/
+      :solaris
+    when /bsd/
+      :bsd
+    when /aix/
+      :aix
+    else
+      raise Error, "unknown os: #{host_os.inspect}"
+    end
+  )
+end

data/lib/helpers/log.rb

@@ -26,7 +26,7 @@ module Rulp
     }
 
     def self.level=(value)
-      raise Exception.new("#{value} is not a valid log level") unless LEVELS[value]
+      raise StandardError.new("#{value} is not a valid log level") unless LEVELS[value]
       @@level = value
     end
 

data/lib/rulp.rb

@@ -1,2 +1,2 @@
 STDOUT.sync = true
-require_relative 'rulp/rulp'
+require_relative 'rulp/rulp'

data/lib/rulp/constraint.rb

@@ -12,6 +12,19 @@ class Constraint
   end
 
   def to_s
-    return "#{@expressions} #{@constraint_op == :== ? "=" : @constraint_op} #{@value}"
+    return "#{@expressions} #{constraint_op} #{@value}"
+  end
+
+  def constraint_op
+    case "#{@constraint_op}"
+    when "=="
+      "="
+    when "<"
+      "<="
+    when ">"
+      ">="
+    else
+      @constraint_op
+    end
   end
 end

data/lib/rulp/lv.rb

@@ -13,8 +13,8 @@ class LV
     ->(index){ send(self.meth(index)) }
   end
 
-  def meth(index)
-    "#{self.name}#{index}_#{self.suffix}"
+  def meth(*args)
+    "#{self.name}#{args.join("_")}_#{self.suffix}"
   end
 
   def suffix
@@ -31,7 +31,15 @@ class LV
 
   def self.definition(name)
     self.class.send(:define_method, name){
-      LV::names_table["#{name}#{self}"] if LV::names_table["#{name}#{self}"].class == self
+      defined = LV::names_table["#{name}"]
+      if defined && defined.class != self
+        raise StandardError.new("ERROR:\n#{name} was already defined as a variable of type #{defined.class}."+
+                                "You are trying to redefine it as a variable of type #{self}")
+      elsif(!defined)
+        self.new(name)
+      else
+        defined
+      end
     }
     return self.send(name) || self.new(name)
   end
@@ -54,12 +62,19 @@ class LV
   end
 
   def value
+    return nil unless @value
     if self.class == BV
       return @value.round(2) == 1
+    elsif self.class == IV
+      return @value
     else
       @value
     end
   end
+
+  def inspect
+    "#{name}(#{suffix})[#{value || 'undefined'}]"
+  end
 end
 
 class BV < LV;

data/lib/rulp/rulp.rb

@@ -24,21 +24,21 @@ module Rulp
   CBC   = ::CBC
 
   SOLVERS = {
-    "glpsol" => Glpk,
-    "scip"   => Scip,
-    "cbc"    => Cbc
+    GLPK => Glpk,
+    SCIP => Scip,
+    CBC  => Cbc
   }
 
   def self.Glpk(lp)
-    lp.solve_with(GLPK)
+    lp.solve_with(GLPK) rescue nil
   end
 
   def self.Cbc(lp)
-    lp.solve_with(CBC)
+    lp.solve_with(CBC) rescue nil
   end
 
   def self.Scip(lp)
-    lp.solve_with(SCIP)
+    lp.solve_with(SCIP) rescue nil
   end
 
   def self.Max(objective_expression)
@@ -51,6 +51,12 @@ module Rulp
     Problem.new(Rulp::MIN, objective_expression)
   end
 
+  def self.solver_exists?(solver_name)
+    solver = solver_name[0].upcase + solver_name[1..-1].downcase
+    solver_class = ObjectSpace.const_defined?(solver) && ObjectSpace.const_get(solver)
+    solver_class.exists? if(solver_class)
+  end
+
   class Problem
     def initialize(objective, objective_expression)
       @objective = objective
@@ -66,10 +72,32 @@ module Rulp
       self
     end
 
+    def solve
+      Rulp.send(self.solver, self)
+    end
+
+    def method_missing(method_name)
+      self.call(method_name)
+    end
+
+    def solver(solver=nil)
+      solver = solver || ENV["SOLVER"] || "Scip"
+      solver = solver[0].upcase + solver[1..-1].downcase
+    end
+
+    def call(using=nil)
+      Rulp.send(self.solver(using), self)
+    end
+
     def constraints
-      @constraints.map.with_index{|constraint, i|
+      constraints_str = @constraints.map.with_index{|constraint, i|
         " c#{i}: #{constraint}"
-      }.join("\n")
+      }.join("\n").strip
+      if constraints_str.empty?
+        "0 #{@variables.first} = 0"
+      else
+        "  #{constraints_str}"
+      end
     end
 
     def integers
@@ -84,8 +112,8 @@ module Rulp
 
     def bounds
       @variables.map{|var|
-        next unless var.bounds_str
-        " #{var.bounds_str}"
+        next unless var.bounds
+        " #{var.bounds}"
       }.compact.join("\n")
     end
 
@@ -93,7 +121,7 @@ module Rulp
       "/tmp/rulp-#{Random.rand(0..1000)}.lp"
     end
 
-    def output(filename)
+    def output(filename=choose_file)
       IO.write(filename, self)
     end
 
@@ -120,15 +148,22 @@ module Rulp
       return result
     end
 
+    def inspect
+      to_s
+    end
+
     def to_s
-      "\
-#{@objective}
- obj: #{@objective_expression}
-Subject to
-#{constraints}
-Bounds
-#{bounds}#{integers}#{bits}
-End"
+      %Q(
+#{'  '*0}#{@objective}
+#{'  '*0} obj: #{@objective_expression}
+#{'  '*0}Subject to
+#{'  '*0}#{constraints}
+#{'  '*0}Bounds
+#{'  '*0}#{bounds}#{integers}#{bits}
+#{'  '*0}End
+      )
     end
+
+    alias_method :save, :output
   end
 end

data/lib/rulp/rulp_bounds.rb

@@ -49,7 +49,7 @@ module Rulp
       return self, something
     end
 
-    def bounds_str
+    def bounds
       return nil if !(self.gt || self.lt || self.const)
       return "#{self.name} = #{self.const}" if self.const
 

data/lib/rulp/rulp_initializers.rb

@@ -1,8 +1,8 @@
 module Rulp
   module Initializers
     def initialize(name)
-      raise Exception.new("Variable with the name #{name} of a different type (#{LV::names_table[name].class}) already exists") if LV::names_table[name]
-      LV::names_table["#{name}#{self.class}"] = self
+      raise StandardError.new("Variable with the name #{name} of a different type (#{LV::names_table[name].class}) already exists") if LV::names_table["#{name}"]
+      LV::names_table["#{name}"] = self
       @name = name
     end
 
@@ -14,6 +14,10 @@ module Rulp
       def names_table
         @@names ||= {}
       end
+
+      def clear
+        @@names = {}
+      end
     end
 
     def to_s

data/lib/solvers/cbc.rb

@@ -1,10 +1,10 @@
 class Cbc < Solver
   def solve(open_solution=false)
-    `#{executable} #{@filename} branch solution #{@outfile}`
+    system("#{executable} #{@filename} branch solution #{@outfile}")
     `open #{@outfile}` if open_solution
   end
 
-  def executable
+  def self.executable
     :cbc
   end
 

data/lib/solvers/glpk.rb

@@ -1,10 +1,10 @@
 class Glpk < Solver
   def solve(open_solution=false)
-    `#{executable} --lp #{@filename} --write #{@outfile}`
+    system("#{executable} --lp #{@filename} --write #{@outfile}")
     `open #{@outfile}` if open_solution
   end
 
-  def executable
+  def self.executable
     :glpsol
   end
 

data/lib/solvers/scip.rb

@@ -1,13 +1,14 @@
 class Scip < Solver
-  def solve(open_solution=false)
-    `#{executable} -f #{@filename} > #{@outfile}`
-    `open #{@outfile}` if open_solution
-  end
 
-  def executable
+  def self.executable
     :scip
   end
 
+  def solve(open_solution=false)
+    system("rm #{@outfile}; #{executable} -f #{@filename} -l #{@outfile}")
+    `open #{@outfile}` if open_solution
+  end
+
   def store_results(variables)
     results  = IO.read(@outfile)
     start    = results.sub(/.*?primal solution:.*?=+/m, "")

data/lib/solvers/solvers.rb

@@ -2,7 +2,7 @@ class Solver
   def initialize(filename)
     @filename = filename
     @outfile = "/tmp/#{executable}-output.txt"
-    raise Exception.new("Couldn't find solver #{executable}!") if `which #{executable}`.length == 0
+    raise StandardError.new("Couldn't find solver #{executable}!") if `which #{executable}`.length == 0
     @solver_exists = true
   end
 
@@ -10,9 +10,17 @@ class Solver
     puts "Not yet implemented"
   end
 
+  def executable
+    self.class.executable
+  end
+
   def solver_exists?
     @solver_exists || false
   end
+
+  def self.exists?
+    return `which #{self.executable}`.length != 0
+  end
 end
 
 require_relative 'cbc'

data/test/test_basic_suite.rb

@@ -0,0 +1,58 @@
+require_relative 'test_helper'
+
+class BasicSuite < Minitest::Test
+
+  def test_single_binary_var
+    each_solver do |solver|
+      assert_equal X_b.value, nil
+
+      # The minimal value for a single binary variable is 0
+      Rulp::Min(X_b).(solver)
+      assert_equal X_b.value, false
+
+      # The maximal value for a single binary variable is 1
+      Rulp::Max(X_b).(solver)
+      assert_equal X_b.value, true
+
+      # If we set an upper bound this is respected by the solver
+      Rulp::Max(X_b)[1 * X_b <= 0].(solver)
+      assert_equal X_b.value, false
+
+      # If we set a lower bound this is respected by the solver
+      Rulp::Min(X_b)[1 * X_b >= 1].(solver)
+      assert_equal X_b.value, true
+    end
+  end
+
+  def test_single_integer_var
+    each_solver do |solver|
+      assert_equal X_i.value, nil
+
+      given[ -35 <= X_i <= 35 ]
+
+      # Integer variables respect integer bounds
+      Rulp::Min(X_i).(solver)
+      assert_equal X_i.value, -35
+
+      # Integer variables respect integer bounds
+      Rulp::Max(X_i).(solver)
+      assert_equal X_i.value, 35
+    end
+  end
+
+  def test_single_general_var
+    each_solver do |solver|
+      assert_equal X_f.value, nil
+
+      given[ -345.4321 <= X_f <= 345.4321 ]
+
+      # Integer variables respect integer bounds
+      Rulp::Min(X_f).(solver)
+      assert_equal X_f.value, -345.4321
+
+      # Integer variables respect integer bounds
+      Rulp::Max(X_f).(solver)
+      assert_equal X_f.value, 345.4321
+    end
+  end
+end

data/test/test_boolean.rb

@@ -9,36 +9,23 @@ class BooleanTest < Minitest::Test
   def setup
     @items       = 30.times.map(&Shop_Item_b)
     items_count = @items.sum
-    items_costs = @items.map{|item| item * Random.rand(1.0...5.0)}.sum
+    @items_costs = @items.map{|item| item * Random.rand(1.0...5.0)}.sum
 
     @problem =
-    Rulp::Min( items_costs ) [
+    Rulp::Min( @items_costs ) [
       items_count  >= 10,
-      items_costs  >= 15
+      @items_costs  >= 15
     ]
   end
 
-  def test_scip
-    solution = Rulp::Scip @problem
-    selected = @items.select(&:value)
-    assert_equal selected.length, 10
-    assert_operator solution.round(2), :>=, 15
-    assert_operator solution, :<=, 25
-  end
-
-  def test_cbc
-    solution = Rulp::Cbc @problem
-    selected = @items.select(&:value)
-    assert_equal selected.length, 10
-    assert_operator solution.round(2), :>=, 15
-    assert_operator solution, :<=, 25
-  end
-
-  def test_glpk
-    solution = Rulp::Glpk @problem
-    selected = @items.select(&:value)
-    assert_equal selected.length, 10
-    assert_operator solution.round(2), :>=, 15
-    assert_operator solution, :<=, 25
+  def test_simple
+    each_solver do |solver|
+      setup
+      @problem.send(solver)
+      selected = @items.select(&:value)
+      assert_equal selected.length, 10
+      assert_operator @items_costs.evaluate.round(2), :>=, 15
+      assert_operator @items_costs.evaluate, :<=, 25
+    end
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,18 @@
-gem "minitest"
-
 require_relative "../lib/rulp"
+
+gem "minitest"
 require "minitest/autorun"
 
 Rulp::Logger::level = :off
+
+
+def each_solver
+  [:scip, :cbc, :glpk, :gurobi].each do |solver|
+    LV::clear
+    if Rulp::solver_exists?(solver)
+      yield(solver)
+    else
+      puts "Couldn't find solver #{solver}"
+    end
+  end
+end

data/test/test_save_to_file.rb

@@ -0,0 +1,31 @@
+require_relative 'test_helper'
+# maximize
+#   z = 10 * x + 6 * y + 4 * z
+#
+# subject to
+#   p:      x +     y +     z <= 100
+#   q: 10 * x + 4 * y + 5 * z <= 600
+#   r:  2 * x + 2 * y + 6 * z <= 300
+#
+# where all variables are non-negative integers
+#   x >= 0, y >= 0, z >= 0
+#
+
+class SaveToFile < Minitest::Test
+  def setup
+    given[ X_i >= 0,  Y_i >= 0,  Z_i >= 0 ]
+    @objective = 10 * X_i + 6 * Y_i + 4 * Z_i
+    @problem   = Rulp::Max( @objective ) [
+                    X_i +     Y_i +     Z_i <= 100,
+               10 * X_i + 4 * Y_i + 5 * Z_i <= 600,
+               2 *  X_i + 2 * Y_i + 6 * Z_i <= 300
+    ]
+  end
+
+  def test_save
+    sample_output_filename = @problem.get_output_filename
+    @problem.save(sample_output_filename)
+    assert_equal(IO.read(sample_output_filename), "#{@problem}")
+    assert_operator "#{@problem}".length, :>=, 100
+  end
+end

data/test/test_simple.rb

@@ -14,37 +14,22 @@ require_relative 'test_helper'
 class SimpleTest < Minitest::Test
   def setup
     given[ X_i >= 0,  Y_i >= 0,  Z_i >= 0 ]
-    @problem =
-    Rulp::Max( 10 * X_i + 6 * Y_i + 4 * Z_i ) [
+    @objective = 10 * X_i + 6 * Y_i + 4 * Z_i
+    @problem   = Rulp::Max( @objective ) [
                     X_i +     Y_i +     Z_i <= 100,
                10 * X_i + 4 * Y_i + 5 * Z_i <= 600,
                2 *  X_i + 2 * Y_i + 6 * Z_i <= 300
     ]
   end
 
-  def test_scip
-    solution =   Rulp::Scip @problem
-    assert_equal X_i.value, 33
-    assert_equal Y_i.value, 67
-    assert_equal Z_i.value, 0
-    assert_equal solution , 732
-
-  end
-
-  def test_cbc
-    solution =   Rulp::Cbc @problem
-    assert_equal X_i.value, 33
-    assert_equal Y_i.value, 67
-    assert_equal Z_i.value, 0
-    assert_equal solution , 732
-
-  end
-
-  def test_glpk
-    solution =   Rulp::Glpk @problem
-    assert_equal X_i.value, 33
-    assert_equal Y_i.value, 67
-    assert_equal Z_i.value, 0
-    assert_equal solution , 732
+  def test_simple
+    each_solver do |solver|
+      setup
+      @problem.send(solver)
+      assert_equal X_i.value, 33
+      assert_equal Y_i.value, 67
+      assert_equal Z_i.value, 0
+      assert_equal @objective.evaluate , 732
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rulp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Wouter Coppieters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies: []
 description: A simple Ruby LP description DSL
 email: wc@pico.net.nz
@@ -20,8 +20,10 @@ files:
 - bin/rulp
 - lib/extensions/array_extensions.rb
 - lib/extensions/extensions.rb
+- lib/extensions/file_extensions.rb
 - lib/extensions/kernel_extensions.rb
 - lib/extensions/object_extensions.rb
+- lib/extensions/os_extensions.rb
 - lib/helpers/log.rb
 - lib/rulp.rb
 - lib/rulp/constraint.rb
@@ -34,8 +36,10 @@ files:
 - lib/solvers/glpk.rb
 - lib/solvers/scip.rb
 - lib/solvers/solvers.rb
+- test/test_basic_suite.rb
 - test/test_boolean.rb
 - test/test_helper.rb
+- test/test_save_to_file.rb
 - test/test_simple.rb
 homepage: 
 licenses: []
@@ -61,7 +65,9 @@ signing_key:
 specification_version: 4
 summary: Ruby Linear Programming
 test_files:
+- test/test_basic_suite.rb
 - test/test_boolean.rb
 - test/test_helper.rb
+- test/test_save_to_file.rb
 - test/test_simple.rb
 has_rdoc: