rglpk 0.1.1 → 0.2.0

data/lib/rglpk.rb

@@ -0,0 +1,378 @@
+require 'glpk_wrapper'
+
+module Rglpk
+  Glpk_wrapper.constants.each do |c|
+    v = Glpk_wrapper.const_get(c)
+    self.const_set(c, v) if v.kind_of? Numeric
+  end
+  TypeConstants = [GLP_FR, GLP_LO, GLP_UP, GLP_DB, GLP_FX]
+
+  class RowColArray
+    include Enumerable
+    
+    def initialize
+      @array = []
+    end
+    
+    def size
+      @array.size
+    end
+    
+    def each(&block)
+      @array.each(&block)
+      self
+    end
+    
+    def [](i)
+      if i.kind_of?(Numeric)
+        @array[i]
+      elsif i.kind_of?(String)
+        raise RuntimeError if self[1].nil?
+        idx = Glpk_wrapper.send(glp_find_method, self[1].p.lp, i)
+        raise ArgumentError if idx == 0
+        @array[idx - 1]
+      else
+        raise ArgumentError
+      end
+    end
+    
+  protected
+    
+    def push(rc)
+      @array << rc
+    end
+    
+    def delete_at(index)
+      @array.delete_at(index)
+    end
+  end
+  
+  class RowArray < RowColArray    
+  protected
+    def glp_find_method
+      :glp_find_row
+    end
+  end
+  
+  class ColArray < RowColArray
+  protected
+    def glp_find_method
+      :glp_find_col
+    end
+  end
+
+  class Problem
+    attr_accessor :rows, :cols, :obj, :lp
+
+    def initialize
+      @lp = Glpk_wrapper.glp_create_prob
+      @obj = ObjectiveFunction.new(self)
+      @rows = RowArray.new
+      @cols = ColArray.new
+      Glpk_wrapper.glp_create_index(@lp)
+      @status = nil
+    end
+    
+    def name=(n)
+      Glpk_wrapper.glp_set_prob_name(@lp, n)
+    end
+    
+    def name
+      Glpk_wrapper.glp_get_prob_name(@lp)
+    end
+    
+    def nz
+      Glpk_wrapper.glp_get_num_nz(@lp)
+    end
+
+    def add_rows(n)
+      Glpk_wrapper.glp_add_rows(@lp, n)
+      s = @rows.size
+      n.times{|i| @rows.send(:push, Row.new(self, s + i + 1))}
+      @rows
+    end
+    
+    def add_cols(n)
+      Glpk_wrapper.glp_add_cols(@lp, n)
+      s = @cols.size
+      n.times{|i| @cols.send(:push, Column.new(self, s + i + 1))}
+      @cols
+    end
+        
+    def del_rows(a)
+      # Ensure the array of rows to delete is sorted and unique.
+      a = a.sort.uniq
+
+      r = Glpk_wrapper.new_intArray(a.size + 1)
+      a.each_with_index{|n, i| Glpk_wrapper.intArray_setitem(r, i + 1, n)}
+      Glpk_wrapper.glp_del_rows(@lp, a.size, r)
+
+      a.each do |n|
+        @rows.send(:delete_at, n)
+        a.each_with_index do |nn, i|
+          a[i] -= 1
+        end
+      end
+      @rows.each_with_index{|r, i| r.i = i + 1}
+      a
+    end
+
+    def del_cols(a)
+      # Ensure the array of rows tro delete is sorted and unique.
+      a = a.sort.uniq
+
+      r = Glpk_wrapper.new_intArray(a.size + 1)
+      a.each_with_index{|n, i| Glpk_wrapper.intArray_setitem(r, i + 1, n)}
+      Glpk_wrapper.glp_del_cols(@lp, a.size, r)
+
+      a.each do |n|
+        @cols.send(:delete_at, n)
+        a.each_with_index do |nn, i|
+          a[i] -= 1
+        end
+      end
+      @cols.each_with_index{|c, i| c.j = i + 1}
+      a
+    end
+
+    def set_matrix(v)
+      nc = Glpk_wrapper.glp_get_num_cols(@lp)
+      
+      ia = Glpk_wrapper.new_intArray(v.size + 1)
+      ja = Glpk_wrapper.new_intArray(v.size + 1)
+      ar = Glpk_wrapper.new_doubleArray(v.size + 1)
+      
+      v.each_with_index do |x, y|
+        rn = (y + nc) / nc
+        cn = (y % nc) + 1
+
+        Glpk_wrapper.intArray_setitem(ia, y + 1, rn)
+        Glpk_wrapper.intArray_setitem(ja, y + 1, cn)
+        Glpk_wrapper.doubleArray_setitem(ar, y + 1, x)
+      end
+      
+      Glpk_wrapper.glp_load_matrix(@lp, v.size, ia, ja, ar)
+    end
+    
+  private
+  
+    def apply_options_to_parm(options, parm)
+      options.each do |k, v|
+        begin
+          parm.send("#{k}=".to_sym, v)
+        rescue NoMethodError
+          raise ArgumentError, "Unrecognised option: #{k}"
+        end
+      end
+    end
+  
+  public
+
+    def simplex(options = {})
+      parm = Glpk_wrapper::Glp_smcp.new
+      Glpk_wrapper.glp_init_smcp(parm)
+
+      # Default to errors only temrinal output.
+      parm.msg_lev = GLP_MSG_ERR
+      
+      apply_options_to_parm(options, parm)
+      Glpk_wrapper.glp_simplex(@lp, parm)
+    end
+    
+    def mip(options = {})
+      parm = Glpk_wrapper::Glp_iocp.new
+      Glpk_wrapper.glp_init_iocp(parm)
+      
+      # Default to errors only temrinal output.
+      parm.msg_lev = GLP_MSG_ERR
+      
+      apply_options_to_parm(options, parm)
+      Glpk_wrapper.glp_intopt(@lp, parm)
+    end
+
+    def status
+      Glpk_wrapper.glp_get_status(@lp)
+    end
+  end
+        
+  class Row
+    attr_accessor :i, :p
+    
+    def initialize(problem, i)
+      @p = problem
+      @i = i
+    end
+    
+    def name=(n)
+      Glpk_wrapper.glp_set_row_name(@p.lp, @i, n)
+    end
+    
+    def name
+      Glpk_wrapper.glp_get_row_name(@p.lp, @i)
+    end
+    
+    def set_bounds(type, lb, ub)
+      raise ArgumentError unless TypeConstants.include?(type)
+      lb = 0.0 if lb.nil?
+      ub = 0.0 if ub.nil?
+      Glpk_wrapper.glp_set_row_bnds(@p.lp, @i, type, lb.to_f, ub.to_f)
+    end
+    
+    def bounds
+      t = Glpk_wrapper.glp_get_row_type(@p.lp, @i)
+      lb = Glpk_wrapper.glp_get_row_lb(@p.lp, @i)
+      ub = Glpk_wrapper.glp_get_row_ub(@p.lp, @i)
+      
+      lb = (t == GLP_FR or t == GLP_UP) ? nil : lb
+      ub = (t == GLP_FR or t == GLP_LO) ? nil : ub
+      
+      [t, lb, ub]
+    end
+    
+    def set(v)
+      raise RuntimeError unless v.size == @p.cols.size
+      ind = Glpk_wrapper.new_intArray(v.size + 1)
+      val = Glpk_wrapper.new_doubleArray(v.size + 1)
+      
+      1.upto(v.size){|x| Glpk_wrapper.intArray_setitem(ind, x, x)}
+      v.each_with_index{|x, y|
+        Glpk_wrapper.doubleArray_setitem(val, y + 1, x)}
+      
+      Glpk_wrapper.glp_set_mat_row(@p.lp, @i, v.size, ind, val)
+    end
+    
+    def get
+      ind = Glpk_wrapper.new_intArray(@p.cols.size + 1)
+      val = Glpk_wrapper.new_doubleArray(@p.cols.size + 1)
+      len = Glpk_wrapper.glp_get_mat_row(@p.lp, @i, ind, val)
+      row = Array.new(@p.cols.size, 0)
+      len.times do |i|
+        v = Glpk_wrapper.doubleArray_getitem(val, i + 1)
+        j = Glpk_wrapper.intArray_getitem(ind, i + 1)
+        row[j - 1] = v
+      end
+      row
+    end
+  end
+  
+  class Column
+    attr_accessor :j, :p
+    
+    def initialize(problem, i)
+      @p = problem
+      @j = i
+    end
+    
+    def name=(n)
+      Glpk_wrapper.glp_set_col_name(@p.lp, @j, n)
+    end
+    
+    def name
+      Glpk_wrapper.glp_get_col_name(@p.lp, @j)
+    end
+    
+    def kind=(kind)
+      Glpk_wrapper.glp_set_col_kind(@p.lp, j, kind)
+    end
+    
+    def kind
+      Glpk_wrapper.glp_get_col_kind(@p.lp, @j)
+    end
+    
+    def set_bounds(type, lb, ub)
+      raise ArgumentError unless TypeConstants.include?(type)
+      lb = 0.0 if lb.nil?
+      ub = 0.0 if ub.nil?
+      Glpk_wrapper.glp_set_col_bnds(@p.lp, @j, type, lb, ub)
+    end
+    
+    def bounds
+      t = Glpk_wrapper.glp_get_col_type(@p.lp, @j)
+      lb = Glpk_wrapper.glp_get_col_lb(@p.lp, @j)
+      ub = Glpk_wrapper.glp_get_col_ub(@p.lp, @j)
+      
+      lb = (t == GLP_FR or t == GLP_UP) ? nil : lb
+      ub = (t == GLP_FR or t == GLP_LO) ? nil : ub
+      
+      [t, lb, ub]
+    end
+    
+    def set(v)
+      raise RuntimeError unless v.size == @p.rows.size
+      ind = Glpk_wrapper.new_intArray(v.size + 1)
+      val = Glpk_wrapper.new_doubleArray(v.size + 1)
+      
+      1.upto(v.size){|x| Glpk_wrapper.intArray_setitem(ind, x, x)}
+      v.each_with_index{|x, y|
+        Glpk_wrapper.doubleArray_setitem(val, y + 1, x)}
+      
+      Glpk_wrapper.glp_set_mat_col(@p.lp, @j, v.size, ind, val)
+    end
+    
+    def get
+      ind = Glpk_wrapper.new_intArray(@p.rows.size + 1)
+      val = Glpk_wrapper.new_doubleArray(@p.rows.size + 1)
+      len = Glpk_wrapper.glp_get_mat_col(@p.lp, @j, ind, val)
+      col = Array.new(@p.rows.size, 0)
+      len.times do |i|
+        v = Glpk_wrapper.doubleArray_getitem(val, i + 1)
+        j = Glpk_wrapper.intArray_getitem(ind, i + 1)
+        col[j - 1] = v
+      end
+      col
+    end
+    
+    def get_prim
+      Glpk_wrapper.glp_get_col_prim(@p.lp, @j)
+    end
+    
+    def mip_val
+      Glpk_wrapper.glp_mip_col_val(@p.lp, @j)
+    end
+  end
+
+  class ObjectiveFunction
+    
+    def initialize(problem)
+      @p = problem
+    end
+    
+    def name=(n)
+      Glpk_wrapper.glp_set_obj_name(@p.lp, n)
+    end
+    
+    def name
+      Glpk_wrapper.glp_get_obj_name(@p.lp)
+    end
+    
+    def dir=(d)
+      raise ArgumentError if d != GLP_MIN and d != GLP_MAX
+      Glpk_wrapper.glp_set_obj_dir(@p.lp, d)
+    end
+    
+    def dir
+      Glpk_wrapper.glp_get_obj_dir(@p.lp)
+    end
+    
+    def set_coef(j, coef)
+      Glpk_wrapper.glp_set_obj_coef(@p.lp, j, coef)
+    end
+    
+    def coefs=(a)
+      @p.cols.each{|c| Glpk_wrapper.glp_set_obj_coef(@p.lp, c.j, a[c.j - 1])}
+      a
+    end
+    
+    def coefs
+      @p.cols.map{|c| Glpk_wrapper.glp_get_obj_coef(@p.lp, c.j)}
+    end
+    
+    def get
+      Glpk_wrapper.glp_get_obj_val(@p.lp)
+    end
+    
+    def mip
+      Glpk_wrapper.glp_mip_obj_val(@p.lp)
+    end
+  end
+end

data/rglpk.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rglpk}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Gutteridge", "William Taysom"]
+  s.date = %q{2010-10-13}
+  s.description = %q{Rglpk is a package providing a Ruby wrapper to the [GNU GLPK](http://www.gnu.org/software/glpk/) library. The GLPK (GNU Linear Programming Kit) package is intended for solving large-scale linear programming (LP), mixed integer programming (MIP), and other related problems.
+
+Rglpk (pronounced as "wriggle-pick") is currently in alpha status and the API should be considered subject to change.  Rglpk uses [Swig](http://www.swig.org/) to initially wrap the C GLPK library (using a Swig wrapper originally developed by Nigel Galloway) and then a pure Ruby library to wrap the Swig code in a more friendly OO-style.
+
+All bug reports, feature requests and patches are welcome. Please email alexg (at) kuicr.kyoto-u.ac.jp or use the [rubyforge forums](http://rubyforge.org/forum/?group_id=3943).}
+  s.email = ["alexg@kuicr.kyoto-u.ac.jp", "wtaysom@gmail.com"]
+  s.extensions = ["ext/extconf.rb", "ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "ChangeLog.md",
+     "License.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "ext/extconf.rb",
+     "ext/glpk_wrapper.c",
+     "lib/rglpk.rb",
+     "rglpk.gemspec",
+     "swig/Makefile.in",
+     "swig/configure.in",
+     "swig/glpk.i",
+     "test/helper.rb",
+     "test/test_all.rb",
+     "test/test_basic.rb",
+     "test/test_brief_example.rb",
+     "test/test_problem_kind.rb"
+  ]
+  s.homepage = %q{http://rglpk.rubyforge.org/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib", "ext", "ext"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rglpk is a package providing a Ruby wrapper to the [GNU GLPK](http://www.gnu.org/software/glpk/) library. The GLPK (GNU Linear Programming Kit) package is intended for solving large-scale linear programming (LP), mixed integer programming (MIP), and other related problems.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_all.rb",
+     "test/test_basic.rb",
+     "test/test_brief_example.rb",
+     "test/test_problem_kind.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/swig/Makefile.in

@@ -1,4 +1,4 @@
-rglpk.c: glpk.i
+glpk_wrapper.c: glpk.i
 	@SWIG@ -I/usr/local/include -ruby -w801 -o $@ $?
-wrap: rglpk.c
+wrap: glpk_wrapper.c
 	cp $? ../ext/$?