rmatrix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e572268a9fa4fd04c2ac166d7141581ca677edd0
+  data.tar.gz: 41f62ceec7f2c54bc3b13899e479dbf8f433a5ca
+SHA512:
+  metadata.gz: a75e6d8d05a41a7c830e6d50853c26c33233e0463d55a8afc3cf170be5bbaf2d3d090ec95929465eb930be8fcc4f3e3418666db70c122705904f21c7faed4e8a
+  data.tar.gz: 40cbe6898a74869c74a411357eec77f5ea7aa2ce3c857d674cc884115123d11157317ae276999e9f053cf205c143b1ae791d2b37295cb4cd790526dfa9b368de

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wouter Coppieters
+
+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,41 @@
+# Rmatrix
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rmatrix`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rmatrix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rmatrix
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rmatrix.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rmatrix"
+require 'pry'
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rmatrix.rb

@@ -0,0 +1,3 @@
+require "rmatrix/version"
+require "rmatrix/core"
+require "rmatrix/shortcuts"

data/lib/rmatrix/core.rb

@@ -0,0 +1,2 @@
+require "rmatrix/matrix"
+require "rmatrix/vector"

data/lib/rmatrix/matrix.rb

@@ -0,0 +1,271 @@
+module RMatrix
+  class Matrix
+    require 'narray'
+    include Enumerable
+
+    attr_accessor :invert_next_operation, :matrix, :narray, :typecode
+
+    def initialize(source, narray: nil)
+      self.typecode = 'float'
+
+      if [Symbol, String].include?(source.class)
+        dimensions = "#{source}".split("x").map(&:to_i)
+        source = NArray.new(typecode, dimensions.inject(:*)).reshape(dimensions[1], dimensions[0])
+      end
+
+      self.narray = NArray.refer(narray || two_dimensional(source, typecode))
+      self.matrix = NMatrix.refer(self.narray)
+    end
+
+    def _dump(level)
+      [narray.typecode, columns, rows, narray.to_s].join(":")
+    end
+
+    def self._load arg
+      typecode, columns, rows, as_str = arg.split(":",4)
+      Matrix.new(nil, narray: NArray.to_na(as_str.to_s, typecode.to_i).reshape(columns.to_i, rows.to_i))
+    end
+
+    def each(&block)
+      e = Enumerator.new do |enum|
+        matrix.each do |elm|
+          enum << elm
+        end
+      end
+      block_given? ? e.each(&block) : e
+    end
+
+    def mmap
+      as_na = NArray.to_na(
+        matrix.each.map do |elm|
+          yield elm
+        end
+      ).to_type(typecode)
+      Matrix.new(as_na.reshape(*shape))
+    end
+
+    def coerce(other)
+      self.invert_next_operation = true
+      [self, other]
+    end
+
+    def size
+      self.shape.inject(:*)
+    end
+
+    def rows
+      self.shape.last
+    end
+
+    def columns
+      self.shape.first
+    end
+
+    def sum_rows
+      Matrix.new(sum(0))
+    end
+
+    def sum_columns
+      Matrix.new(sum(1))
+    end
+
+    def two_dimensional(source, type)
+      source = [source] if Numeric === source
+      source = NArray.to_na(source).to_type(type)
+      case source.dim
+      when 1
+        source.reshape(source.length, 1)
+      when 2
+        source
+      else
+        raise "Source for matrix must be either one or two dimensional" unless source.shape[2..-1].all?{|x| x == 1}
+        source.reshape(source.shape[0], source.shape[1])
+      end
+    end
+
+    def minor(x,y)
+      return self.delete_at(y,x)
+    end
+
+    def cofactor_matrix(*args)
+      return cofactor(*args) if args.length == 2
+
+      result = []
+      rows.times do |i|
+        result << []
+        columns.times do |j|
+          result[i] << cofactor(i, j)
+        end
+      end
+      return Matrix.new(result)
+    end
+
+    def determinant
+      raise "Cannot calculate determinant of non-square matrix" unless columns == rows
+      return self[0, 0] * self[1, 1]- self[0, 1] * self[1, 0] if(self.columns == 2)
+      sign = 1
+      det = 0
+      self.columns.times do |i|
+        det += sign * self[0,i] * self.minor(0, i).determinant
+        sign *= -1
+      end
+      return det
+    end
+
+    def adjoint
+      self.cofactor_matrix.transpose
+    end
+
+    def *(other)
+      if other.kind_of?(Matrix)
+        raise "Matrix A columns(#{self.columns}) != Matrix B rows(#{other.columns})" if other.rows != self.columns
+        Matrix.new(self.matrix * other.matrix)
+      else
+        Matrix.new(apply_scalar(:*, other))
+      end
+    end
+
+    def mult(other)
+      apply_elementwise(:*, other)
+    end
+
+    def ==(other)
+      self.matrix == Matrix[other].matrix
+    end
+
+    def to_s
+      inspect
+    end
+
+    def box_lines(lines, add_dots)
+      "[#{lines.map{|l| "[#{l}#{add_dots ? ' ...' : '' }]"}.join(",\n  ")}]"
+    end
+
+    def round(dp)
+      mmap{|x| x.round(dp) }
+    end
+
+    def inspect
+      inspect_rows    = [10, self.rows].min
+      inspect_columns = [10, self.columns].min
+      more_rows       = inspect_rows    < self.rows
+      more_columns    = inspect_columns < self.columns
+
+      to_print        = self.matrix[0...inspect_columns, 0...inspect_rows]
+      as_strings = inspect_columns.times.map do |i|
+        column    = to_print[i, 0...inspect_rows].flatten.to_a.map{|f| f.to_s.gsub(/(\.\d{4}).*/, "\\1") }
+        max_width = column.map{|s| s.length }.max
+        column.map!{|s| s.rjust(max_width, ' ')} + (more_rows ? ['.' * max_width] : [])
+      end.transpose
+      "#{rows} x #{columns} Matrix\nM#{box_lines(as_strings.map{|row| row.join(", ") }, more_columns)}"
+    end
+
+
+    def [](*args)
+      args.any?{|x| Range === x} ? Matrix.new(narray[*args.reverse]) : narray[*args.reverse]
+    end
+
+    def transpose
+      Matrix.new(self.matrix.transpose)
+    end
+
+    def self.new(*args, &blk)
+      result = super
+      if result.class == Matrix && (result.rows == 1 || result.columns == 1)
+        vect = V[1]
+        vect.matrix, vect.narray = result.matrix, result.narray
+        result = vect
+      end
+      result
+    end
+
+    def self.[](*inputs)
+      if inputs.length == 1 && Matrix === inputs[0]
+        inputs[0]
+      elsif inputs.length == 1 && [String, Symbol].include?(inputs[0].class)
+        Matrix.new(inputs[0])
+      else
+        Matrix.new(inputs)
+      end
+    end
+
+    def self.gen_mutator(name)
+      define_method(name) do |*args, &blk|
+        matrix.send(name, *args, &blk)
+        self
+      end
+    end
+
+    def self.gen_matrix_delegator(name)
+      define_method(name) do |*args, &blk|
+        Matrix.new(matrix.send(name, *args, &blk))
+      end
+    end
+
+    def self.gen_delegator(name)
+      define_method(name) do |*args, &blk|
+        matrix.send(name, *args, &blk)
+      end
+    end
+
+    OPERATIONS_MAP = {
+      :& => 'and',
+      :^ => 'xor',
+      :| => 'or'
+    }
+    def translate_op(op)
+      OPERATIONS_MAP.fetch(op, op)
+    end
+
+    [:fill!, :random!, :indgen!].each(&method(:gen_mutator))
+    [:reshape, :sort, :sort_index, :inverse, :lu, :delete_at, :where, :where2, :not].each(&method(:gen_matrix_delegator))
+    [:sum, :prod, :mean, :stddev, :rms, :rmsdev, :min, :max, :shape].each(&method(:gen_delegator))
+    [:+, :/, :-, :**, :&, :^, :|].each do |op|
+      define_method(op) do |other|
+        op = translate_op(op)
+        Matrix.new(
+          if other.kind_of?(Matrix)
+            apply_elementwise(op, other)
+          else
+            apply_scalar(op, other)
+          end
+        )
+      end
+    end
+
+    def self.seed(seed)
+      NArray.srand(seed)
+    end
+
+    private
+      def test_inverse
+        inverse = self.invert_next_operation
+        self.invert_next_operation = false
+        return inverse
+      end
+
+      def cofactor(i, j)
+        minor = self.minor(i, j)
+        sign = ((i * self.columns + j) % 2).zero? ? 1 : -1;
+        return sign * minor.determinant
+      end
+
+      def apply_elementwise(op, other)
+        if test_inverse
+          other.narray.send(op, self.narray)
+        else
+          narray.send(op, other.narray)
+        end
+      end
+
+      def apply_scalar(op, other)
+        if test_inverse
+          Matrix[other].narray.send(op, self.narray)
+        else
+          narray.send(op, Matrix[other].narray)
+        end
+      end
+  end
+
+  class ::NArray; include Enumerable; end
+end

data/lib/rmatrix/shortcuts.rb

@@ -0,0 +1,13 @@
+module RMatrix
+  class Matrix
+    alias_method :I, :inverse
+    alias_method :T, :transpose
+    alias_method :D, :determinant
+    alias_method :M, :minor
+    alias_method :A, :adjoint
+    alias_method :C, :cofactor_matrix
+  end
+end
+
+M = RMatrix::Matrix
+V = RMatrix::Vector

data/lib/rmatrix/vector.rb

@@ -0,0 +1,24 @@
+module RMatrix
+  class Vector < RMatrix::Matrix
+
+    def initialize(source)
+      super
+      raise "Invalid dimensions #{shape.join(?x).reverse}. Vector must be eiter Nx1 or 1xM" unless [rows, columns].include?(1) && shape.length == 2
+    end
+
+    def self.[](*inputs)
+      Vector.new(inputs)
+    end
+
+    def inspect
+      elms = narray.to_a.flatten
+      print = elms.first(10)
+      has_more = elms.length > 10
+      if rows == 1
+        "Vector(#{narray.length})\nV[#{print.join(", ") + (has_more ? ',...' : '')}]"
+      else
+        "Vector(#{narray.length})\nV[\n [#{print.join("],\n [") + (has_more ? "\n  ..." : '')}]\n]"
+      end
+    end
+  end
+end

data/lib/rmatrix/version.rb

@@ -0,0 +1,3 @@
+module Rmatrix
+  VERSION = "0.1.0"
+end

data/rmatrix.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rmatrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rmatrix"
+  spec.version       = Rmatrix::VERSION
+  spec.authors       = ["Wouter Coppieters"]
+  spec.email         = ["wouter.coppieters@youdo.co.nz"]
+
+  spec.summary       = "Fast matrix/linear algebra library for Ruby"
+  spec.description   = %Q(RMatrix is a lightning fast library for Ruby. It provides numerous enhancements over the Matrix class in the standard library.
+  Features include the ability to calculate Matrix inverse, transpose, determinant, minor, adjoint, cofactor_matrix, hadamard product and other elementwise operations, slicing, masking and more.
+  RMatrix makes use of backing instances of NArray to allow for great performance.)
+  spec.homepage      = "https://github.com/wouterken/RMatrix"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_runtime_dependency "narray"
+end

data/rmatrix.todo

@@ -0,0 +1,9 @@
+ ✔ Update print @done (16-04-06 07:40)
+ ✔ Basic matrix functions and tests @done (16-04-06 07:40)
+ ☐ Enumeration, each over columns, each over rows, each element, each reverse, each column/row reversed
+ ☐ Map to Matrix
+ ☐ Select rows
+ ☐ Select columns
+ ☐ Slice/Mask rows and columns
+ ☐ Specs
+ ☐ Float, Double, Complex, Double Complex and integer types

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rmatrix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wouter Coppieters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry
+  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: pry-byebug
+  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: narray
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  RMatrix is a lightning fast library for Ruby. It provides numerous enhancements over the Matrix class in the standard library.
+    Features include the ability to calculate Matrix inverse, transpose, determinant, minor, adjoint, cofactor_matrix, hadamard product and other elementwise operations, slicing, masking and more.
+    RMatrix makes use of backing instances of NArray to allow for great performance.
+email:
+- wouter.coppieters@youdo.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rmatrix.rb
+- lib/rmatrix/core.rb
+- lib/rmatrix/matrix.rb
+- lib/rmatrix/shortcuts.rb
+- lib/rmatrix/vector.rb
+- lib/rmatrix/version.rb
+- rmatrix.gemspec
+- rmatrix.todo
+homepage: https://github.com/wouterken/RMatrix
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Fast matrix/linear algebra library for Ruby
+test_files: []
+has_rdoc: