csrmatrix 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5239814e3bf4d761150bacbe7d8fa44ca321446d
+  data.tar.gz: 6f72c0b95e218e513b7372e1264054ea33c36ad2
+SHA512:
+  metadata.gz: 0f1313cec202a6ca9d303229629615d0422342847e1b1f1e446c704f806b1aecf574c2945ae51e93158387dba3a020e992f9e3983b4aafa7d23b911060b9a566
+  data.tar.gz: 1734545e1f6a6f2387466768bd62896757935deb648f002077e84bce4b972928f67c5a7af678cd8ad503fbe0d1300bc33b820b83fcd35296305dbdb04bfc16e4

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ansonli.94@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in matrix.gemspec
+gem "minitest"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    csrmatrix (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    minitest (5.8.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  csrmatrix!
+  minitest
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anson Li, Quentin Lautischer, Aaron Plamondon
+
+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 @@
+# Matrix
+
+Welcome to the Matrix gem! This gem is designed to offer high-performance, efficient processes for sparse matrix processes.
+
+If you want to try it out, install the gem and run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'matrix'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install matrix
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Team-Aqua/Matrix-Library/tree/master/matrix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "matrix"
+require "csrmatrix"
+
+# 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"
+IRB.start

data/bin/matrix

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'csrmatrix'
+
+puts csrmatrix::Url

data/bin/setup

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

data/csrmatrix.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csrmatrix/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csrmatrix"
+  spec.version       = CsrMatrix::VERSION
+  spec.authors       = ["Anson Li, Quentin Lautischer, Aaron Plamondon"]
+  spec.email         = ["hello@teamaqua.ca"]
+
+  spec.summary       = %q{Efficient sparse matrix library.}
+  spec.description   = %q{Generation of a sparse matrix package in order to satisfy: 1. Reusability - insofar that the system can be reused for different structures; 2. Efficiency - in both storage and runtime; 3. Light - we need lightweight process stuctures in order to reduce overhead to a minimum.}
+  spec.homepage      = "https://github.com/Team-Aqua/Matrix-Library/"
+  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'] = "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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/csrmatrix/arithmetic.rb

@@ -0,0 +1,241 @@
+require "matrix"
+require "csrmatrix/exceptions"
+
+module CsrMatrix    
+  module Arithmetic
+
+    def self.included(exceptions)
+      exceptions.send :include, Exceptions
+    end
+
+    # class MatrixDimException < StandardError; end      
+    # class ArgumentNullException < StandardError; end
+    # class MatrixTypeException < StandardError; end     
+
+    # REFERENCE: To use module functions in module
+    # Class.new.extend(Decompositions).lup()
+
+    def scalar_multiply(value)
+      if value == nil
+        raise ArgumentNullException.new, "Multiply by nil error."
+        return false
+      end
+      @val.each_index do |i|
+        @val[i] = @val[i] * value
+      end
+    end
+    
+    def scalar_add(value)
+      if value == nil
+        raise ArgumentNullException.new, "Add by nil error."
+        return false
+      end
+      # create an identity matrix with the value
+      # matrix_add the new identity matrix to the given matrix
+      @val.each_index do |i|
+        @val[i] = @val[i] + value
+      end
+    end
+
+    def scalar_subtract(value)
+      if value == nil
+        raise ArgumentNullException.new, "Subtract by nil error."
+        return false
+      end
+      # create an identity matrix with the value
+      # matrix_subtract the new identity matrix to the given matrix
+      @val.each_index do |i|
+        @val[i] = @val[i] - value
+      end
+    end
+
+    def scalar_division(value)
+      if value == nil
+        raise ArgumentNullException.new, "Divide by nil error."
+        return false
+      end
+      @val.each_index do |i|
+        @val[i] = @val[i] / value.to_f
+      end
+    end
+
+    def scalar_exp(value)
+      if value == nil
+        raise ArgumentNullException.new, "Exp. by nil error."
+        return false
+      end
+      @val.each_index do |i|
+        @val[i] = @val[i] ** value
+      end
+    end
+
+    def inverse()
+      m = Matrix.rows(self.decompose)
+      self.build_from_array(m.inv().to_a())
+    end
+
+    # FIXME: Convert with CSR functions
+    def transpose()
+      m = Matrix.rows(self.decompose)
+      self.build_from_array(m.transpose.to_a())
+    end
+
+    def t()
+      self.transpose()
+    end
+
+    def matrix_vector(vector) 
+      # dev based on http://www.mathcs.emory.edu/~cheung/Courses/561/Syllabus/3-C/sparse.html
+      result = Array.new(vector.length, 0)
+      i = 0
+      while i < vector.length do
+        k = @row_ptr[i]
+        while k < @row_ptr[i+1] do
+          result[i] = result[i] + @val[k] * vector[@col_ind[k]]
+          k += 1
+        end
+        i += 1
+      end   
+      return result
+    end   
+
+    # dev based on http://stackoverflow.com/questions/29598299/csr-matrix-matrix-multiplication
+    # multiply dense (non-dense) matrix to csr matrix [eg. [1, 2]] x 2d array
+    # key: the dense matrix is LEFT SIDE, the csr matrix is RIGHT SIDE
+    def matrix_multiply(matrix)
+      # matrix order, assumes both matrices are square
+      res = Array.new(max_row(matrix)) { Array.new(@columns, 0) } # first denotes row, second denotes columns
+      n = matrix.length
+      i = 0
+      # res = dense X csr
+      csr_row = 0 # Current row in CSR matrix
+      while i < n do
+        startv = @row_ptr[i] 
+        endv = @row_ptr[i + 1]
+        j = startv
+        while j < endv do
+          col = @col_ind[j]
+          csr_value = @val[j]
+          k = 0
+          while k < n do
+            dense_value = matrix[k][csr_row]
+            res[k][col] += csr_value * dense_value
+            k += 1
+          end
+          j += 1
+        end
+        csr_row += 1
+        i += 1
+      end
+      return res
+    end
+
+    # multiply two csr together - ref: http://www.mcs.anl.gov/papers/P5007-0813_1.pdf
+    def multiply_csr(matrix)
+      return matrix.matrix_multiply(self.decompose())
+    end 
+
+    # helper function to determine deim count is equal
+    def is_same_dim(matrix)
+      return self.dimensions() == matrix.dimensions()
+    end
+
+    def matrix_add(matrix)
+      if self.is_same_dim(matrix)
+        res = Array.new(@rows) { Array.new(@columns, 0) }
+        row_idx = 0
+        cnta = 0 # total logged entries for matrix a 
+        cntb = 0
+        while row_idx < @rows # eg. 0 1 2
+          rowa = @row_ptr[row_idx + 1] # eg. 0 2 4 7
+          rowb = matrix.row_ptr[row_idx + 1]
+          while cnta < rowa
+            # keep adding values to res until they're equal
+            res[row_idx][@col_ind[cnta]] += @val[cnta]
+            cnta += 1;
+          end
+          while cntb < rowb
+            res[row_idx][@col_ind[cntb]] += matrix.val[cntb]
+            cntb += 1;
+          end  
+          row_idx += 1;
+        end
+        return res
+      end 
+      raise Exceptions::MatrixDimException.new, "Matrix does not have same dimensions; cannot add."
+      return false
+    end
+
+    def matrix_subtract(matrix)
+      if self.is_same_dim(matrix)
+        res = Array.new(@rows) { Array.new(@columns, 0) }
+        row_idx = 0
+        cnta = 0 # total logged entries for matrix a 
+        cntb = 0
+        while row_idx < @rows # eg. 0 1 2
+          rowa = @row_ptr[row_idx + 1] # eg. 0 2 4 7
+          rowb = matrix.row_ptr[row_idx + 1]
+          while cnta < rowa
+            # keep adding values to res until they're equal
+            res[row_idx][@col_ind[cnta]] += @val[cnta]
+            cnta += 1;
+          end
+          while cntb < rowb
+            res[row_idx][@col_ind[cntb]] -= matrix.val[cntb]
+            cntb += 1;
+          end  
+          row_idx += 1;
+        end
+        return res
+      end 
+      raise Exceptions::MatrixDimException.new, "Matrix does not have same dimensions; cannot subtract."
+      return false
+    end
+
+    # multiply y by x^-1; y * x^-1
+    # FIXME: Possibly consider rewording for context:
+    def matrix_left_division(matrix)
+      if !matrix.is_a?(TwoDMatrix)
+        raise Exceptions::MatrixTypeException.new, "Matrix is not usable type."
+        return false
+      end
+      if !matrix.square? || !self.square?
+        raise Exceptions::MatrixDimException.new, "Matrices does not have usable dimensions; cannot divide."
+        return false
+      end
+      tmpmatrix = TwoDMatrix.new
+      tmpmatrix = matrix
+      tmpmatrix.inverse()
+      return self.multiply_csr(tmpmatrix)
+    end
+
+    # multiply x by y^-1; x * y^-1 
+    # FIXME: Possibly consider rewording for context: not doing x / y; doing x * y^-1
+    def matrix_right_division(matrix)
+      if !matrix.is_a?(TwoDMatrix)
+        raise Exceptions::MatrixTypeException.new, "Matrix is not usable type."
+        return false
+      end
+      if !matrix.square? || !self.square?
+        raise Exceptions::MatrixDimException.new, "Matrices does not have usable dimensions; cannot divide."
+        return false
+      end
+      tmpmatrix = TwoDMatrix.new
+      tmpmatrix = self
+      tmpmatrix.inverse()
+      return matrix.multiply_csr(tmpmatrix)
+    end
+
+    # Identifies the 'row' value of an array (eg. the number of entries in a row)
+    # Helper function, will clean after.
+    def max_row(array)
+      values = array
+      max_count = 0
+      values.each_index do |i|
+        max_count += 1
+      end
+      return max_count
+    end
+
+  end 
+end

data/lib/csrmatrix/decompositions.rb

@@ -0,0 +1,22 @@
+module CsrMatrix
+    module Decompositions
+
+        def eigen()
+            eigensystem()
+        end
+        
+        def eigensystem()
+            m = Matrix.rows(self.decompose)
+            return m.eigensystem().to_a[0].to_a
+        end
+        
+        def lup()
+            puts "lup"
+        end
+        
+        def lup_decomposition()
+
+        end
+        
+    end
+end

data/lib/csrmatrix/exceptions.rb

@@ -0,0 +1,11 @@
+module CsrMatrix
+    module Exceptions
+        class NullMatrixException < StandardError; end     
+        class MatrixDimException < StandardError; end      
+        class ArithmeticException < StandardError; end     
+        class MatrixTypeException < StandardError; end     
+        class DivideByZeroException < StandardError; end   
+        class IndexOutOfRangeException < StandardError; end
+        class ArgumentNullException < StandardError; end   
+    end
+end

data/lib/csrmatrix/functions.rb

@@ -0,0 +1,33 @@
+module CsrMatrix
+    module Functions
+        
+        def determinant()
+            m = Matrix.rows(self.decompose)
+            m.det()
+        end
+
+        def det()
+            self.determinant()
+        end
+
+        def rank()
+            m = Matrix.rows(self.decompose)
+            m.rank()
+        end
+
+        def round(ndig = 0)
+            m = Matrix.rows(self.decompose)
+            self.build_from_array(m.round(ndig).to_a())
+        end
+
+        def trace()
+            m = Matrix.rows(self.decompose)
+            m.trace()
+        end
+
+        def tr()
+            self.trace()
+        end
+
+    end
+end

data/lib/csrmatrix/helpers.rb

@@ -0,0 +1,77 @@
+module CsrMatrix
+  module Helpers
+  	
+		##
+		# ARRAY FUNCTIONS
+		# for pre-processing of matrix
+		#
+
+		# Identifies the 'column' value of an array (eg. the number of entries in a column)
+		def max_col(array)
+			values = array
+			max_count = 0
+			# Loop over indexes.
+			values.each_index do |i|
+				counter = 0
+			  # Get subarray and loop over its indexes also.
+			  subarray = values[i]
+			  subarray.each_index do |x|
+			  	counter += 1
+			  end
+			  if counter > max_count
+			  	max_count = counter
+			  end
+			end
+			return max_count
+		end
+
+		# Identifies the 'row' value of an array (eg. the number of entries in a row)
+		def max_row(array)
+			values = array
+			max_count = 0
+			values.each_index do |i|
+			  max_count += 1
+			end
+			return max_count
+		end
+
+		def count_nonzero(array) 
+			max_count = 0
+			array.each_index do |i|
+				subarray = array[i]
+			  subarray.each_index do |x|
+			  	if array[i][x] != 0
+			  		max_count += 1
+			  	end
+			  end
+			end
+			return max_count
+		end
+
+		# Code taken from http://stackoverflow.com/questions/9545613/getting-dimension-of-multidimensional-array-in-ruby
+		def depth(array)
+	    return 0 if array.class != Array
+			result = 1
+			array.each do |sub_a|
+			  if sub_a.class == Array
+			    dim = depth(sub_a)
+			    result = dim + 1 if dim + 1 > result
+			  end
+			end
+			return result
+		end	
+
+		# Counts all elements in array - assumed 2d
+    def count_total(array) 
+      max_count = 0
+      array.each_index do |i|
+        subarray = array[i]
+        subarray.each_index do |x|
+          max_count += 1
+        end
+      end
+      return max_count
+    end
+	
+  end
+end

data/lib/csrmatrix/operations.rb

@@ -0,0 +1,33 @@
+module CsrMatrix
+    module Operations
+        def get_value(index)
+            return @val[index]
+        end
+
+        def print_full()
+            (0...@col_ind.length).each do |iter|
+                (0...@col_ind.length).each do |col|
+                    if (iter == @row_ptr[iter] and col == @col_ind[iter])
+                        print "#{get_value(iter)}  "
+                    else
+                        print "0  "
+                    end
+                end
+                puts ""
+            end    
+        end
+
+        def print_sparse()
+            (0...@col_ind.length).each do |iter|
+                (0...@col_ind.length).each do |col|
+                    if (iter == @row_ptr[iter] and col == @col_ind[iter])
+                        print "#{get_value(iter)}  "
+                    else
+                        print "0  "
+                    end
+                end
+                puts ""
+            end
+        end    
+    end
+end

data/lib/csrmatrix/properties.rb

@@ -0,0 +1,98 @@
+module CsrMatrix
+    module Properties
+
+        def self.included(exceptions)
+          exceptions.send :include, Exceptions
+        end 
+        
+        # Determines if the matrix is diagonal; wherein the values outside the main diagonal are all zero.
+        def diagonal?
+            m = Matrix.rows(self.decompose)
+            return m.diagonal?
+        end
+
+        # Determines if the matrix is empty; wherein all the values are zero.
+        def empty?
+            m = Matrix.rows(self.decompose)
+            return m.empty?
+        end
+
+        # Determine if the matrix is hermitian.
+        def hermitian?
+            m = Matrix.rows(self.decompose)
+            return m.hermitian?
+        end
+
+        # Determines if the matrix is lower-diagonal; wherein all the values only exist on and below the diagonal line.
+        def lower_triangular?
+            m = Matrix.rows(self.decompose)
+            return m.lower_triangular?
+        end
+
+        # Determines if the matrix is normal; wherein if the number of rows or columns is 0
+        def normal? 
+            m = Matrix.rows(self.decompose)
+            return m.normal?
+        end
+
+        # Determines if the matrix is orthogonal; wherein the rows and columns are orthogonal unit vectors.
+        def orthogonal?
+            m = Matrix.rows(self.decompose)
+            return m.orthogonal?
+        end
+
+        # Determines if the matrix is a permutation; wherein it is an nxn version of the identity matrix.
+        def permutation?
+            m = Matrix.rows(self.decompose)
+            return m.permutation?
+        end
+
+        # Determines if the matrix is real; wherein the matrix consists entirely of real numbers.
+        def real?
+            m = Matrix.rows(self.decompose)
+            return m.real?
+        end
+
+        # Determines if the matrix is nonsingular
+        def nonsingular?
+            return !self.singular?
+        end
+
+        # Determines if the matrix is singular
+        def singular?
+            m = Matrix.rows(self.decompose)
+            return m.singular?
+        end
+
+        # Determines if the matrix is square
+        def square?
+            m = Matrix.rows(self.decompose)
+            return m.square?
+        end
+
+        # Determines if the matrix is symmetric
+        def symmetric?
+            m = Matrix.rows(self.decompose)
+            return m.symmetric?
+        end
+
+        # Determines if the matrix is unitary
+        def unitary?
+            m = Matrix.rows(self.decompose)
+            return m.unitary?
+        end
+
+        # Determines if the matrix is upper-triangular
+        def upper_triangular?
+            m = Matrix.rows(self.decompose)
+            return m.upper_triangular?
+        end
+
+        # Determines if the matrix is zero
+        def zero?
+            m = Matrix.rows(self.decompose)
+            return m.zero?
+        end
+
+    end
+end

data/lib/csrmatrix/version.rb

@@ -0,0 +1,3 @@
+module CsrMatrix
+  VERSION = "1.0.0"
+end

data/lib/csrmatrix.rb

@@ -0,0 +1,217 @@
+require "csrmatrix/version"
+require "csrmatrix/properties"
+require "csrmatrix/arithmetic"
+require "csrmatrix/functions"
+require "csrmatrix/decompositions"
+require "csrmatrix/operations"
+require "csrmatrix/helpers"
+require "csrmatrix/exceptions"
+
+module CsrMatrix
+  # The current website ref. Used for verificationn of rb systems.
+  Url = "https://github.com/Team-Aqua/Matrix-Library/"
+end
+
+# General code convention in this manner - generate documentation via 'rdoc lib'.
+class TwoDMatrix
+  #Need to ensure we include Object Class overwrites.
+  include CsrMatrix::Operations
+  include CsrMatrix::Properties
+  include CsrMatrix::Arithmetic
+  include CsrMatrix::Functions
+  include CsrMatrix::Decompositions
+  include CsrMatrix::Helpers
+  include CsrMatrix::Exceptions
+
+  # The current website ref. Used for verification of rb systems.
+  Url = "https://github.com/Team-Aqua/Matrix-Library/"
+  attr_reader :row_ptr, :col_ind, :val, :rows, :columns, :ndim
+
+  # Blank setup; setup module.
+  def initialize()
+    @nonzero_count = nil
+    @row_ptr = nil
+    @col_ind = nil
+    @val = nil
+    @rows = 0
+    @columns = 0
+    @ndim = 2
+  end
+
+  ##
+  # SPARSE MATRIX ATTRIBUTE OPERATORS 
+  # matrix attributes and overloaded operators
+  #
+
+  # equals override for matrix operations
+  def ==(o)
+    o.class == self.class && o.state == state
+  end
+
+  # FIXME: convert to protected value
+  def state
+    [@val, @row_ptr, @col_ind, @rows, @columns, @ndim]
+  end
+
+  # Finds column and row value of an array. 
+  def dimensions()
+    return [@rows, @columns]
+  end
+  
+  def square?
+    return self.rows == self.columns
+  end
+
+  ##
+  # MATRIX DECOMPOSITION FUNCTIONS
+  #
+
+  def decompose()
+    res = Array.new(@rows) { Array.new(@columns, 0) }
+    row_counter = 0
+    row_idx = 0
+    @row_ptr.drop(1).each do |i| #eg. 2 4 7 10
+      while row_counter < i 
+        res[row_idx][@col_ind[row_counter]] = @val[row_counter]
+        row_counter += 1
+      end 
+      row_idx += 1
+    end
+    return res
+  end
+
+  ##
+  # MATRIX GENERATION FUNCTIONS 
+  # generation of csr matrix
+  #
+
+  # Builds when given a 2d array to CSR
+  def build_from_array(array)
+    if array.is_a?(Array)
+      if depth(array) == 2
+        if same_sublength(array)
+          dimensions = convert_to_csr(array)
+          @columns = dimensions[0]
+          @rows = dimensions[1]
+          nonzero_count = dimensions[2] # FIXME: consider removing
+          @val = dimensions[3]
+          @row_ptr = dimensions[4]
+          @col_ind = dimensions[5]
+          return true
+        end
+        raise MatrixDimException.new, "Invalid row/column pairs imported."
+        return false
+      end
+      raise MatrixDimException.new, "Invalid dimensions."
+      return false
+    end
+    raise MatrixTypeException.new, "Wrong type convert to matrix"
+  end 
+
+  # imports a matrix from a matrix library
+  def build_from_matrix(matrix)
+    if matrix.is_a?(Matrix)
+      build_from_array(matrix.to_a())
+      return true
+    end
+    raise MatrixTypeException.new, "Wrong type convert to matrix."
+  end 
+
+  # builds a matrix given its rows
+  def build_from_rows(array)
+    build_from_array(array)
+    self.transpose()
+  end
+
+
+  # builds a matrix given its columns ;; redirect to array build
+  def build_from_columns(array)
+    self.build_from_array(array)
+  end   
+
+  # generates an identity matrix
+  def build_identity_matrix(size)
+    # FIXME: test code: replace with CSR identity gen
+    if size.is_a?(Numeric)
+      self.build_from_array(Matrix.identity(size).to_a())
+      return true
+    end
+    raise MatrixTypeException.new, "Wrong type convert to matrix."
+    return false
+  end
+
+  # generates a zero matrix
+  def build_zero_matrix(rows, columns = rows)
+    # FIXME: test code: replace with CSR zero gen
+    if rows.is_a?(Numeric) && columns.is_a?(Numeric)
+      self.build_from_array(Matrix.zero(rows, columns).to_a())
+      return true
+    end
+    raise MatrixTypeException.new, "Wrong type convert to matrix."
+    return false
+  end
+
+  # Builds array using user-generated CSR values
+  def build_from_csr(row_ptr, col_ind, val, col_siz, row_siz)
+    # generate 
+    @val = val
+    @row_ptr = row_ptr
+    @col_ind = col_ind
+    @rows = row_siz
+    @columns = col_siz
+  end
+
+  # ensures that all subarrays are of same length
+  def same_sublength(array)
+    testLength = array[0].length
+    array.each do |subarray|
+      if(subarray.length != testLength)
+          return false
+      end
+    end
+    return true
+  end
+
+  # Finds the column count, row count and non-zero values in one loop. 
+  def convert_to_csr(array)
+    row_count = 0
+    col_count = 0
+    nonzero_count = 0
+
+    row_val = 0
+    row_prev_sum = 0
+
+    col_val = 0
+
+    value_array = Array.new
+    row_ptr = Array.new
+    col_ind = Array.new
+    
+    array.each_index do |i| # each row
+      col_val = 0 # eg. for pos [0, 1, 2, 3] it goes 0, 1, 2, 3
+      col_tmp = 0
+      row_count += 1
+      row_prev_sum = row_val
+      row_ptr << row_prev_sum # ref: http://op2.github.io/PyOP2/linear_algebra.html
+      subarray = array[i]
+      subarray.each_index do |x| # each column entry in row
+        col_tmp += 1
+        if array[i][x] != 0
+          # use nonzero value in CSR
+          nonzero_count += 1
+          value_array << array[i][x]
+          col_ind << col_val
+          row_val += 1
+        end
+        col_val += 1 # eg. col_val add at the end
+      end
+      if col_tmp >= col_count
+        col_count = col_tmp
+      end
+    end
+    row_prev_sum = row_val
+    row_ptr << row_prev_sum
+    return [col_count, row_count, nonzero_count, value_array, row_ptr, col_ind]
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: csrmatrix
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anson Li, Quentin Lautischer, Aaron Plamondon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Generation of a sparse matrix package in order to satisfy: 1. Reusability
+  - insofar that the system can be reused for different structures; 2. Efficiency
+  - in both storage and runtime; 3. Light - we need lightweight process stuctures
+  in order to reduce overhead to a minimum.'
+email:
+- hello@teamaqua.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/matrix
+- bin/setup
+- csrmatrix.gemspec
+- lib/csrmatrix.rb
+- lib/csrmatrix/arithmetic.rb
+- lib/csrmatrix/decompositions.rb
+- lib/csrmatrix/exceptions.rb
+- lib/csrmatrix/functions.rb
+- lib/csrmatrix/helpers.rb
+- lib/csrmatrix/operations.rb
+- lib/csrmatrix/properties.rb
+- lib/csrmatrix/version.rb
+- pkg/csrmatrix-1.0.0.gem
+homepage: https://github.com/Team-Aqua/Matrix-Library/
+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.6
+signing_key: 
+specification_version: 4
+summary: Efficient sparse matrix library.
+test_files: []