matlab-ruby 1.0.1 → 2.0.0

data/History.txt

@@ -1,7 +1,20 @@
+== 2.0.0 / 2008-01-03
+
+* 1 bug fix
+  * Added NilClass to_ruby method.
+* 3 changes
+  * Removed dynamic variable name setters/getters in favor of put_variable, get_variable methods. 
+  * 1 dimensional MATLAB matrices are now converted into a normal Ruby Arrays.
+  * 1 dimensional MATLAB struct matrices are now converted into normal Ruby Hashes.
+* 3 enhancements
+  * MATLAB functions may now be executed directly from the engine instead of having to use eval_string.
+  * Ruby Arrays are now converted into 1 dimensional MATLAB matrices.
+  * Ruby Hashes are now converted into 1 dimensional MATLAB struct matrices.
+  
 == 1.0.1 / 2007-04-27
 
 * 1 bug fix
-  * Need to check for nil value during MATLAB to Ruby StructMatrix conversion otherwise it segfaults
+  * Need to check for nil value during MATLAB to Ruby StructMatrix conversion otherwise it segfaults.
 
 == 1.0.0 / 2007-04-06
 

data/README.txt

@@ -17,16 +17,16 @@ A Ruby interface to the MATLAB interpreted language.
   require 'matlab'
   
   engine = Matlab::Engine.new
-  engine.x = 123.456
-  engine.y = 789.101112
-  engine.eval_string "z = x * y"
-  engine.z
+  engine.put_variable "x", 123.456
+  engine.put_variable "y", 789.101112
+  engine.eval "z = x * y"
+  engine.get_variable "z"
   
   matrix = Matlab::Matrix.new(20, 400)
   20.times { |m| 400.times { |n| matrix[m, n] = rand } }
-  engine.m = matrix
+  engine.put_variable "m", matrix
   
-  engine.eval_string "save '/tmp/20_x_400_matrix"
+  engine.save "/tmp/20_x_400_matrix"
   engine.close
 
 == REQUIREMENTS:

data/lib/matlab/driver/native/conversions.rb

@@ -27,6 +27,10 @@ class NilClass
   def to_matlab
     Matlab::Driver::Native::API.mxGetNaN
   end
+  
+  def to_ruby
+    nil
+  end
 end
 
 class Float
@@ -44,18 +48,44 @@ class Numeric
 end
 
 class Array
+  # Converts the array into a 1 Dimensional MATLAB numeric or cell matrix
+  def to_matlab
+    if all? { |value| value.kind_of?(Numeric) || value.nil? }
+      matrix = Matlab::Matrix.new(size, 1)
+    
+      each_with_index do |value, index|
+        matrix[index, 0] = value
+      end
+      matrix.to_matlab
+    else
+      to_cell_matrix.to_matlab
+    end
+  end
+  
   # Flattens and converts the array to a 1 Dimensional Matlab::CellMatrix
   def to_cell_matrix
-    values = flatten
-    cell_matrix = Matlab::CellMatrix.new(values.size, 1)
+    cell_matrix = Matlab::CellMatrix.new(size, 1)
     
-    values.each_with_index do |value, index|
+    each_with_index do |value, index|
       cell_matrix[index, 0] = value
     end
     cell_matrix
   end
 end
 
+class Hash
+  # Converts the hash into a 1 Dimensional MATLAB struct matrix
+  def to_matlab
+    struct_matrix = Matlab::StructMatrix.new(1, 1, *keys)
+    
+    each do |(key, value)|
+      struct_matrix[0,0][key] = value
+    end
+    
+    struct_matrix.to_matlab
+  end
+end
+
 module Matlab
   class Matrix
     # Converts the matrix into a MATLAB numeric matrix
@@ -75,7 +105,7 @@ module Matlab
       matrix
     end
     
-    # Creates a Matlab::Matrix from a MATLAB numeric matrix
+    # Creates a Matlab::Matrix or Ruby Array from a MATLAB numeric matrix
     def self.from_matlab(matrix)
       m = Matlab::Driver::Native::API.mxGetM(matrix)
       n = Matlab::Driver::Native::API.mxGetN(matrix)
@@ -91,7 +121,11 @@ module Matlab
         end
       end
       
-      matlab_matrix
+      if m == 1 || n == 1
+        matlab_matrix.cells.flatten
+      else
+        matlab_matrix
+      end
     end
   end
   
@@ -112,7 +146,7 @@ module Matlab
       matrix
     end
     
-    # Creates a Matlab::CellMatrix from a MATLAB cell matrix
+    # Creates a Matlab::CellMatrix or Ruby Array from a MATLAB cell matrix
     def self.from_matlab(matrix)
       m = Matlab::Driver::Native::API.mxGetM(matrix)
       n = Matlab::Driver::Native::API.mxGetN(matrix)
@@ -128,7 +162,11 @@ module Matlab
         end
       end
       
-      cell_matrix
+      if m == 1 || n == 1
+        cell_matrix.cells.collect { |cell| cell.first }
+      else
+        cell_matrix
+      end
     end
   end
   
@@ -152,7 +190,7 @@ module Matlab
       matrix
     end
     
-    # Creates a Matlab::StructMatrix from a MATLAB struct matrix
+    # Creates a Matlab::StructMatrix or Ruby Hash from a MATLAB struct matrix
     def self.from_matlab(matrix)
       m = Matlab::Driver::Native::API.mxGetM(matrix)
       n = Matlab::Driver::Native::API.mxGetN(matrix)
@@ -171,7 +209,11 @@ module Matlab
         end
       end
       
-      struct_matrix
+      if m == 1 && n == 1
+        struct_matrix.cells.flatten.first
+      else
+        struct_matrix
+      end
     end
   end
 end

data/lib/matlab/engine.rb

@@ -7,10 +7,10 @@ module Matlab
   #
   #   engine = Matlab::Engine.new
   #
-  #   engine.x = 123.456
-  #   engine.y = 789.101112
-  #   engine.eval_string "z = x * y"
-  #   p engine.z
+  #   engine.put_variable "x", 123.456
+  #   engine.put_variable "y", 789.101112
+  #   engine.eval "z = x * y"
+  #   p engine.get_variable "z"
   #
   #   engine.close
   #
@@ -35,15 +35,30 @@ module Matlab
       @driver.eval_string(@handle, string)
     end
     
-    # Puts or Gets a value to MATLAB via a given name
+    # Put a value to MATLAB via a given name
+    def put_variable(name, value)
+      @driver.put_variable(@handle, name, value)
+    end
+    
+    # Get a value from MATLAB via a given name
+    def get_variable(name)
+      @driver.get_variable(@handle, name)
+    end
+    
+    # Call a MATLAB function passing in the arguments
     def method_missing(method_id, *args)
       method_name = method_id.id2name
       
-      if method_name[(-1)..-1] == "="
-        @driver.put_variable(@handle, method_name.chop, args.first)
-      else
-        @driver.get_variable(@handle, method_name)
+      variable_names = []
+      args.each_with_index do |arg, index|
+        variable_names << variable_name = "mr#{index}_#{method_name}"
+        put_variable(variable_name, arg)
       end
+      
+      eval_string("#{method_name}(#{variable_names.join(", ")})")
+      result = get_variable("ans")
+      eval_string("clear #{variable_names.join(" ")}")
+      result
     end
       
     # Closes this engine

data/lib/matlab/version.rb

@@ -2,9 +2,9 @@ module Matlab
 
   module Version
 
-    MAJOR = 1
+    MAJOR = 2
     MINOR = 0
-    TINY  = 1
+    TINY  = 0
 
     STRING = [ MAJOR, MINOR, TINY ].join( "." )
     #:beta-tag:

data/test/driver/native/test_conversions.rb

@@ -33,15 +33,29 @@ class ConversionsTest < Test::Unit::TestCase
   end
   
   def test_array_to_cell_matrix
-    cell_matrix = Matlab::CellMatrix.new(9, 1)
-    9.times { |i| cell_matrix[i, 0] = (i > 4 ? i : i.to_s)  }
+    cell_matrix = Matlab::CellMatrix.new(7, 1)
     cell_matrix[0, 0] = true
-    cell_matrix[4, 0] = nil
-    cell_matrix[8, 0] = false
+    cell_matrix[1, 0] = "1"
+    cell_matrix[2, 0] = "2"
+    cell_matrix[3, 0] = ["3", nil, 5]
+    cell_matrix[4, 0] = 6
+    cell_matrix[5, 0] = 7
+    cell_matrix[6, 0] = false
     
     assert_equal cell_matrix, [true, "1", "2", ["3", nil, 5], 6, 7, false].to_cell_matrix
   end
   
+  def test_array_to_matlab_to_ruby
+    assert_equal [1.0, nil, 3.0], [1, nil, 3.0].to_matlab.to_ruby
+    assert_equal [1.0, "2", false, ["foo", "bar", "baz"]], [1, "2", false, ["foo", "bar", "baz"]].to_matlab.to_ruby
+  end
+  
+  def test_hash_to_matlab_to_ruby
+    assert_equal({"foo" => "bar"}, {"foo" => "bar"}.to_matlab.to_ruby) 
+    assert_equal({"foo" => [1.0,2.0,3.0]}, {"foo" => [1,2,3]}.to_matlab.to_ruby) 
+    assert_equal({"foo" => { "bar" => [1.0,2.0,3.0, [4.0,5.0,6.0]] }}, {"foo" => { "bar" => [1,2,3, [4,5,6]] }}.to_matlab.to_ruby)
+  end
+  
   def test_matlab_matrix_to_matlab_to_ruby
     matrix = Matlab::Matrix.new(3, 3)
     3.times { |m| 3.times { |n| matrix[m, n] = rand } }

data/test/test_engine.rb

@@ -65,13 +65,23 @@ class EngineTest < Test::Unit::TestCase
     @engine.close
   end
   
-  def test_method_missing_get
+  def test_get_variable
     @driver.expects(:get_variable).with(@handle, "x")
-    @engine.x
+    @engine.get_variable("x")
   end
   
-  def test_method_missing_put
+  def test_put_variable
     @driver.expects(:put_variable).with(@handle, "y", 123.456)
-    @engine.y = 123.456
+    @engine.put_variable("y", 123.456)
+  end
+  
+  def test_method_missing
+    @engine.expects(:put_variable).with("mr0_rand", 2)
+    @engine.expects(:put_variable).with("mr1_rand", 4)
+    @engine.expects(:eval_string).with("rand(mr0_rand, mr1_rand)")
+    @engine.expects(:get_variable).with("ans").returns("The Answer")
+    @engine.expects(:eval_string).with("clear mr0_rand mr1_rand")
+    
+    assert_equal "The Answer", @engine.rand(2, 4)
   end
 end

metadata

@@ -1,35 +1,38 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: matlab-ruby
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
-date: 2007-04-27 00:00:00 -06:00
-summary: A Ruby interface to the Matlab interpreted language.
-require_paths: 
-- lib
-- ext
-email: 
-- jonathan.younger@lipomics.com
-homepage: http://matlab-ruby.rubyforge.org/
-rubyforge_project: matlab-ruby
-description: "== USAGE:  require 'matlab'  engine = Matlab::Engine.new engine.x = 123.456 engine.y = 789.101112 engine.eval_string \"z = x * y\" engine.z  matrix = Matlab::Matrix.new(20, 400) 20.times { |m| 400.times { |n| matrix[m, n] = rand } } engine.m = matrix  engine.eval_string \"save '/tmp/20_x_400_matrix\" engine.close  == REQUIREMENTS:  * MATLAB * GCC or some other compiler to build the included extension * SWIG (If you want to recompile the SWIG wrapper) * Mocha (For testing only)"
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 2.0.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jonathan Younger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-07 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+description: "== USAGE:  require 'matlab'  engine = Matlab::Engine.new engine.put_variable \"x\", 123.456 engine.put_variable \"y\", 789.101112 engine.eval \"z = x * y\" engine.get_variable \"z\"  matrix = Matlab::Matrix.new(20, 400) 20.times { |m| 400.times { |n| matrix[m, n] = rand } } engine.put_variable \"m\", matrix  engine.save \"/tmp/20_x_400_matrix\" engine.close  == REQUIREMENTS:  * MATLAB * GCC or some other compiler to build the included extension * SWIG (If you want to recompile the SWIG wrapper) * Mocha (For testing only)"
+email: 
+- jonathan.younger@lipomics.com
+executables: []
+
+extensions: 
+- ext/matlab_api/extconf.rb
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
 files: 
 - History.txt
 - LICENSE.txt
@@ -50,27 +53,35 @@ files:
 - test/driver/native/test_conversions.rb
 - test/driver/native/test_driver.rb
 - test/test_engine.rb
+has_rdoc: true
+homepage: http://matlab-ruby.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: matlab-ruby
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A Ruby interface to the Matlab interpreted language.
 test_files: 
 - test/driver/native/test_conversions.rb
 - test/driver/native/test_driver.rb
 - test/test_engine.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: 
-- ext/matlab_api/extconf.rb
-requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: