relax4 1.1.0 → 1.2.0

data/README.rdoc

@@ -98,11 +98,11 @@ An assignment problem:
 == REQUIREMENTS
 
 Has been tested on:
-* x86-linux (Ubuntu 10.04) with Ruby 1.8.7p249
-* x86-linux (Ubuntu 10.04) with Ruby 1.9.1p378
-* x86_64-linux (CentOS) with Ruby 1.8.7p72
+* ruby 1.8.7 (2011-06-30 patchlevel 352) [i686-linux] and [x86_64-linux]
+* ruby 1.9.2p290 (2011-07-09 revision 32553) [i686-linux] and [x86_64-linux]
 
-The following packages were required to install on Ubuntu 10.04:
+The following packages were required to install with the system ruby on Ubuntu
+10.04:
 
 * ruby, ruby-dev, rubygems
 
@@ -111,18 +111,16 @@ The bindings were generated with f2c (FORTRAN to C converter) and SWIG
 
 == INSTALL
 
-You should be able to install with
-
   gem install relax4
 
-Alternatively, you can get the source with
-
-  git clone http://github.com/jdleesmiller/relax4_ruby.git
+== DEVELOPMENT
 
-and run
+Get the source from github (http://github.com/jdleesmiller/relax4_ruby) and
+use bundler to get the development dependencies:
 
-  gem build relax4.gemspec
-  gem install relax4-<version>.gem
+  gem install bundler
+  bundle
+  rake -T # list development tasks
 
 == TODO
 
@@ -131,6 +129,12 @@ and run
 
 == HISTORY
 
+<em>1.2.0</em> 20110905
+* reorganized gem to be consistent with http://guides.rubygems.org/c-extensions
+* now using gemma 2 for development tasks
+* added major, minor and patch version constants (no other API changes)
+* wrapper regenerated with swig 2.0.4 (was 1.3.38)
+
 <em>1.1.0</em>
 * added wrappers for transportation and assignment problems
 * updated docs

data/ext/{relax4_wrap.c → relax4/relax4_wrap.c}

@@ -1,6 +1,6 @@
 /* ----------------------------------------------------------------------------
  * This file was automatically generated by SWIG (http://www.swig.org).
- * Version 1.3.38
+ * Version 2.0.4
  * 
  * This file is not intended to be easily readable and contains a number of 
  * coding conventions designed to improve portability and efficiency. Do not make
@@ -281,7 +281,7 @@
 /* 
    Flags/methods for returning states.
    
-   The SWIG conversion methods, as ConvertPtr, return and integer 
+   The SWIG conversion methods, as ConvertPtr, return an integer 
    that tells if the conversion was successful or not. And if not,
    an error code can be returned (see swigerrors.swg for the codes).
    
@@ -831,6 +831,15 @@ SWIG_UnpackDataName(const char *c, void *ptr, size_t sz, const char *name) {
 
 #include <ruby.h>
 
+/* Ruby 1.9.1 has a "memoisation optimisation" when compiling with GCC which
+ * breaks using rb_intern as an lvalue, as SWIG does.  We work around this
+ * issue for now by disabling this.
+ * https://sourceforge.net/tracker/?func=detail&aid=2859614&group_id=1645&atid=101645
+ */
+#ifdef rb_intern
+# undef rb_intern
+#endif
+
 /* Remove global macros defined in Ruby's win32.h */
 #ifdef write
 # undef write
@@ -838,6 +847,15 @@ SWIG_UnpackDataName(const char *c, void *ptr, size_t sz, const char *name) {
 #ifdef read
 # undef read
 #endif
+#ifdef bind
+# undef bind
+#endif
+#ifdef close
+# undef close
+#endif
+#ifdef connect
+# undef connect
+#endif
 
 
 /* Ruby 1.7 defines NUM2LL(), LL2NUM() and ULL2NUM() macros */
@@ -980,7 +998,7 @@ static VALUE _mSWIG = Qnil;
 
 /* Define custom exceptions for errors that do not map to existing Ruby
    exceptions.  Note this only works for C++ since a global cannot be
-   initialized by a funtion in C.  For C, fallback to rb_eRuntimeError.*/
+   initialized by a function in C.  For C, fallback to rb_eRuntimeError.*/
 
 SWIGINTERN VALUE 
 getNullReferenceError(void) {
@@ -1125,9 +1143,6 @@ void Ruby_Format_OverloadedError(
 }
 
 /* -----------------------------------------------------------------------------
- * See the LICENSE file for information on copyright, usage and redistribution
- * of SWIG, and the README file for authors - http://www.swig.org/release.html.
- *
  * rubytracking.swg
  *
  * This file contains support for tracking mappings from 
@@ -1323,9 +1338,6 @@ SWIG_Ruby_AppendOutput(VALUE target, VALUE o) {
 
 
 /* -----------------------------------------------------------------------------
- * See the LICENSE file for information on copyright, usage and redistribution
- * of SWIG, and the README file for authors - http://www.swig.org/release.html.
- *
  * rubyrun.swg
  *
  * This file contains the runtime support for Ruby modules
@@ -1369,7 +1381,7 @@ SWIG_Ruby_AppendOutput(VALUE target, VALUE o) {
 /* Error manipulation */
 
 #define SWIG_ErrorType(code)                            SWIG_Ruby_ErrorType(code)               
-#define SWIG_Error(code, msg)            		rb_raise(SWIG_Ruby_ErrorType(code), msg)
+#define SWIG_Error(code, msg)            		rb_raise(SWIG_Ruby_ErrorType(code), "%s", msg)
 #define SWIG_fail                        		goto fail				 
 
 
@@ -1424,7 +1436,7 @@ static ID swig_call_id  = 0;
       ++swig_virtual_calls;
 #  define SWIG_RELEASE_STACK --swig_virtual_calls;
 #  define Ruby_DirectorTypeMismatchException(x) \
-          rb_raise( rb_eTypeError, x ); return c_result;
+          rb_raise( rb_eTypeError, "%s", x ); return c_result;
 
       static unsigned int swig_virtual_calls = 0;
 
@@ -1796,7 +1808,7 @@ static VALUE mRelax4;
 #define SWIG_RUBY_THREAD_END_BLOCK
 
 
-#define SWIGVERSION 0x010338 
+#define SWIGVERSION 0x020004 
 #define SWIG_VERSION SWIGVERSION
 
 
@@ -1817,7 +1829,7 @@ SWIG_ruby_failed(void)
 } 
 
 
-/*@SWIG:/usr/local/share/swig/1.3.38/ruby/rubyprimtypes.swg,23,%ruby_aux_method@*/
+/*@SWIG:/home/john/local/share/swig/2.0.4/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2ULONG(VALUE *args)
 {
   VALUE obj = args[0];
@@ -1882,7 +1894,7 @@ SWIG_From_int  (int value)
 }
 
 
-/*@SWIG:/usr/local/share/swig/1.3.38/ruby/rubyprimtypes.swg,23,%ruby_aux_method@*/
+/*@SWIG:/home/john/local/share/swig/2.0.4/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2LONG(VALUE *args)
 {
   VALUE obj = args[0];
@@ -1935,7 +1947,7 @@ SWIGINTERN int *IntegerArray_cast(IntegerArray *self){
 SWIGINTERN IntegerArray *IntegerArray_frompointer(int *t){
     return (IntegerArray *)(t);
   }
-swig_class cIntegerArray;
+swig_class SwigClassIntegerArray;
 
 #ifdef HAVE_RB_DEFINE_ALLOC_FUNC
 SWIGINTERN VALUE
@@ -2609,17 +2621,17 @@ SWIGEXPORT void Init_relax4(void) {
   
   SWIG_RubyInitializeTrackings();
   
-  cIntegerArray.klass = rb_define_class_under(mRelax4, "IntegerArray", rb_cObject);
-  SWIG_TypeClientData(SWIGTYPE_p_IntegerArray, (void *) &cIntegerArray);
-  rb_define_alloc_func(cIntegerArray.klass, _wrap_IntegerArray_allocate);
-  rb_define_method(cIntegerArray.klass, "initialize", _wrap_new_IntegerArray, -1);
-  rb_define_method(cIntegerArray.klass, "[]", _wrap_IntegerArray___getitem__, -1);
-  rb_define_method(cIntegerArray.klass, "[]=", _wrap_IntegerArray___setitem__, -1);
-  rb_define_method(cIntegerArray.klass, "cast", _wrap_IntegerArray_cast, -1);
-  rb_define_singleton_method(cIntegerArray.klass, "frompointer", _wrap_IntegerArray_frompointer, -1);
-  cIntegerArray.mark = 0;
-  cIntegerArray.destroy = (void (*)(void *)) free_IntegerArray;
-  cIntegerArray.trackObjects = 0;
+  SwigClassIntegerArray.klass = rb_define_class_under(mRelax4, "IntegerArray", rb_cObject);
+  SWIG_TypeClientData(SWIGTYPE_p_IntegerArray, (void *) &SwigClassIntegerArray);
+  rb_define_alloc_func(SwigClassIntegerArray.klass, _wrap_IntegerArray_allocate);
+  rb_define_method(SwigClassIntegerArray.klass, "initialize", _wrap_new_IntegerArray, -1);
+  rb_define_method(SwigClassIntegerArray.klass, "[]", _wrap_IntegerArray___getitem__, -1);
+  rb_define_method(SwigClassIntegerArray.klass, "[]=", _wrap_IntegerArray___setitem__, -1);
+  rb_define_method(SwigClassIntegerArray.klass, "cast", _wrap_IntegerArray_cast, -1);
+  rb_define_singleton_method(SwigClassIntegerArray.klass, "frompointer", _wrap_IntegerArray_frompointer, -1);
+  SwigClassIntegerArray.mark = 0;
+  SwigClassIntegerArray.destroy = (void (*)(void *)) free_IntegerArray;
+  SwigClassIntegerArray.trackObjects = 0;
   rb_define_const(mRelax4, "RELAX4_OK", SWIG_From_int((int)(0)));
   rb_define_const(mRelax4, "RELAX4_INFEASIBLE", SWIG_From_int((int)(1)));
   rb_define_const(mRelax4, "RELAX4_FAIL_OUT_OF_MEMORY", SWIG_From_int((int)(2)));

data/lib/relax4/version.rb

@@ -1,3 +1,6 @@
 module Relax4
-  VERSION = '1.1.0'
+  VERSION_MAJOR = 1
+  VERSION_MINOR = 2
+  VERSION_PATCH = 0
+  VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
 end

data/lib/relax4.rb

@@ -1,4 +1,4 @@
-require 'relax4.so'
+require 'relax4/relax4' # the C extension
 
 # 
 # Methods for calling the RELAX IV solver.
@@ -7,9 +7,9 @@ require 'relax4.so'
 #
 # There are also lower-level methods. Unfortunately, swig and rdoc don't work
 # very well together, so the best references for these calls are currently the
-# source of {Relax4.solve} and the <tt>ext/relax4.h</tt> header file listed
+# source of {Relax4.solve} and the <tt>relax4.h</tt> header file listed
 # below:
-#  :include:../ext/relax4.h
+#  :include:../ext/relax4/relax4.h
 #
 module Relax4
   #
@@ -41,10 +41,10 @@ module Relax4
   # an initial feasible solution; this is recommended only for hard problems.
   #
   # @option args [Integer] :large (RELAX4_DEFAULT_LARGE) a very large integer to
-  # represent infinity; see the ext/relax4.h listing above for more info.
+  # represent infinity; see the relax4.h listing above for more info.
   #
   # @option args [Integer] :max_cost (RELAX4_DEFAULT_MAX_COST) largest allowed
-  # cost, in order to avoid integer overflow; see the ext/relax4.h listing above
+  # cost, in order to avoid integer overflow; see the relax4.h listing above
   # for more info.
   #
   # @return [Array<Integer>] optimal flows for each arc
@@ -338,7 +338,7 @@ module Relax4
   # Set start_nodes, end_nodes and costs based on cost matrix; nil entries in
   # the cost matrix are not mapped to arcs.
   #
-  # @return Array<Array<Integer>> array of pairs of (zero-based) indices into
+  # @return [Array<Array<Integer>>] array of pairs of (zero-based) indices into
   # costs that correspond to the created arcs; size is <tt>m*n</tt> minus the
   # number of nil entries in the costs matrix
   #

data/test/{test_relax4.rb → relax4/relax4_test.rb}

@@ -1,6 +1,8 @@
 require "test/unit"
 require "relax4"
 
+INPUT_PATH = File.join('test','relax4')
+
 class TestRelax4< Test::Unit::TestCase
   def test_solve_1
     # From Figure 7.14 of Bertsimas and Tsitsiklis (1997). Introduction to
@@ -71,7 +73,7 @@ class TestRelax4< Test::Unit::TestCase
   end
 
   def test_solve_3
-    prob = problem_from_relax4_inp 'test/RELAX4.INP'
+    prob = problem_from_relax4_inp File.join(INPUT_PATH, 'RELAX4.INP')
 
     flows = Relax4.solve(prob)
     assert_equal(-26464, problem_cost(prob, flows))
@@ -89,7 +91,7 @@ class TestRelax4< Test::Unit::TestCase
     # Note that giving this file to the original application works, because it
     # only reads the first 8 digits of any input number (format I8) -- i.e. it
     # sets the capacities to 50M not 500M. 
-    prob = problem_from_relax4_inp 'test/test_solve_4.inp'
+    prob = problem_from_relax4_inp File.join(INPUT_PATH, 'test_solve_4.inp')
     prob[:capacities].map! {|x| [x, Relax4::RELAX4_UNCAPACITATED].min}
     flows = Relax4.solve(prob)
     assert_equal 1381, problem_cost(prob, flows)
@@ -100,7 +102,7 @@ class TestRelax4< Test::Unit::TestCase
     # apparent bug in the ascnt2_ routine (out of bounds on the prdcsr array,
     # which was not long enough to record the number of newly balanced arcs).
     # This bug affected versions 1.0.3 and earlier.
-    prob = problem_from_relax4_inp 'test/test_solve_5.inp'
+    prob = problem_from_relax4_inp File.join(INPUT_PATH, 'test_solve_5.inp')
     prob[:capacities].map! {|x| [x, Relax4::RELAX4_UNCAPACITATED].min}
     flows = Relax4.solve(prob)
     assert_equal 28759, problem_cost(prob, flows)
@@ -111,7 +113,7 @@ class TestRelax4< Test::Unit::TestCase
     # reasons as the problem in test_solve_5. The fix for that didn't entirely
     # resolve the issue; see comments in relax4.c.
     # This bug affected versions 1.0.4 and earlier.
-    prob = problem_from_relax4_inp 'test/test_solve_6.inp'
+    prob = problem_from_relax4_inp File.join(INPUT_PATH, 'test_solve_6.inp')
     prob[:capacities].map! {|x| [x, Relax4::RELAX4_UNCAPACITATED].min}
     flows = Relax4.solve(prob)
     assert_equal 16925, problem_cost(prob, flows)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: relax4
 version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - John Lees-Miller
@@ -15,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 +01:00
+date: 2011-09-06 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  version_requirements: *id001
+  name: gemma
+  prerelease: false
+  type: :development
 description: |
   Ruby interface for the RELAX IV code by D.P. Bertsekas and P. Tseng.
 
@@ -27,22 +42,22 @@ email:
 executables: []
 
 extensions: 
-- ext/extconf.rb
+- ext/relax4/extconf.rb
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- lib/relax4.rb
 - lib/relax4/version.rb
-- test/test_solve_6.inp
-- test/test_solve_5.inp
-- test/test_solve_4.inp
-- test/RELAX4.INP
-- ext/extconf.rb
-- ext/relax4.c
-- ext/relax4.h
-- ext/relax4_wrap.c
+- lib/relax4.rb
+- ext/relax4/extconf.rb
+- ext/relax4/relax4_wrap.c
+- ext/relax4/relax4.c
+- ext/relax4/relax4.h
+- test/relax4/test_solve_5.inp
+- test/relax4/test_solve_6.inp
+- test/relax4/test_solve_4.inp
+- test/relax4/RELAX4.INP
 - README.rdoc
-- test/test_relax4.rb
+- test/relax4/relax4_test.rb
 has_rdoc: true
 homepage: http://relax4.rubyforge.org/
 licenses: []
@@ -52,12 +67,11 @@ rdoc_options:
 - --main
 - README.rdoc
 - --title
-- relax4-1.1.0
+- relax4-1.2.0
 - --exclude
 - ext
 require_paths: 
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -79,9 +93,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: relax4
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: The RELAX IV code for the Minimum Cost Network Flow Problem
 test_files: 
-- test/test_relax4.rb
+- test/relax4/relax4_test.rb