rglpk 0.2.5 → 0.2.6

data/ChangeLog.md

@@ -1,3 +1,7 @@
+# rglpk 0.2.6 2012-01-23
+
+* Fix memory leaks by adding finalizer to free GLPK problems.
+
 # rglpk 0.2.5 2011-06-23
 
 * Add Row#get_stat, Row#get_prim Row#get_dual.

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/lib/rglpk.rb

@@ -68,6 +68,15 @@ module Rglpk
       @rows = RowArray.new
       @cols = ColArray.new
       Glpk_wrapper.glp_create_index(@lp)
+      
+      ObjectSpace.define_finalizer(self, self.class.finalizer(@lp))
+    end
+    
+    def self.finalizer(lp)
+      proc do
+        Glpk_wrapper.glp_delete_index(lp)
+        Glpk_wrapper.glp_delete_prob(lp)
+      end
     end
     
     def name=(n)
@@ -117,6 +126,7 @@ module Rglpk
       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)
+      Glpk_wrapper.delete_intArray(r)
 
       a.each do |n|
         @rows.send(:delete_at, n)
@@ -135,6 +145,7 @@ module Rglpk
       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)
+      Glpk_wrapper.delete_intArray(r)
 
       a.each do |n|
         @cols.send(:delete_at, n)
@@ -163,6 +174,10 @@ module Rglpk
       end
       
       Glpk_wrapper.glp_load_matrix(@lp, v.size, ia, ja, ar)
+      
+      Glpk_wrapper.delete_intArray(ia)
+      Glpk_wrapper.delete_intArray(ja)
+      Glpk_wrapper.delete_doubleArray(ar)
     end
     
   private
@@ -261,6 +276,9 @@ module Rglpk
         Glpk_wrapper.doubleArray_setitem(val, y + 1, x)}
       
       Glpk_wrapper.glp_set_mat_row(@p.lp, @i, v.size, ind, val)
+      
+      Glpk_wrapper.delete_intArray(ind)
+      Glpk_wrapper.delete_doubleArray(val)
     end
     
     def get
@@ -273,6 +291,8 @@ module Rglpk
         j = Glpk_wrapper.intArray_getitem(ind, i + 1)
         row[j - 1] = v
       end
+      Glpk_wrapper.delete_intArray(ind)
+      Glpk_wrapper.delete_doubleArray(val)
       row
     end
     
@@ -341,6 +361,9 @@ module Rglpk
         Glpk_wrapper.doubleArray_setitem(val, y + 1, x)}
       
       Glpk_wrapper.glp_set_mat_col(@p.lp, @j, v.size, ind, val)
+      
+      Glpk_wrapper.delete_intArray(ind)
+      Glpk_wrapper.delete_doubleArray(val)
     end
     
     def get
@@ -353,6 +376,8 @@ module Rglpk
         j = Glpk_wrapper.intArray_getitem(ind, i + 1)
         col[j - 1] = v
       end
+      Glpk_wrapper.delete_intArray(ind)
+      Glpk_wrapper.delete_doubleArray(val)
       col
     end
     

data/rglpk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rglpk}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alex Gutteridge", "William Taysom"]
-  s.date = %q{2011-06-23}
+  s.date = %q{2012-01-03}
   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.
@@ -38,6 +38,7 @@ See [github](http://github.com/wtaysom/rglpk) for installation instructions.  Al
     "test/test_all.rb",
     "test/test_basic.rb",
     "test/test_brief_example.rb",
+    "test/test_memory_leaks.rb",
     "test/test_problem_kind.rb"
   ]
   s.homepage = %q{http://rglpk.rubyforge.org/}

data/test/helper.rb

@@ -2,4 +2,53 @@ here = File.expand_path(File.dirname(__FILE__))
 
 require 'test/unit'
 $LOAD_PATH << './ext'
-require here+'/../lib/rglpk'
+require here+'/../lib/rglpk'
+
+module Examples
+  def brief_example
+    # The same Brief Example as found in section 1.3 of 
+    # glpk-4.44/doc/glpk.pdf.
+    #
+    # maximize
+    #   z = 10 * x1 + 6 * x2 + 4 * x3
+    #
+    # subject to
+    #   p:      x1 +     x2 +     x3 <= 100
+    #   q: 10 * x1 + 4 * x2 + 5 * x3 <= 600
+    #   r:  2 * x1 + 2 * x2 + 6 * x3 <= 300
+    #
+    # where all variables are non-negative
+    #   x1 >= 0, x2 >= 0, x3 >= 0
+    #    
+    p = Rglpk::Problem.new
+    p.name = "sample"
+    p.obj.dir = Rglpk::GLP_MAX
+    
+    rows = p.add_rows(3)
+    rows[0].name = "p"
+    rows[0].set_bounds(Rglpk::GLP_UP, 0, 100)
+    rows[1].name = "q"
+    rows[1].set_bounds(Rglpk::GLP_UP, 0, 600)
+    rows[2].name = "r"
+    rows[2].set_bounds(Rglpk::GLP_UP, 0, 300)
+    
+    cols = p.add_cols(3)
+    cols[0].name = "x1"
+    cols[0].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    cols[1].name = "x2"
+    cols[1].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    cols[2].name = "x3"
+    cols[2].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
+    
+    p.obj.coefs = [10, 6, 4]
+    
+    p.set_matrix([
+       1, 1, 1,
+      10, 4, 5,
+       2, 2, 6
+    ])
+    
+    p.simplex
+    p
+  end
+end

data/test/test_all.rb

@@ -3,4 +3,5 @@ here = File.expand_path(File.dirname(__FILE__))
 require here+'/helper'
 require here+'/test_basic'
 require here+'/test_problem_kind'
-require here+'/test_brief_example'
+require here+'/test_brief_example'
+require here+'/test_memory_leaks'

data/test/test_brief_example.rb

@@ -1,50 +1,13 @@
 require File.expand_path('helper', File.dirname(__FILE__))
 
-class TestExample < Test::Unit::TestCase
-  def test_example
-    # The same Brief Example as found in section 1.3 of 
-    # glpk-4.44/doc/glpk.pdf.
-    #
-    # maximize
-    #   z = 10 * x1 + 6 * x2 + 4 * x3
-    #
-    # subject to
-    #   p:      x1 +     x2 +     x3 <= 100
-    #   q: 10 * x1 + 4 * x2 + 5 * x3 <= 600
-    #   r:  2 * x1 + 2 * x2 + 6 * x3 <= 300
-    #
-    # where all variables are non-negative
-    #   x1 >= 0, x2 >= 0, x3 >= 0
-    #    
-    p = Rglpk::Problem.new
-    p.name = "sample"
-    p.obj.dir = Rglpk::GLP_MAX
+class TestBriefExample < Test::Unit::TestCase
+  include Examples
+  
+  def test_brief_example
+    p = brief_example
+    cols = p.cols
+    rows = p.rows
     
-    rows = p.add_rows(3)
-    rows[0].name = "p"
-    rows[0].set_bounds(Rglpk::GLP_UP, 0, 100)
-    rows[1].name = "q"
-    rows[1].set_bounds(Rglpk::GLP_UP, 0, 600)
-    rows[2].name = "r"
-    rows[2].set_bounds(Rglpk::GLP_UP, 0, 300)
-    
-    cols = p.add_cols(3)
-    cols[0].name = "x1"
-    cols[0].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
-    cols[1].name = "x2"
-    cols[1].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
-    cols[2].name = "x3"
-    cols[2].set_bounds(Rglpk::GLP_LO, 0.0, 0.0)
-    
-    p.obj.coefs = [10, 6, 4]
-    
-    p.set_matrix([
-       1, 1, 1,
-      10, 4, 5,
-       2, 2, 6
-    ])
-    
-    p.simplex
     z = p.obj.get
     x1 = cols[0].get_prim
     x2 = cols[1].get_prim

data/test/test_memory_leaks.rb

@@ -0,0 +1,30 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class TestMemoryLeaks < Test::Unit::TestCase
+  include Examples
+    
+  def test_memory_prof
+    5.times do
+      1000.times do |i|
+        brief_example
+      end
+      
+      change = change_to_real_memory_in_kb
+      assert (change < 10000), "memory leak #{change}kb"
+    end
+  end
+  
+  def real_memory_in_kb
+    # "=" after "rss" strips the header line.
+    `ps -p #{Process.pid} -o rss=`.to_i
+  end
+  
+  def change_to_real_memory_in_kb
+    GC.start
+    r = real_memory_in_kb
+    @change_to_real_memory_in_kb__prev ||= r
+    r - @change_to_real_memory_in_kb__prev
+  ensure
+    @change_to_real_memory_in_kb__prev = r
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: rglpk
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors: 
 - Alex Gutteridge
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-23 00:00:00 +08:00
+date: 2012-01-03 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -49,6 +49,7 @@ files:
 - test/test_all.rb
 - test/test_basic.rb
 - test/test_brief_example.rb
+- test/test_memory_leaks.rb
 - test/test_problem_kind.rb
 has_rdoc: true
 homepage: http://rglpk.rubyforge.org/