GraphUtils 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a38723353cc27a96475a0774c91d1dd01f080dca
-  data.tar.gz: 7a51cbe06406eb18d6e7e477e1556d8187a14cf7
+  metadata.gz: 5546eb7bfddd04c77a046375d54cc89a198fe925
+  data.tar.gz: df0070edc52ea607fb840943f81ee2b80b7b3ab7
 SHA512:
-  metadata.gz: 70f0c67605219be63d07c0050e8fbb2b32e0a3d3b482302411eb8cc0346338b7625e7bc3a6704c40b656bda5d38a70366168289bc5a12f2bb76021d6a0d47248
-  data.tar.gz: 152a033e2b1b963e12c71c329f0c83ed6785ebc15f46a2cb2c2c3073bdcee421fbeef8ad0dd13982aa0b13ee0b93c20b2d82bc6ea3b1cf639863e1ca4ae68fac
+  metadata.gz: bfe48d61565dcbf68ea8e0cb25307c6f395f2365f825f507f5c3495edec075a26585a093a894601a16c4dac599ef95c3ae707440d1582489d80c59a39a6e8f7d
+  data.tar.gz: 328ed000ecbfdbbbafe76be2fd8deccdc3f8c010f25793ef6be4a7d46d8d4fe701dd8fee101523ad0a507d1ef25a21d533f4485c443a51526797230cb4e4338c

data/lib/graphutils.rb

@@ -8,6 +8,8 @@
 
 module GraphUtils
 
+  # Find the coordinates of a target, returning the row and column indices as an array
+
   def self.find_rc(two_dimensional_array, target)
     column = nil
     row = nil
@@ -25,12 +27,16 @@ module GraphUtils
     [row, column]
   end
 
+# Find a value corresponding with the given [row,column] coordinates
+
   def self.rc_lookup(two_dimensional_array, coordinates)
     row = coordinates[0]
     column = coordinates[1]
     two_dimensional_array[row][column]
   end
 
+# Return an array of a column at a particular index.
+
   def self.find_column(board, column_index)
     column = []
     row_index = 0
@@ -41,6 +47,8 @@ module GraphUtils
     column
   end
 
+# Returns an array of adjacent coordinates for a given set of coordinates. An options hash is included to specify an inclusive or exclusive lookup, defaulting to inclusive.
+
   def self.surrounding_coordinates(two_dimensional_array, coordinates, options = {} )
     raise ArgumentError.new("Must include [row,column] coordinates") unless coordinates.is_a?(Array)
     range = options[:range] || :inclusive
@@ -69,6 +77,8 @@ module GraphUtils
       values
   end
 
+# Returns an array of adjacent targets for a given set of coordinates.
+
   def self.surrounding_coordinates_to_values(two_dimensional_array, coordinates, options = {})
     coordinates = GraphUtils.surrounding_coordinates(two_dimensional_array, coordinates, options)
 
@@ -81,6 +91,8 @@ module GraphUtils
     values
   end
 
+# Deep iteration tools meant for manipulating N-D Array structures.
+
   def self.deepmap!(array, &block)
     array.map! do |elem|
       elem.is_a?(Array) ? deepmap!(elem, &block) : yield(elem)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: GraphUtils
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Marshall Hattersley