array-symmetries 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49ea03047cf748c0cfad24e2d2c98bad6aeeac841b7ee7c10a5a3eba9bd858dc
-  data.tar.gz: 76db02d721b3a571879bd29acc277e058da00c00c6c422aba056809fb6e3ee95
+  metadata.gz: a9842cec8943393c58825134c143058f6f4f8d464179f06db6f628b11a20a4c8
+  data.tar.gz: 5e8dae59ed50454965fc892b1d934684d04cdcb35a2ce743cb2727c6a3aa1ca0
 SHA512:
-  metadata.gz: d08b9adeb7cb6f908641ee19c5b5226423efca083e2cfecbe5f2ac0820141af14cea2187753ac416499fa247cb7e03815f6b7305ab8631d055df2abf12f652d6
-  data.tar.gz: 60cd51edae458292160236c50d6750c69932a84b2a2bb5f97fedbefd02b4e3c5214d325493fcc92435eb2897be2d2412a15ff0ca89ac7760b860ca83d53d95b8
+  metadata.gz: 40a35fca610a50f47c84e8ca41d15a8923eaaf56282fe9008d0fa057773271b5aa7266db5ebabdfd0fba9c1440ed96e69edc62b073ae3de3560701763a652683
+  data.tar.gz: 92ebf86744bae7ace0831f795526fec94fae4823d36596b3c309ebc20fd3e01566edcad8f52259cbba8f76c464dd6510c87e7c915c74e5ed950336c1c10046b2

data/lib/array.rb

@@ -1,20 +1,26 @@
+# see https://en.wikipedia.org/wiki/Examples_of_groups#The_symmetry_group_of_a_square:_dihedral_group_of_order_8
+
 class Array # yeah it's a monkey patch
+  # Returns `true` if the array is square, which is to say, the length of each
+  # row is equal to the number of rows.  Otherwise returns `false`.
   def square?
     all? {|e| e.length == length}
   end
 
-  # see https://en.wikipedia.org/wiki/Examples_of_groups#The_symmetry_group_of_a_square:_dihedral_group_of_order_8
 
+  # Returns the array obtained by flipping the square array vertically.
   def b
     raise ArgumentError unless square?
     reverse
   end
 
+  # Returns the array obtained by rotating the square 90° clockwise.
   def a
     raise ArgumentError unless square?
     b.transpose
   end
 
+  # Returns an array containing the eight symmetries of the square array.
   def symmetries
     raise ArgumentError unless square?
     [self, b, a, a.a, a.a.a, a.b, a.a.b, a.a.a.b]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: array-symmetries
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lorraine Lee