hamster-matrix 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9c57bcfcd225a6ca7bfb04bae733b1e425bc5ed
-  data.tar.gz: 29cf5ba08be8187bbbd61b8f04202618c6f815fd
+  metadata.gz: 9bc54527b6b284657666b4c78c03ed4d27d1714a
+  data.tar.gz: 30ea819a454e9e9e1e1732f28f11cbcfab7d3de4
 SHA512:
-  metadata.gz: f8ac30643511bfceaab242dd3e7c77081968473d6c73f8210615b58ddd56e75c3c430513cca76f7ed72400bc188ae5b31f0705a409db5be4f03ac90af5903444
-  data.tar.gz: fab9518ebfb0dba3f762c4cb56ae783831bb1f80a4ac4a549b49d293c611300e51df4259594be73d5220d19332e818b2a36a534161f32ad114cb9ba22cc7f6e5
+  metadata.gz: 00fdb59e5a2bc64efa0012907ed8dd34cf3167e185d4e7eddc1139d8f9e49b2691f5560e6b36209623c2fdc5446a2b07eac813f9761f49543b199621aaba8682
+  data.tar.gz: 221058ecedfe5f524b77883f306d5f860068882231cd7ad71cb839537472182ed429d61180fb54510fc179ed90e0a8c20e70eae0a97fa0e13969b930fcf3fea7

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    hamster-matrix (0.9.5)
-      hamster (~> 1.0)
+    hamster-matrix (2.0.0)
+      hamster (>= 1.0.0, < 3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,9 +2,9 @@
 
 # Hamster Matrix
 
-Hamster Matrix is a gem providing a persietent immutable matrix for functional programming in Ruby. It is an extension for the popular [Hamster](https://github.com/hamstergem/hamster/) gem, using Hamster [Vectors](http://www.rubydoc.info/github/hamstergem/hamster/master/Hamster/Vector) under the hood.  
+Hamster Matrix is a gem providing a persistent immutable matrix for functional programming in Ruby. It is an extension for the popular [Hamster](https://github.com/hamstergem/hamster/) gem. It creates a matrix by using nested Hamster [Vectors](http://www.rubydoc.info/github/hamstergem/hamster/master/Hamster/Vector).  
 
-It's great for using as a board in 2D video games where the matrix must be modified as the game state changes while leaving references to the old state unchanged, such as when using a time-travelling debugger. It copies the interface from Ruby's [Matrix](http://ruby-doc.org/stdlib-2.0.0/libdoc/matrix/rdoc/Matrix.html) class as much as possible.
+It's great for keeping the board state in 2D video games, where the state must be modified while leaving references to the old state unchanged, such as when using a time travelling debugger or implementing undo functionality. It copies the interface from Ruby's [Matrix](http://ruby-doc.org/stdlib-2.0.0/libdoc/matrix/rdoc/Matrix.html) class as much as possible.
 
 
 ## Installation
@@ -40,6 +40,48 @@ puts a
 # [0, 0, 1]]
 ```
 
+Implements the following methods replicating the behavior of Ruby's [Matrix](http://ruby-doc.org/stdlib-2.0.0/libdoc/matrix/rdoc/Matrix.html) class as closely as possible
+
+### Class Methods
+ - []
+ - identity
+ - build
+ - column_vector
+ - columns
+ - diagonal
+ - I
+ - identity
+ - row_vector
+ - rows
+ - scalar
+ - unit
+
+### Instance Methods
+ - ==
+ - []
+ - collect
+ - column
+ - column_count
+ - column_size
+ - column_vectors
+ - component
+ - element
+ - empty?
+ - get
+ - hash
+ - inspect
+ - map
+ - row
+ - row_count
+ - row_size
+ - row_vectors
+ - set
+ - square?
+ - to_a
+ - to_matrix
+ - to_s
+ - zero?
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bradurani/hamster-matrix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/hamster-matrix.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency 'hamster', '~> 1.0'
+  spec.add_runtime_dependency 'hamster',  ['>= 1.0.0', '< 3.0']
 end

data/lib/hamster/matrix.rb

@@ -17,41 +17,49 @@ module Hamster
       Hamster::Matrix.new(array)
     end
 
+    # @return [Hamster::Matrix]
     def self.identity(n)
       return new if n == 0
       new(::Matrix.identity(n).row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.build(row_count, column_count = row_count, &block)
       matrix = ::Matrix.build(row_count, column_count, &block)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.column_vector(array)
       matrix = ::Matrix.column_vector(array)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.columns(array)
       matrix = ::Matrix.columns(array)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.diagonal(*array)
       matrix = ::Matrix.diagonal(*array)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.row_vector(row)
       matrix = ::Matrix.row_vector(row)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.rows(row)
       matrix = ::Matrix.rows(row)
       new(matrix.row_vectors)
     end
 
+    # @return [Hamster::Matrix]
     def self.scalar(n, value)
       matrix = ::Matrix.scalar(n, value)
       new(matrix.row_vectors)
@@ -62,19 +70,20 @@ module Hamster
       alias_method :unit, :identity
     end
 
-    def initialize(array = Hamster.vector)
+    def initialize(array = Hamster::Vector[])
       enumerable_check!(array)
       width = nil
-      @row_vectors = Hamster.vector(*array.map do |a| 
+      @row_vectors = Hamster::Vector[*array.map do |a| 
         enumerable_check!(a)
         width ||= a.size
         unless(width == a.size)
           raise ExceptionForMatrix::ErrDimensionMismatch.new("row size differs (#{a.size} should be #{width})")
         end
-        Hamster.vector(*a) 
-      end)
+        Hamster::Vector[*a] 
+      end]
     end
 
+    # @return Boolean
     def ==(other)
       return false unless other.is_a? Hamster::Matrix
       self.row_vectors == other.row_vectors
@@ -101,7 +110,6 @@ module Hamster
     #   # [[1, 0, 0]
     #   #  [0, 1, 0]
     #   #  [0, 0, "foo"]]
-
     #   puts a
     #   # [[1, 0, 0]
     #   #  [0, 1, 0]
@@ -120,16 +128,19 @@ module Hamster
       Hamster::Matrix.new(row_vectors.set(i, new_row))
     end
 
+    # @return [Hamster::Vector]
     def row(i)
       row_vectors[i]
     end
 
+    # @return [Fixnum]
     def column_count
       return 0 if row_vectors.size == 0
       return row_vectors.first.size
     end
     alias_method :column_size, :column_count
 
+    # @return [Fixnum]
     def row_count
       return row_vectors.size
     end
@@ -142,22 +153,27 @@ module Hamster
     end
     alias_method :map, :collect
 
+    # @return [Fixnum]
     def column(n)
       row_vectors.map { |row| row[n] }
     end
 
+    # @return [Hamster::Vector]
     def column_vectors
-      Hamster.vector(*(0..row_vectors.size).map { |n| column(n) })
+      Hamster::Vector[*(0..row_vectors.size).map { |n| column(n) }]
     end
 
+    # @return [Boolean]
     def empty?
       row_vectors.size == 0
     end
 
+    # @return [Hash]
     def hash
       row_vectors.hash
     end
 
+    # @return [String]
     def inspect
       if empty?
         "#{self.class}.empty"
@@ -166,28 +182,34 @@ module Hamster
       end
     end
 
+    # @return [Boolean]
     def square?
       row_count == column_count
     end
 
+    # @return [Array]
     def to_a
       row_vectors.map { |row| row.to_a }.to_a
     end
 
+    # @return [String]
     def to_s
       row_string(1)
     end
 
+    # @return [::Matrix]
     def to_matrix
       ::Matrix[to_a]
     end
 
+    # @return [Boolean]
     def zero?
       row_vectors.all? do |row| 
         row.all? { |elem| elem.is_a?(Numeric) && elem.zero? }
       end
     end
 
+    # @return [Hamster::Vector]
     attr_reader :row_vectors
 
     private

data/lib/hamster/version.rb

@@ -1,5 +1,5 @@
 module Hamster
   class Matrix
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hamster-matrix
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Brad Urani
@@ -56,16 +56,22 @@ dependencies:
   name: hamster
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 description: Immutable persistent matrix using Hamster that aims to copy as much of
   the API from Ruby's native Matrix class as possible
 email:
@@ -114,3 +120,4 @@ signing_key:
 specification_version: 4
 summary: Immutable persistent matrix using Hamster
 test_files: []
+has_rdoc: