array_2d 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,16 +1,88 @@
 = array_2d
 
-Description goes here.
-
-== Contributing to array_2d
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+A lightweight mutable 2D array class that allows you to extract and change subarrays. I created it to get around the fact that the ruby core Matrix objects are immutable.
+
+== Install
+
+  gem install array_2d
+
+== Usage
+
+=== Create and modify
+
+  array2d = Array2D.new(2, 3)
+  => [[nil, nil, nil], [nil, nil, nil]]
+
+  array2d = Array2D.new(2, 3, 0)
+  => [[0, 0, 0], [0, 0, 0]]
+
+  array2d.state = [[1, 2, 3], [4, 5, 6]]
+  => [[1, 2, 3], [4, 5, 6]]
+
+=== Get size
+
+  array2d.size
+  => [2, 3]
+
+  array2d.row_size
+  => 2
+
+  array2d.column_size
+  => 3
+
+=== Get values
+
+  array2d[0, 2]
+  => 3
+
+  array2d[1, 0..1]
+  => [4, 5]
+
+  array2d[0..1, 0..1]
+  => [[1, 2], [4, 5]]
+
+  # Using two ranges returns another 2d array
+  array2d[0..1, 0..1].class
+  => Array2D
+
+=== Set values
+
+  array2d[0, 2] = 11
+
+  array2d
+  => [[1, 2, 11], [4, 5, 6]]
+
+  # You can set using a single value or a proper size array
+  array2d[1, 0..1] = 9
+  array2d
+  => [[1, 2, 11], [9, 9, 6]]
+
+  array2d[1, 0..1] = [99, 100]
+  array2d
+  => [[1, 2, 11], [99, 100, 6]]
+
+  # To set a 2d subarray you must use a single value or another Array2D object
+  array2d[0..1, 0..1] = 44
+  array2d
+  => [[44, 44, 11], [44, 44, 6]]
+
+  new_subarray = Array2D.new(2, 2)
+  new_subarray.state = [[55, 66], [77, 88]]
+  array2d[0..1, 0..1] = new_subarray
+  array2d
+  => [[55, 66, 11], [77, 88, 6]]
+
+=== Enumerate
+
+  # 'Each' goes through the 2d array from left to right, top to bottom
+  array2d.state = [[1, 2, 3], [4, 5, 6]]
+  array2d.each {|e| puts e}
+  1
+  2
+  3
+  4
+  5
+  6
 
 == Copyright
 

data/Rakefile

@@ -16,8 +16,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "array_2d"
   gem.homepage = "http://github.com/lukegrecki/array_2d"
   gem.license = "MIT"
-  gem.summary = "A lightweight mutabke 2D array class"
-  gem.description = "With this class you can create mutable 2D arrays and change subarrays."
+  gem.summary = "A lightweight mutable 2D array class"
+  gem.description = "Create mutable 2D arrays that allow you to change subarrays."
   gem.email = "lukegrecki@gmail.com"
   gem.authors = ["Luke Grecki"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/array_2d.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "array_2d"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luke Grecki"]
   s.date = "2012-10-08"
-  s.description = "With this class you can create mutable 2D arrays and change subarrays."
+  s.description = "Create mutable 2D arrays that allow you to change subarrays."
   s.email = "lukegrecki@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.10"
-  s.summary = "A lightweight mutabke 2D array class"
+  s.summary = "A lightweight mutable 2D array class"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: array_2d
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-10-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &80743030 !ruby/object:Gem::Requirement
+  requirement: &87113610 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80743030
+  version_requirements: *87113610
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &80742780 !ruby/object:Gem::Requirement
+  requirement: &87113040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80742780
+  version_requirements: *87113040
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &80742520 !ruby/object:Gem::Requirement
+  requirement: &87112770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80742520
-description: With this class you can create mutable 2D arrays and change subarrays.
+  version_requirements: *87112770
+description: Create mutable 2D arrays that allow you to change subarrays.
 email: lukegrecki@gmail.com
 executables: []
 extensions: []
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -786817233
+      hash: 348675471
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,5 +90,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A lightweight mutabke 2D array class
+summary: A lightweight mutable 2D array class
 test_files: []