Add wrap and neighbor access methods for grid logic

Author: HossamSaberr

src/Containers-Array2D-Tests/CTArray2DTest.class.st

@@ -87,6 +87,34 @@ CTArray2DTest >> testAtColumnPut [
 	1 to: foo height do: [ :y | self assert: (foo atColumn: 2 atRow: y) equals: 1 ]
 ]
 
+{ #category : 'tests-accessing' }
+CTArray2DTest >> testAtColumnWrapAtRowWrap [
+
+	| array |
+	array := self arrayClass width2Height3.
+	
+	self assert: (array atColumnWrap: 1 atRowWrap: 1) equals: 1.
+	
+	self assert: (array atColumnWrap: 3 atRowWrap: 1) equals: 1.
+	
+	self assert: (array atColumnWrap: 2 atRowWrap: 4) equals: 2.
+	
+	self assert: (array atColumnWrap: 0 atRowWrap: 0) equals: 6.
+]
+
+{ #category : 'tests-accessing' }
+CTArray2DTest >> testAtColumnWrapAtRowWrapPut [
+
+	| array |
+	array := self arrayClass width2Height3.
+	
+	array atColumnWrap: 3 atRowWrap: 2 put: 99.
+	self assert: (array atColumn: 1 atRow: 2) equals: 99.
+	
+	array atColumnWrap: 0 atRowWrap: 0 put: 88.
+	self assert: (array atColumn: 2 atRow: 3) equals: 88.
+]
+
 { #category : 'tests-accessing' }
 CTArray2DTest >> testAtPut [
 
@@ -236,6 +264,33 @@ CTArray2DTest >> testLeftToRightFromBottomToTopDo [
 
 ]
 
+{ #category : 'tests-accessing' }
+CTArray2DTest >> testNeighborsAtColumnAtRow [
+
+	| array neighbors topCornerNeighbors |
+	array := self arrayClass width2Height3.
+	
+	neighbors := array neighborsAtColumn: 1 atRow: 2.
+	self assert: neighbors size equals: 5.
+	self assert: (neighbors includesAll: #(1 2 4 5 6)).
+	
+	topCornerNeighbors := array neighborsAtColumn: 1 atRow: 1.
+	self assert: topCornerNeighbors size equals: 3.
+	self assert: (topCornerNeighbors includesAll: #(2 3 4)).
+]
+
+{ #category : 'tests-accessing' }
+CTArray2DTest >> testNeighborsEight [
+
+	| array neighbors |
+	array := self arrayClass fromArray: #(1 2 3 4 5 6 7 8 9) width: 3.
+	
+	neighbors := array neighborsAtColumn: 2 atRow: 2.
+	
+	self assert: neighbors size equals: 8.
+	self assert: (neighbors includesAll: #(1 2 3 4 6 7 8 9)).
+]
+
 { #category : 'tests-printing' }
 CTArray2DTest >> testPrinting [
 

src/Containers-Array2D/CTArray2D.class.st

@@ -193,6 +193,26 @@ CTArray2D >> atColumn: x put: aCollection [
 	^ aCollection
 ]
 
+{ #category : 'accessing' }
+CTArray2D >> atColumnWrap: col atRowWrap: row [
+	
+	| wrappedCol wrappedRow |
+	wrappedCol := ((col - 1) \\ self width) + 1.
+	wrappedRow := ((row - 1) \\ self height) + 1.
+	
+	^ self atColumn: wrappedCol atRow: wrappedRow
+]
+
+{ #category : 'accessing' }
+CTArray2D >> atColumnWrap: col atRowWrap: row put: aValue [
+
+	| wrappedCol wrappedRow |
+	wrappedCol := ((col - 1) \\ self width) + 1.
+	wrappedRow := ((row - 1) \\ self height) + 1.
+	
+	^ self atColumn: wrappedCol atRow: wrappedRow put: aValue
+]
+
 { #category : 'accessing rows/columns' }
 CTArray2D >> atRow: y [
 	"Answer the content of the whole column at y"
@@ -301,6 +321,22 @@ CTArray2D >> leftToRightFromBottomToTopDo: aBlock [
 			aBlock  value: (self atColumn: col atRow: row)]]
 ]
 
+{ #category : 'enumerating' }
+CTArray2D >> neighborsAtColumn: col atRow: row [
+	
+	| neighbors |
+	neighbors := OrderedCollection new.
+	
+	row - 1 to: row + 1 do: [ :r |
+		col - 1 to: col + 1 do: [ :c |
+			(r = row and: [ c = col ]) ifFalse: [
+				(r between: 1 and: self height) ifTrue: [
+					(c between: 1 and: self width) ifTrue: [
+						neighbors add: (self atColumn: c atRow: r) ] ] ] ] ].
+						
+	^ neighbors
+]
+
 { #category : 'accessing - compatibility' }
 CTArray2D >> numberOfColumns [
     "Answer the receiver's width, i.e., its number of x"