lib/csrmatrix/helpers.rb in csrmatrix-1.0.0 vs lib/csrmatrix/helpers.rb in csrmatrix-1.0.1

@@ -4,12 +4,14 @@
 		##
 		# ARRAY FUNCTIONS
 		# for pre-processing of matrix
 		#
 
-		# Identifies the 'column' value of an array (eg. the number of entries in a column)
 		def max_col(array)
+			# Identifies the 'column' value of an array (eg. the number of entries in a column)
+			# pre 	array
+			# post 	column count of array
 			values = array
 			max_count = 0
 			# Loop over indexes.
 			values.each_index do |i|
 				counter = 0
@@ -21,57 +23,67 @@
 			  if counter > max_count
 			  	max_count = counter
 			  end
 			end
 			return max_count
-		end
+		end # max_col
 
-		# Identifies the 'row' value of an array (eg. the number of entries in a row)
 		def max_row(array)
+			# Identifies the 'row' value of an array (eg. the number of entries in a row)
+			# pre 	array
+			# post 	row count of array
 			values = array
 			max_count = 0
 			values.each_index do |i|
 			  max_count += 1
 			end
 			return max_count
-		end
+		end # max_row
 
 		def count_nonzero(array) 
+			# Finds all nonzero values in an array.
+			# pre 	array 
+			# post 	int nonzero count of array
 			max_count = 0
 			array.each_index do |i|
 				subarray = array[i]
 			  subarray.each_index do |x|
 			  	if array[i][x] != 0
 			  		max_count += 1
 			  	end
 			  end
 			end
 			return max_count
-		end
+		end # count_nonzero
 
-		# Code taken from http://stackoverflow.com/questions/9545613/getting-dimension-of-multidimensional-array-in-ruby
 		def depth(array)
+			# Code from http://stackoverflow.com/questions/9545613/getting-dimension-of-multidimensional-array-in-ruby
+			# Identifies the depth of an array.
+			# pre 	array
+			# post 	int depth of array
 	    return 0 if array.class != Array
 			result = 1
 			array.each do |sub_a|
 			  if sub_a.class == Array
 			    dim = depth(sub_a)
 			    result = dim + 1 if dim + 1 > result
 			  end
 			end
 			return result
-		end	
+		end	# depth
 
-		# Counts all elements in array - assumed 2d
     def count_total(array) 
+    	# Counts all elements in array - assumed 2d
+    	# pre 	array
+    	# post 	int count of all elements
       max_count = 0
       array.each_index do |i|
         subarray = array[i]
         subarray.each_index do |x|
           max_count += 1
         end
       end
       return max_count
-    end
+    end # count_total
 	
-  end
-end
+  end # Helpers
+end # CsrMatrix