hamster-matrix 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f6659d401677505ae8c2c64e378ccd0c30d574f
-  data.tar.gz: d3c0811f005d505b108912fd5a86ab5f86ba483f
+  metadata.gz: e9c57bcfcd225a6ca7bfb04bae733b1e425bc5ed
+  data.tar.gz: 29cf5ba08be8187bbbd61b8f04202618c6f815fd
 SHA512:
-  metadata.gz: cb3fbca3051385a36726d37d5c5a682a483474e99ecc2e9c71333a6e1c85d4f585d366e662aff336bf814b35054f993ddfed9ef884ec8314e300f0bb47de469d
-  data.tar.gz: 2281e55d391c8599ada824c9037e25e9624e83af9d83e9d21abb3d67e355ade62fa2c2c123feeae7462cbfa0d92048dafb22869e299196541c51f8edf089c55a
+  metadata.gz: f8ac30643511bfceaab242dd3e7c77081968473d6c73f8210615b58ddd56e75c3c430513cca76f7ed72400bc188ae5b31f0705a409db5be4f03ac90af5903444
+  data.tar.gz: fab9518ebfb0dba3f762c4cb56ae783831bb1f80a4ac4a549b49d293c611300e51df4259594be73d5220d19332e818b2a36a534161f32ad114cb9ba22cc7f6e5

data/README.md

@@ -25,7 +25,20 @@ Or install it yourself as:
 
 ## Usage
 
-###Coming Soon!###
+```ruby
+require 'hamster-matrix'
+a = Hamster::Matrix[[1,0,0],[0,1,0],[0,0,1]]
+b = a.set(2,2,'foo')
+puts b
+# [[1, 0, 0]
+#  [0, 1, 0]
+#  [0, 0, "foo"]]
+
+puts a
+#[[1, 0, 0]
+# [0, 1, 0]
+# [0, 0, 1]]
+```
 
 ## Contributing
 

data/bin/console

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

data/lib/hamster-matrix.rb

@@ -0,0 +1,2 @@
+require 'hamster/matrix'
+require 'hamster/version'

data/lib/hamster/matrix.rb

@@ -1,15 +1,18 @@
-require "hamster/version"
 require 'hamster'
 require 'matrix'
 
 module Hamster
-
-  def self.matrix(array = Hamster.vector)
-    Hamster::Matrix.new(array)
-  end
-
   class Matrix
     
+    # Creates a new Hamster Matrix
+    #
+    # @example
+    #   Hamster::Matrix[[1,0,0],[0,1,0],[0,0,1]]
+    #   # => Hamster::Matrix[[1,0,0]
+    #   #                    [0,1,0]
+    #   #                    [0,0,1]]
+    #
+    # @return [Hamster::Matrix]
     def self.[](*array)
       Hamster::Matrix.new(array)
     end
@@ -87,6 +90,24 @@ module Hamster
     alias_method :component, :get
     alias_method :element, :get
 
+
+    # Sets the value at a certain given index, leaving
+    # existing references unchanged
+    #
+    # @example
+    #   a = Hamster::Matrix[[1,0,0],[0,1,0],[0,0,1]]
+    #   b = a.set(2,2,'foo')
+    #   puts b
+    #   # [[1, 0, 0]
+    #   #  [0, 1, 0]
+    #   #  [0, 0, "foo"]]
+
+    #   puts a
+    #   # [[1, 0, 0]
+    #   #  [0, 1, 0]
+    #   #  [0, 0, 1]]
+    #
+    # @return [Hamster::Matrix]
     def set(i,j,value)
       if(i >= row_vectors.size)
         raise ExceptionForMatrix::ErrDimensionMismatch.new("I index #{i} outside of array bounds")
@@ -141,7 +162,7 @@ module Hamster
       if empty?
         "#{self.class}.empty"
       else
-        "#{self.class}#{row_string(16)}"
+        "#{self.class}#{row_string(19)}"
       end
     end
 
@@ -157,19 +178,28 @@ module Hamster
       row_string(1)
     end
 
+    def to_matrix
+      ::Matrix[to_a]
+    end
+
     def zero?
-      row_vectors.all? { |row| row.all? { |elem| elem.is_a?(Numeric) && elem.zero? } }
+      row_vectors.all? do |row| 
+        row.all? { |elem| elem.is_a?(Numeric) && elem.zero? }
+      end
     end
 
     attr_reader :row_vectors
 
-    private 
+    private
+
+    # @private 
     def enumerable_check!(enumerable)
       unless enumerable.is_a?(::Enumerable)
         raise TypeError.new('Matrix rows must be Enumerable')
       end
     end
 
+    # @private
     def row_string(spaces)
       br = ''
       row_vectors.inject('[') do |acc, row|

data/lib/hamster/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamster-matrix
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Urani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,7 @@ files:
 - bin/console
 - bin/setup
 - hamster-matrix.gemspec
+- lib/hamster-matrix.rb
 - lib/hamster/matrix.rb
 - lib/hamster/version.rb
 homepage: https://github.com/bradurani/hamster-matrix