csrmatrix 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 842f69d5be23f5b6a2ea2057504f416eff0648f8
-  data.tar.gz: f05e25a4c9f740e9691e94bc3aeb6b4a476be910
+  metadata.gz: 8ca96a6fc0d6250a281a09c47ae5a51a0f3ed466
+  data.tar.gz: 4a1abf788a4a2c8552209bfde11346a829a42608
 SHA512:
-  metadata.gz: 767ba6ea5d5bdad6e30e986c052f93b6bd9b3822f28ee98326b132bc9010c01e3a17241ed7fe7ba558395e8853aca3fe9fd782ff36efa77fd43b0fbab825fd7c
-  data.tar.gz: 73afd742117835704942a8cf5202a1cbbd9e3c8eecf013709957191707ca38b9a5574e56082477d7ab6491b95cea71049718a4145699bfc1636c21029a83acfa
+  metadata.gz: 5a738eedcb306751917db6aef46b49b778c7614467bdebd01d3ed0a5c5149c7d78b29da69c2432840e3dbb1cec8e0a52423ae6ec1eb4b48cb944d601f60c8b55
+  data.tar.gz: 147b40740fd26c79613732e6a0ad5dcc5e43444c539e75ecc74d0f56d3e406a77044ba17bf4f974ccea7f0fd971620a66e4a6c6c46ae32c5d3de6513df5d084f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csrmatrix (1.0.1)
+    csrmatrix (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/csrmatrix.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{CSR matrix implementation for Ruby. https://github.com/Team-Aqua/Matrix-Library}
   spec.homepage      = "https://github.com/Team-Aqua/Matrix-Library/"
   spec.license       = "MIT"
 

data/lib/csrmatrix.rb

@@ -30,9 +30,43 @@ class TwoDMatrix
   include Contracts::Invariants
 
   C = Contracts
+  #These only get called post Methods with Contract Decorator
   invariant(@rows) { @rows >= 0}
   invariant(@columns) { @columns >= 0}
   invariant(:val) {self.val != nil}
+  # @nonzero_count.is_a?(array) FIXME????????? and @nonzero_count.count() >= 0 
+  # invariant(@nonzero_count) { @nonzero_count >= 0}
+  # invariant(@row_ptr) { @row_ptr.count() >= 0  and @row_ptr.is_a?(Array)}
+  # @row_pointer.is_a?(array) and @row_pointer.count() >= 0
+  # @col_ind.is_a?(array) and @col_ind.count() >= 0
+  # @val.is_a?(array) and @val.count() >= 0
+  # @dimension == 2
+
+  def is_invariant?
+    if @val == nil
+      raise InvariantError.new, "Empty Matrix"
+      return false
+    end
+    if @columns < 0
+      raise InvariantError.new, "Invalid Column Dimension"
+      return false
+    end
+    if @rows < 0
+      raise InvariantError.new, "Invalid Row Dimension"
+      return false
+    end
+    #!@nonzero_count.is_a?(Array) or IS THIS AN ARRAY?
+    # if @nonzero_count == nil
+    #   raise InvariantError.new, "Invalid Non-Zero Count"
+    #   return false
+    # end
+    # @nonzero_count.is_a?(array) and @nonzero_count.count() >= 0
+  # @row_pointer.is_a?(array) and @row_pointer.count() >= 0
+  # @col_ind.is_a?(array) and @col_ind.count() >= 0
+  # @val.is_a?(array) and @val.count() >= 0
+  # @dimension == 2
+    return true
+  end
 
   # The current website ref. Used for verification of rb systems.
   Url = "https://github.com/Team-Aqua/Matrix-Library/"
@@ -40,14 +74,6 @@ class TwoDMatrix
 
   # Blank setup; setup module.
   def initialize()	
-		# invariant
-		# @nonzero_count.is_a?(array) and @nonzero_count.count() >= 0
-		# @row_pointer.is_a?(array) and @row_pointer.count() >= 0
-		# @col_ind.is_a?(array) and @col_ind.count() >= 0
-		# @val.is_a?(array) and @val.count() >= 0
-		# @rows >= 0
-		# @columns >= 0
-		# @dimension == 2
     @nonzero_count = nil
     @row_ptr = nil
     @col_ind = nil
@@ -61,13 +87,6 @@ class TwoDMatrix
   # SPARSE MATRIX ATTRIBUTE OPERATORS 
   # matrix attributes and overloaded operators
   #
-  def is_invariant?
-    if @val == nil
-      raise InvariantError.new, "Empty Matrix"
-      return false
-    end
-    return true
-  end
 
   # equals override for matrix operations
   def ==(o)

data/lib/csrmatrix/exceptions.rb

@@ -20,5 +20,8 @@ module CsrMatrix
 
         #
         class InvariantError < StandardError; end 
+
+        class ContractReturnError < StandardError; end
+        
     end # exceptions
 end # csrmatrix

data/lib/csrmatrix/functions.rb

@@ -53,8 +53,16 @@ module CsrMatrix
         def trace()
             # identifies the trace of the matrix
             is_invariant?
-            m = Matrix.rows(self.decompose)
-            return m.trace()
+						sum = 0
+						for i in 0..self.columns-1
+							for j in self.row_ptr[i]..self.row_ptr[i+1]-1
+								if self.col_ind[j] == i
+									sum += self.val[j]
+									break
+								end
+							end
+						end
+						return sum
         end # trace
 
         Contract C::None => Contracts::Num

data/lib/csrmatrix/operations.rb

@@ -1,75 +1,123 @@
 require "csrmatrix/exceptions"
 
 module CsrMatrix
-    module Operations
-        include Contracts::Core
-        C = Contracts
+  module Operations
+    include Contracts::Core
+    C = Contracts
 
-        Contract C::Nat => C::Num
-        def get_value(index)
-            # gets the value off of the index of matrix
-            is_invariant?
-            return @val[index]
-        end # get_value
+    Contract C::Num, C::Nat, C::Nat => C::Bool
+    def insert(value, row, column)
+      # gets the value off of the index of matrix
+      is_invariant?
+      # post value inserted or updated in the given row and column 
+    
+      # insert if the value exists
+      for i in self.row_ptr[row-1]..self.row_ptr[row]-1
+        if column-1 == self.col_ind[i]
+          self.val[i] = value
+          return true
+        end
+      end
 
-        Contract C::Nat, C::Or[C::Nat, nil] => C::Num 
-        def index(row, col=nil)
-            # gets the index in the matrix at row, col
-            is_invariant?
-                
-            if col == nil
-                if @val.count < row
-                  raise CsrMatrix::Exceptions::IndexOutOfRangeException.new, "Index out of Bounds"
-                  return false
-                end
+      # add value if it does not exist
+      for i in self.columns-1..0
+        index = self.row_ptr[row]-1 + i
+        if self.col_ind[index] < column-1
+          #add value
+          self.col_ind.insert(index+1, column-1)
+          self.val.insert(index+1, value)
+          
+          #increment row pointers
+          for j in row..self.row_ptr.count()-1
+            self.row_ptr[j] += 1
+          end
 
-              return @val[row-1]
-            else
-              if !checkInputBounds(row, col)
-                raise CsrMatrix::Exceptions::IndexOutOfRangeException.new, "Index out of Bounds"
-                return false
-              end
+          return true
+        end
+      end
 
-              num_elm_in_prev = row_ptr[row-1]
-              num_elm_in_row = row_ptr[row] - num_elm_in_prev
-                
-              (0...num_elm_in_row).each do | x |
-                if ( col-1 == @col_ind[num_elm_in_prev+x] )
-                  return @val[num_elm_in_prev+x]
-                end
-              end
-              return 0
+      #add value
+      self.col_ind.insert(self.row_ptr[row]-1, column-1)
+      self.val.insert(self.row_ptr[row]-1, value)
+
+      #increment row pointers
+      for j in row..self.row_ptr.count()-1
+        self.row_ptr[j] += 1
+      end             
+      return true
+
+      #post
+      if self.index(row, column) != value
+        raise ContractReturnError.new "index not as expected"
+      end
+    end # insert
+    
+    Contract C::Nat => C::Num
+    def get_value(index)
+        # gets the value off of the index of matrix
+        is_invariant?
+        return @val[index]
+    end # get_value
+
+    Contract C::Nat, C::Or[C::Nat, nil] => C::Num 
+    def index(row, col=nil)
+        # gets the index in the matrix at row, col
+        is_invariant?
+            
+        if col == nil
+            if @val.count < row
+              raise CsrMatrix::Exceptions::IndexOutOfRangeException.new, "Index out of Bounds"
+              return false
             end
-        end # index
 
-        Contract C::None => C::Any
-        def print_full()
-            # prints the full matrix for user
-            is_invariant?
-            full_matrix = self.decompose()
-            full_matrix.each do | row |
-                row.each do | val |
-                    print "#{val}  "
-                end
-                puts ""
+          return @val[row-1]
+        else
+          if !checkInputBounds(row, col)
+            raise CsrMatrix::Exceptions::IndexOutOfRangeException.new, "Index out of Bounds"
+            return false
+          end
+
+          num_elm_in_prev = row_ptr[row-1]
+          num_elm_in_row = row_ptr[row] - num_elm_in_prev
+            
+          (0...num_elm_in_row).each do | x |
+            if ( col-1 == @col_ind[num_elm_in_prev+x] )
+              return @val[num_elm_in_prev+x]
             end
-        end # print_full
+          end
+          return 0
+        end
+    end # index
+
+    Contract C::None => C::Any
+    def print_full()
+      # prints the full matrix for user
+      is_invariant?
+      full_matrix = self.decompose()
+      full_matrix.each do | row |
+          row.each do | val |
+              print "#{val}  "
+          end
+          puts ""
+      end
+      puts ""
+    end # print_full
 
-        Contract C::None => C::Any
-        def print_sparse()
-            # prints all nonzero values of matrix for user
-            is_invariant?
-            full_matrix = self.decompose()
-            full_matrix.each do | row |
-                row.each do | val |
-                    if val == 0
-                        print "---"
-                    else
-                        print " #{val} "    
-                    end
+    Contract C::None => C::Any
+    def print_sparse()
+        # prints all nonzero values of matrix for user
+        is_invariant?
+        full_matrix = self.decompose()
+        full_matrix.each do | row |
+            row.each do | val |
+                if val == 0
+                    print "---"
+                else
+                    print " #{val} "    
                 end
-                puts ""
             end
-        end # print_sparse   
-    end # Operations
+            puts ""
+        end
+    end # print_sparse   
+  end # Operations
 end # CsrMatrix

data/lib/csrmatrix/version.rb

@@ -1,3 +1,3 @@
 module CsrMatrix
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csrmatrix
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Anson Li, Quentin Lautischer, Aaron Plamondon
@@ -52,10 +52,7 @@ dependencies:
     - - "~>"
       - !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.'
+description: CSR matrix implementation for Ruby. https://github.com/Team-Aqua/Matrix-Library
 email:
 - hello@teamaqua.ca
 executables: []
@@ -86,6 +83,7 @@ files:
 - lib/csrmatrix/properties.rb
 - lib/csrmatrix/version.rb
 - pkg/csrmatrix-1.0.0.gem
+- pkg/csrmatrix-1.0.1.gem
 homepage: https://github.com/Team-Aqua/Matrix-Library/
 licenses:
 - MIT