matrix_extensions 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88ac601a61d4ccb18628977f97571ed3855545b1
-  data.tar.gz: 2c6efe2d7d213daebe2890c8ed1f86340703244d
+  metadata.gz: 0888299dc382dbaf662109214f80784ce36def63
+  data.tar.gz: a9b398b17dafb6bfb75b782e99e23619daf83ec8
 SHA512:
-  metadata.gz: 24ff51ffd991091061e34dc8786de49c360fe38208760e5d2f85d5589b95eb3590584f85235086b7a8174665338999078f6529afdd3ba2488ff07efdadf84746
-  data.tar.gz: 86e2592e5c1ceb6bea3f823d05af766614de133cc6dc04c3b708c557977f3bfc464f68d5d116968e6a0a0f6cc9896118ea0dfa7e3b2ce1961a6398b028fc3fa8
+  metadata.gz: f95b5b0497717de92579bf5f51ed34d96470825f6dea7b151f42a75add60e288cfbb95238c501c4d789829c0a06c91ab9cf461733475c20f44ecdb8ba386c757
+  data.tar.gz: 3d010969030d91e918d5a63e1607d6925d55faa5cc4c24e6481fc5d434b18d3b207954493fdcf7e59b4556483e3c6308dd35548848667780540ee2f5f5d24910

data/README.md

@@ -25,8 +25,8 @@ Element-wise multiplication:
 ```ruby
 require 'matrix_extensions' # if not loaded automatically
 
-MatrixExtended[ [1,2,3], [4,5,6] ].element_multiplication MatrixExtended[ [2,3,4], [5,6,7] ]
-=> MatrixExtended[[2, 6, 12], [20, 30, 42]]
+Matrix[ [1,2,3], [4,5,6] ].element_multiplication Matrix[ [2,3,4], [5,6,7] ]
+=> Matrix[[2, 6, 12], [20, 30, 42]]
 ```
 
 Element-wise division:
@@ -34,8 +34,8 @@ Element-wise division:
 ```ruby
 require 'matrix_extensions' # if not loaded automatically
 
-MatrixExtended[ [2,4,6], [2.0,10,20] ].element_division MatrixExtended[ [2,2,6], [4,5,10] ]
-=> MatrixExtended[[1, 2, 1], [0.5, 2, 2]]
+Matrix[ [2,4,6], [2.0,10,20] ].element_division Matrix[ [2,2,6], [4,5,10] ]
+=> Matrix[[1, 2, 1], [0.5, 2, 2]]
 ```
 
 Element-wise exponentiation:
@@ -43,8 +43,8 @@ Element-wise exponentiation:
 ```ruby
 require 'matrix_extensions' # if not loaded automatically
 
-MatrixExtended[ [2,4], [1,4] ].element_exponentiation MatrixExtended[ [2,4], [1,4]] ]
-=> MatrixExtended[[4, 256], [1, 256]]
+Matrix[ [2,4], [1,4] ].element_exponentiation Matrix[ [2,4], [1,4]] ]
+=> Matrix[[4, 256], [1, 256]]
 ```
 
 Prefilled matrix with zeros or ones:
@@ -52,11 +52,11 @@ Prefilled matrix with zeros or ones:
 ```ruby
 require 'matrix_extensions' # if not loaded automatically
 
-MatrixExtended.zeros(2,4)
-=> MatrixExtended[[0, 0, 0, 0], [0, 0, 0, 0]]
+Matrix.zeros(2,4)
+=> Matrix[[0, 0, 0, 0], [0, 0, 0, 0]]
 
-MatrixExtended.ones(2,2)
-=> MatrixExtended[[1, 1], [1, 1]]
+Matrix.ones(2,2)
+=> Matrix[[1, 1], [1, 1]]
 ```
 
 Concatenating matrices and vectors horizontally:
@@ -70,8 +70,8 @@ m1 = Matrix[ [1,2,3], [4,5,6] ]
 m2 = Matrix[ [2,3,4], [5,6,7] ]
 v = Vector[ 3,4 ]
 
-MatrixExtended.hconcat(m1, m2, v)
-=> MatrixExtended[[1, 2, 3, 2, 3, 4, 3], [4, 5, 6, 5, 6, 7, 4]]
+Matrix.hconcat(m1, m2, v)
+=> Matrix[[1, 2, 3, 2, 3, 4, 3], [4, 5, 6, 5, 6, 7, 4]]
 ```
 
 Concatenating matrices and vectors vertically:
@@ -85,8 +85,8 @@ m1 = Matrix[ [1,2,3], [4,5,6] ]
 m2 = Matrix[ [2,3,4], [5,6,7] ]
 v = Vector[ 3,4,5 ]
 
-MatrixExtended.vconcat(m1, m2, v)
-=> MatrixExtended[[1, 2, 3], [4, 5, 6], [2, 3, 4], [5, 6, 7], [3, 4, 5]]
+Matrix.vconcat(m1, m2, v)
+=> Matrix[[1, 2, 3], [4, 5, 6], [2, 3, 4], [5, 6, 7], [3, 4, 5]]
 ```
 
 ## Contributing

data/lib/matrix_extensions.rb

@@ -3,35 +3,25 @@ require 'matrix'
 
 # An extension to the Ruby Matrix class.
 # @author Michael Imstepf
-class MatrixExtended < Matrix
-  # Converts a Matrix to an MatrixExtended.
-  # @param m [Matrix] matrix
-  # @return [MatrixExtended] matrix
-  # @raise [TypeError] if matrices are not of type Matrix
-  def self.convert_to_matrix_extended(m)
-    raise TypeError, "#{m.class} is not a Matrix" unless m.is_a?(Matrix)
-
-    self.columns(m.column_vectors)
-  end
-
+class Matrix
   # Matrix prefilled with zeros.
-  # @param m [MatrixExtended] matrix
-  # @return [MatrixExtended] matrix
+  # @param m [Matrix] matrix
+  # @return [Matrix] matrix
   def self.zeros(rows = 1, columns = 1)
-    MatrixExtended.build(rows, columns) { 0 }
+    Matrix.build(rows, columns) { 0 }
   end
   self.singleton_class.send(:alias_method, :zeroes, :zeros)
 
   # Matrix prefilled with ones.
-  # @param m [MatrixExtended] matrix
-  # @return [MatrixExtended] matrix  
+  # @param m [Matrix] matrix
+  # @return [Matrix] matrix  
   def self.ones(rows = 1, columns = 1)
-    MatrixExtended.build(rows, columns) { 1 }
+    Matrix.build(rows, columns) { 1 }
   end
 
   # Concatenates two matrices horizontally (resulting in more columns).
-  # @param *matrices [MatrixExtended] matrices
-  # @return [MatrixExtended] concatenated matrix
+  # @param *matrices [Matrix] matrices
+  # @return [Matrix] concatenated matrix
   # @raise [ErrDimensionMismatch] if dimensions don't match
   # @raise [TypeError] if matrices are not of type Matrix or Vector 
   def self.hconcat(*matrices)        
@@ -57,8 +47,8 @@ class MatrixExtended < Matrix
   end  
 
   # Concatenates two matrices vertically (resulting in more rows).
-  # @param *matrices [MatrixExtended] matrices
-  # @return [MatrixExtended] concatenated matrix
+  # @param *matrices [Matrix] matrices
+  # @return [Matrix] concatenated matrix
   # @raise [ErrDimensionMismatch] if dimensions don't match
   # @raise [TypeError] if matrices are not of type Matrix or Vector  
   def self.vconcat(*matrices)
@@ -84,8 +74,8 @@ class MatrixExtended < Matrix
   end  
 
   # Element-wise division.
-  # @param m [MatrixExtended] matrix
-  # @return [MatrixExtended] matrix
+  # @param m [Matrix] matrix
+  # @return [Matrix] matrix
   # @raise [ErrDimensionMismatch] if dimensions don't match
   def element_division(m)
     case m
@@ -115,8 +105,8 @@ class MatrixExtended < Matrix
   end
   
   # Element-wise multiplication.
-  # @param m [MatrixExtended] matrix
-  # @return [MatrixExtended] matrix
+  # @param m [Matrix] matrix
+  # @return [Matrix] matrix
   # @raise [ErrDimensionMismatch] if dimensions don't match  
   def element_multiplication(m)
     case m
@@ -146,8 +136,8 @@ class MatrixExtended < Matrix
   end
 
   # Element-wise exponentiation.
-  # @param m [MatrixExtended] matrix
-  # @return [MatrixExtended] matrix
+  # @param m [Matrix] matrix
+  # @return [Matrix] matrix
   # @raise [ErrDimensionMismatch] if dimensions don't match  
   def element_exponentiation(m)
     case m
@@ -185,7 +175,7 @@ class MatrixExtended < Matrix
   # Convert vector to matrix for arithmetic operations.
   # @param vector [Vector] vector
   # @param dimension [Symbol] :row or :column
-  # @return [MatrixExtended] matrix
+  # @return [Matrix] matrix
   # @raise [TypeError] if vector ist not of type Vector    
   def self.convert_vector_to_matrix(v, dimension)
     raise TypeError, "#{v.class} is not a Vector" unless v.is_a? Vector    

data/lib/matrix_extensions/version.rb

@@ -1,3 +1,3 @@
 module MatrixExtensions
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/matrix_extensions_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+
+describe Matrix do
+  m23a = Matrix[ [1,2,3], [4,5,6] ] # 2 rows, 3 columns
+  m23b = Matrix[ [2,3,4], [5,6,7] ] # 2 rows, 3 columns
+  m22 = Matrix[ [1,2], [3,4] ] # 2 rows, 2 columns
+  m12 = Matrix[ [1,2] ] # 1 row, 2 columns
+  m21 = Matrix[ [1], [2] ] # 2 rows, 1 column
+  v = Vector[ 1,2 ]
+
+  describe '#element_division' do    
+    context 'when dimensions do not match' do
+      it 'raises an exception' do
+        expect {m23a.element_division m22}.to raise_exception(Matrix::ErrDimensionMismatch)
+      end
+    end
+
+    context 'when dimensions match' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_division m23b).to eq Matrix[ [1/2,2/3,3/4], [4/5,5/6,6/7] ]
+        expect(m23b.element_division m23a).to eq Matrix[ [2,3/2,4/3], [5/4,6/5,7/6] ]
+      end
+    end
+
+    context 'when one operator is numeric' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_division 2).to eq Matrix[ [1/2,2/2,3/2], [4/2,5/2,6/2] ]
+      end
+    end
+
+    context 'when one operator is a vector' do
+      context 'when dimensions do not match' do
+        it 'raises an exception' do
+          expect {m23a.element_division v}.to raise_exception(Matrix::ErrDimensionMismatch)          
+        end
+      end
+
+      context 'when dimensions match' do
+        it 'returns correct Matrix' do
+          expect(m21.element_division v).to eq Matrix[ [1],[1] ]
+          expect(m12.element_division v).to eq Matrix[ [1,1] ]                              
+        end
+      end            
+    end
+  end
+
+  describe '#element_multiplication' do    
+    context 'when dimensions do not match' do
+      it 'raises an exception' do
+        expect {m23a.element_multiplication m22}.to raise_exception(Matrix::ErrDimensionMismatch)
+      end
+    end
+
+    context 'when dimensions match' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_multiplication m23b).to eq Matrix[ [1*2,2*3,3*4], [4*5,5*6,6*7] ]
+        expect(m23b.element_multiplication m23a).to eq Matrix[ [2,3*2,4*3], [5*4,6*5,7*6] ]
+      end
+    end
+
+    context 'when one operator is numeric' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_multiplication 2).to eq Matrix[ [1*2,2*2,3*2], [4*2,5*2,6*2] ]
+      end
+    end
+
+    context 'when one operator is a vector' do
+      context 'when dimensions do not match' do
+        it 'raises an exception' do
+          expect {m23a.element_multiplication v}.to raise_exception(Matrix::ErrDimensionMismatch)          
+        end
+      end
+
+      context 'when dimensions match' do
+        it 'returns correct Matrix' do
+          expect(m21.element_multiplication v).to eq Matrix[ [1],[4] ]
+          expect(m12.element_multiplication v).to eq Matrix[ [1,4] ]                              
+        end
+      end            
+    end            
+  end
+
+  describe '#element_exponentiation' do    
+    context 'when dimensions do not match' do
+      it 'raises an exception' do
+        expect {m23a.element_exponentiation m22}.to raise_exception(Matrix::ErrDimensionMismatch)
+      end
+    end
+
+    context 'when dimensions match' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_exponentiation m23b).to eq Matrix[ [1,2**3,3**4], [4**5,5**6,6**7] ]
+        expect(m23b.element_exponentiation m23a).to eq Matrix[ [2,3**2,4**3], [5**4,6**5,7**6] ]
+      end
+    end
+
+    context 'when one operator is numeric' do
+      it 'returns correct Matrix' do
+        expect(m23a.element_exponentiation 2).to eq Matrix[ [1**2,2**2,3**2], [4**2,5**2,6**2] ]
+      end
+    end
+
+    context 'when one operator is a vector' do
+      context 'when dimensions do not match' do
+        it 'raises an exception' do
+          expect {m23a.element_exponentiation v}.to raise_exception(Matrix::ErrDimensionMismatch)          
+        end
+      end
+
+      context 'when dimensions match' do
+        it 'returns correct Matrix' do
+          expect(m21.element_exponentiation v).to eq Matrix[ [1],[4] ]
+          expect(m12.element_exponentiation v).to eq Matrix[ [1,4] ]                              
+        end
+      end            
+    end            
+  end
+
+  describe '#ones' do
+    it 'creates matrix with ones' do
+      expect(Matrix.ones(2, 3)). to eq Matrix[ [1,1,1], [1,1,1] ]
+    end
+  end
+
+  describe '#zeros' do
+    it 'creates matrix with zeros' do
+      expect(Matrix.zeros(2, 3)). to eq Matrix[ [0,0,0], [0,0,0] ]
+    end
+  end
+
+  describe '#zeroes' do
+    it 'creates matrix with zeros' do
+      expect(Matrix.zeros(2, 3)). to eq Matrix[ [0,0,0], [0,0,0] ]
+    end
+  end
+
+  describe '#hconcat' do
+    context 'when input is not a matrix or vector' do
+      it 'raises an exception' do
+        expect {Matrix.hconcat(m23a, m12, 5)}.to raise_exception(TypeError)                
+      end 
+    end
+
+    context 'when row dimensions do not match' do
+      it 'raises an exception' do
+        expect {Matrix.hconcat(m23a, m12)}.to raise_exception(Matrix::ErrDimensionMismatch)                
+      end                      
+    end
+
+    context 'when row dimensions match' do
+      it 'concatenates' do
+        expect(Matrix.hconcat(m23a, m22, m23b)).to eq Matrix[ [1,2,3,1,2,2,3,4], [4,5,6,3,4,5,6,7] ]
+      end
+    end
+
+    context 'when matrix is concatenated with a vector' do
+      context 'when dimensions match' do
+        it 'concatenates' do
+          expect(Matrix.hconcat(m22, v)).to eq Matrix[ [1,2,1], [3,4,2] ]
+          expect(Matrix.hconcat(m21, v)).to eq Matrix[ [1,1], [2,2] ]
+        end
+      end
+
+      context 'when dimensions do not match' do
+        it 'raises an exception' do
+          expect {Matrix.hconcat(m12, v)}.to raise_exception(Matrix::ErrDimensionMismatch)                
+        end
+      end      
+    end
+  end
+
+  describe '#vconcat' do
+    context 'when input is not a matrix or vector' do
+      it 'raises an exception' do
+        expect {Matrix.vconcat(m23a, m12, 5)}.to raise_exception(TypeError)                
+      end 
+    end
+
+    context 'when column dimensions do not match' do
+      it 'raises an exception' do
+        expect {Matrix.vconcat(m23a, m21)}.to raise_exception(Matrix::ErrDimensionMismatch)                
+      end                      
+    end
+
+    context 'when column dimensions match' do
+      it 'concatenates' do
+        expect(Matrix.vconcat(m23a, m23b)).to eq Matrix[ [1,2,3], [4,5,6], [2,3,4], [5,6,7] ]
+      end
+    end
+
+    context 'when matrix is concatenated with a vector' do
+      context 'when dimensions match' do
+        it 'concatenates' do
+          expect(Matrix.vconcat(m12, v)).to eq Matrix[ [1,2], [1,2] ]
+        end
+      end
+
+      context 'when dimensions do not match' do
+        it 'raises an exception' do
+          expect {Matrix.vconcat(m21, v)}.to raise_exception(Matrix::ErrDimensionMismatch)                
+        end
+      end      
+    end        
+  end        
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'matrix_extensions'
+
+RSpec.configure do |config|  
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  
+  # when a focus tag is present in RSpec, only run tests with focus tag: http://railscasts.com/episodes/285-spork
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: matrix_extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Imstepf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,8 @@ files:
 - lib/matrix_extensions.rb
 - lib/matrix_extensions/version.rb
 - matrix_extensions.gemspec
+- spec/matrix_extensions_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/michaelimstepf/matrix-extensions
 licenses:
 - MIT
@@ -92,4 +94,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Extension of the Ruby Matrix class.
-test_files: []
+test_files:
+- spec/matrix_extensions_spec.rb
+- spec/spec_helper.rb