rglpk 0.1.1 → 0.2.0

data/test/test_problem_kind.rb

@@ -0,0 +1,81 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+module TestProblemKind
+  def setup
+    @p = Rglpk::Problem.new
+    @p.obj.dir = Rglpk::GLP_MAX
+    
+    cols = @p.add_cols(3)
+    cols[0].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    cols[1].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    cols[2].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    
+    rows = @p.add_rows(3)
+    
+    rows[0].set_bounds(Rglpk::GLP_UP, 0, 4)
+    rows[1].set_bounds(Rglpk::GLP_UP, 0, 5)
+    rows[2].set_bounds(Rglpk::GLP_UP, 0, 6)
+    
+    @p.obj.coefs = [1, 1, 1]
+    
+    @p.set_matrix([
+      1, 1, 0,
+      0, 1, 1,
+      1, 0, 1
+    ])
+    
+    @p.cols.each{|c| c.kind = column_kind}
+  end
+  
+  def verify_results(*results)
+    if column_kind == Rglpk::GLP_CV
+      solution_method = :simplex
+      value_method = :get_prim
+    else
+      solution_method = :mip
+      value_method = :mip_val
+    end
+    
+    @p.send(solution_method, {:presolve => Rglpk::GLP_ON})
+    
+    @p.cols.each_with_index do |col, index|
+      assert_equal results[index], col.send(value_method)
+    end
+  end
+end
+
+class BinaryVariables < Test::Unit::TestCase
+  include TestProblemKind
+  
+  def column_kind
+    Rglpk::GLP_BV
+  end
+  
+  def test_results
+    verify_results(1, 1, 1)
+  end
+end
+
+class IntegerVariables < Test::Unit::TestCase
+  include TestProblemKind
+  
+  def column_kind
+    Rglpk::GLP_IV
+  end
+  
+  def test_results
+    verify_results(3, 1, 3)
+  end
+end
+
+class ContinuousVariables < Test::Unit::TestCase
+  include TestProblemKind
+  
+  def column_kind
+    Rglpk::GLP_CV
+  end
+  
+  def test_results
+    verify_results(2.5, 1.5, 3.5)
+  end
+end

metadata

@@ -1,70 +1,100 @@
 --- !ruby/object:Gem::Specification 
 name: rglpk
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Alex Gutteridge
+- William Taysom
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-11-19 00:00:00 +00:00
+date: 2010-10-13 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
-description: Rglpk is a package providing a Ruby wrapper to the GNU glpk library (http://www.gnu.org/software/glpk/). The GLPK (GNU Linear Programming Kit) package is intended for solving large-scale linear programming (LP), mixed integer programming (MIP), and other related problems.
-email: alexg@kuicr.kyoto-u.ac.jp
+description: |-
+  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).
+email: 
+- alexg@kuicr.kyoto-u.ac.jp
+- wtaysom@gmail.com
 executables: []
 
 extensions: 
 - ext/extconf.rb
+- ext/extconf.rb
 extra_rdoc_files: 
-- README.txt
-- History.txt
-- License.txt
+- ChangeLog.md
+- README.md
 files: 
-- History.txt
+- .gitignore
+- ChangeLog.md
 - License.txt
-- Manifest.txt
-- README.txt
-- Rakefile.rb
+- README.md
+- Rakefile
+- VERSION
 - ext/extconf.rb
-- ext/rglpk.c
-- lib/glpk.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
 has_rdoc: true
 homepage: http://rglpk.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
-- --exclude
-- test/*
-- --main
-- README.txt
-- --inline-source
+- --charset=UTF-8
 require_paths: 
-- test
+- lib
+- ext
+- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: rglpk
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
-summary: Rglpk is a package providing a Ruby wrapper to the GNU glpk library (http://www.gnu.org/software/glpk/). The GLPK (GNU Linear Programming Kit) package is intended for solving large-scale linear programming (LP), mixed integer programming (MIP), and other related problems.
+specification_version: 3
+summary: 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.
 test_files: 
+- test/helper.rb
 - test/test_all.rb
+- test/test_basic.rb
+- test/test_brief_example.rb
+- test/test_problem_kind.rb

data/History.txt

@@ -1,7 +0,0 @@
-= 0.1.1 2008-11-19
-
-* Updated bindings to GLPK 4.33 - Thanks to Adeh DeSandies
-
-= 0.1 2007-10-24
-
-* First private release

data/Manifest.txt

@@ -1,12 +0,0 @@
-History.txt
-License.txt
-Manifest.txt
-README.txt
-Rakefile.rb
-ext/extconf.rb
-ext/rglpk.c
-lib/glpk.rb
-swig/Makefile.in
-swig/configure.in
-swig/glpk.i
-test/test_all.rb

data/README.txt

@@ -1,45 +0,0 @@
-== Introduction
-
-Rglpk is a package providing a Ruby wrapper to the GNU glpk library (http://www.gnu.org/software/glpk/). 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 is currently in alpha status and the API should be considered subject to change. The main documentation can be found at http://rglpk.rubyforge.org/. Rglpk uses Swig 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
-
-== Installation
-
-A working glpk library installation is required.
-
-Rglpk is only available as a gem. For example, under Ubuntu linux the following command succesfully compiles and installs (you may need to be root):
-
-  gem install rglpk
-
-The underlying C library is wrapped using Swig. See /swig for details on the interface.
-
-== Documentation
-
-Rglpk provides two files: rglpk.so which is a Swig generated wrapper and glpk.rb which wraps rglpk.so to provide a nicer OO-orientated interface. You should only ever need to access glpk.rb.
-
-An example:
-
-  require 'glpk'
-
-  #Yadda yadda
-
-== License
-
-Copyright (C) 2007 Alex Gutteridge
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

data/Rakefile.rb

@@ -1,50 +0,0 @@
-require 'hoe'
-
-$LOAD_PATH.unshift("./ext")
-
-module GLPK
-  VERSION = "0.1.1"
-end
-
-begin 
-  require 'glpk'
-rescue LoadError
-end
-
-hoe = Hoe.new("rglpk",GLPK::VERSION) do |p|
-  
-  p.author = "Alex Gutteridge"
-  p.email = "alexg@kuicr.kyoto-u.ac.jp"
-  p.url = "http://rglpk.rubyforge.org/"
-  
-  p.description = p.paragraphs_of("README.txt",1..3)[0]
-  p.summary     = p.paragraphs_of("README.txt",1)[0]
-  p.changes     = p.paragraphs_of("History.txt",0..1).join("\n\n")
-  
-  p.clean_globs = ["ext/*.o","ext/*.so","ext/Makefile","ext/mkmf.log","**/*~","email.txt"]
-  
-  p.rdoc_pattern = /(^ext\/.*\.c$|^README|^History|^License)/
-  
-  p.spec_extras = {
-    :extensions    => ['ext/extconf.rb'],
-    :require_paths => ['test'],
-    :has_rdoc      => true,
-    :extra_rdoc_files => ["README.txt","History.txt","License.txt"],
-    :rdoc_options  => ["--exclude", "test/*", "--main", "README.txt", "--inline-source"]
-  }
-
-end
-  
-hoe.spec.dependencies.delete_if{|dep| dep.name == "hoe"}
-
-desc "Uses extconf.rb and make to build the extension"
-task :build_extension => ['ext/rglpk.so']
-SRC = FileList['ext/rglpk.c']
-file 'ext/rglpk.so' => SRC do
-  Dir.chdir('ext')
-  system("ruby extconf.rb")
-  system("make")
-  Dir.chdir('..')
-end
-
-task :test => [:build_extension]

data/lib/glpk.rb

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