matrix_extensions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88ac601a61d4ccb18628977f97571ed3855545b1
+  data.tar.gz: 2c6efe2d7d213daebe2890c8ed1f86340703244d
+SHA512:
+  metadata.gz: 24ff51ffd991091061e34dc8786de49c360fe38208760e5d2f85d5589b95eb3590584f85235086b7a8174665338999078f6529afdd3ba2488ff07efdadf84746
+  data.tar.gz: 86e2592e5c1ceb6bea3f823d05af766614de133cc6dc04c3b708c557977f3bfc464f68d5d116968e6a0a0f6cc9896118ea0dfa7e3b2ce1961a6398b028fc3fa8

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matrix_extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Imstepf
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# Extension of the Ruby Matrix class
+
+This gem extends the [Ruby Matrix class](http://www.ruby-doc.org/stdlib-2.1.2/libdoc/matrix/rdoc/Matrix.html) by providing additional methods.
+
+It is more light-weight and less powerful than the [SciRuby NMatrix module](https://github.com/SciRuby/nmatrix). It is also easier to install than the NMatrix module since there is no need to manually install libraries and configure the operating system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'matrix_extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matrix_extensions
+
+## Usage
+
+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]]
+```
+
+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]]
+```
+
+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]]
+```
+
+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]]
+
+MatrixExtended.ones(2,2)
+=> MatrixExtended[[1, 1], [1, 1]]
+```
+
+Concatenating matrices and vectors horizontally:
+
+This iterates through a list of matrices and vectors and appends columns of each list one after another. The row number of all matrices and vectors must be equal. The number of arguments passed in can be freely chosen.
+
+```ruby
+require 'matrix_extensions' # if not loaded automatically
+
+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]]
+```
+
+Concatenating matrices and vectors vertically:
+
+This iterates through a list of matrices and vectors and appends rows of each list one after another. The column number of all matrices and vectors must be equal. The number of arguments passed in can be freely chosen.
+
+```ruby
+require 'matrix_extensions' # if not loaded automatically
+
+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]]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/matrix_extensions/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/matrix_extensions.rb

@@ -0,0 +1,201 @@
+require "matrix_extensions/version"
+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
+
+  # Matrix prefilled with zeros.
+  # @param m [MatrixExtended] matrix
+  # @return [MatrixExtended] matrix
+  def self.zeros(rows = 1, columns = 1)
+    MatrixExtended.build(rows, columns) { 0 }
+  end
+  self.singleton_class.send(:alias_method, :zeroes, :zeros)
+
+  # Matrix prefilled with ones.
+  # @param m [MatrixExtended] matrix
+  # @return [MatrixExtended] matrix  
+  def self.ones(rows = 1, columns = 1)
+    MatrixExtended.build(rows, columns) { 1 }
+  end
+
+  # Concatenates two matrices horizontally (resulting in more columns).
+  # @param *matrices [MatrixExtended] matrices
+  # @return [MatrixExtended] concatenated matrix
+  # @raise [ErrDimensionMismatch] if dimensions don't match
+  # @raise [TypeError] if matrices are not of type Matrix or Vector 
+  def self.hconcat(*matrices)        
+    columns = []
+    matrices.each do |m|
+      raise TypeError, "#{m.class} is not a Matrix or Vector" unless m.is_a?(Matrix) || m.is_a?(Vector)
+      
+      # convert Vector to Matrix
+      m = self.convert_vector_to_matrix(m, :column) if m.is_a? Vector
+
+      # check if dimensions match
+      row_count ||= m.row_count
+      Matrix.Raise ErrDimensionMismatch unless row_count == m.row_count
+      
+      # prepare array of columns
+      m.column_vectors.each do |v|
+        columns << v.to_a
+      end
+    end
+
+    # create new matrix
+    self.columns(columns)
+  end  
+
+  # Concatenates two matrices vertically (resulting in more rows).
+  # @param *matrices [MatrixExtended] matrices
+  # @return [MatrixExtended] concatenated matrix
+  # @raise [ErrDimensionMismatch] if dimensions don't match
+  # @raise [TypeError] if matrices are not of type Matrix or Vector  
+  def self.vconcat(*matrices)
+    rows = []
+    matrices.each do |m|
+      raise TypeError, "#{m.class} is not a Matrix or Vector" unless m.is_a?(Matrix) || m.is_a?(Vector)
+      
+      # convert Vector to Matrix
+      m = self.convert_vector_to_matrix(m, :row) if m.is_a? Vector
+
+      # check if dimensions match
+      column_count ||= m.column_count
+      Matrix.Raise ErrDimensionMismatch unless column_count == m.column_count
+      
+      # prepare array of columns
+      m.row_vectors.each do |v|
+        rows << v.to_a
+      end
+    end
+
+    # create new matrix
+    self.rows(rows)
+  end  
+
+  # Element-wise division.
+  # @param m [MatrixExtended] matrix
+  # @return [MatrixExtended] matrix
+  # @raise [ErrDimensionMismatch] if dimensions don't match
+  def element_division(m)
+    case m
+    when Numeric
+      return self./ m
+    when Vector            
+      if row_count > column_count
+        # Matrix is of dimension X * 1 (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :column)      
+      else
+        # Matrix is of dimension 1 * X (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :row)
+      end
+    when Matrix
+    else
+      return apply_through_coercion(m, __method__)
+    end
+
+    Matrix.Raise ErrDimensionMismatch unless row_count == m.row_count && column_count == m.column_count
+
+    rows = Array.new(row_count) do |i|
+      Array.new(column_count) do|j|
+        self[i, j] / m[i, j]
+      end
+    end
+    new_matrix rows, column_count  
+  end
+  
+  # Element-wise multiplication.
+  # @param m [MatrixExtended] matrix
+  # @return [MatrixExtended] matrix
+  # @raise [ErrDimensionMismatch] if dimensions don't match  
+  def element_multiplication(m)
+    case m
+    when Numeric
+      return self.* m
+    when Vector            
+      if row_count > column_count
+        # Matrix is of dimension X * 1 (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :column)      
+      else
+        # Matrix is of dimension 1 * X (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :row)
+      end
+    when Matrix
+    else
+      return apply_through_coercion(m, __method__)
+    end
+
+    Matrix.Raise ErrDimensionMismatch unless row_count == m.row_count && column_count == m.column_count
+
+    rows = Array.new(row_count) do |i|
+      Array.new(column_count) do|j|
+        self[i, j] * m[i, j]
+      end
+    end
+    new_matrix rows, column_count  
+  end
+
+  # Element-wise exponentiation.
+  # @param m [MatrixExtended] matrix
+  # @return [MatrixExtended] matrix
+  # @raise [ErrDimensionMismatch] if dimensions don't match  
+  def element_exponentiation(m)
+    case m
+    when Numeric
+      # self.** m will break
+      rows = @rows.collect {|row|
+        row.collect {|e| e ** m }
+      }
+      return new_matrix rows, column_count
+    when Vector            
+      if row_count > column_count
+        # Matrix is of dimension X * 1 (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :column)      
+      else
+        # Matrix is of dimension 1 * X (or there'll be an ErrDimensionMismatch)
+        m = self.class.convert_vector_to_matrix(m, :row)
+      end
+    when Matrix
+    else
+      return apply_through_coercion(m, __method__)
+    end
+
+    Matrix.Raise ErrDimensionMismatch unless row_count == m.row_count && column_count == m.column_count
+
+    rows = Array.new(row_count) do |i|
+      Array.new(column_count) do|j|
+        self[i, j] ** m[i, j]
+      end
+    end
+    new_matrix rows, column_count 
+  end
+
+  private
+
+  # Convert vector to matrix for arithmetic operations.
+  # @param vector [Vector] vector
+  # @param dimension [Symbol] :row or :column
+  # @return [MatrixExtended] 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    
+
+    if dimension == :row
+      self.row_vector(v)
+    elsif dimension == :column
+      self.column_vector(v)
+    else
+      raise ArgumentError
+    end
+  end
+end

data/lib/matrix_extensions/version.rb

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

data/matrix_extensions.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'matrix_extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "matrix_extensions"
+  spec.version       = MatrixExtensions::VERSION
+  spec.authors       = ["Michael Imstepf"]
+  spec.email         = ["michael.imstepf@gmail.com"]
+  spec.summary       = %q{Extension of the Ruby Matrix class.}
+  spec.description   = %q{Element-wise matrix operations, concatenation and pre-filled matrices with single values.}
+  spec.homepage      = "https://github.com/michaelimstepf/matrix-extensions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: matrix_extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Imstepf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Element-wise matrix operations, concatenation and pre-filled matrices
+  with single values.
+email:
+- michael.imstepf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/matrix_extensions.rb
+- lib/matrix_extensions/version.rb
+- matrix_extensions.gemspec
+homepage: https://github.com/michaelimstepf/matrix-extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extension of the Ruby Matrix class.
+test_files: []