looping-matrix
A matrix that loops from edge to edge.
Install
$ npm install --save looping-matrix
Usage
var LoopingMatrix = ;var loopingMatrix = 50 50; loopingMatrix // => undefinedloopingMatrixloopingMatrix // => 0 loopingMatrixloopingMatrix // => 'cake'loopingMatrix // => 'cake'loopingMatrix // => 'cake' var copy = loopingMatrixloopingMatrixcopy // => 'cake'
API
new LoopingMatrix(width, height)
A matrix that loops indexes from edge to edge.
Param | Type |
---|---|
width | number |
height | number |
loopingMatrix.reset(value)
Reset all the positions in the matrix to a given value.
Kind: instance method of LoopingMatrix
Param | Type | Description |
---|---|---|
value | number |
value to be set on all the matrix' positions |
Position
loopingMatrix.loopPosition(i, j) ⇒ In case the given position lays outside the matrix, loop the position from edge to edge.
Kind: instance method of LoopingMatrix
Returns: Position
- the looped position
Param | Type | Description |
---|---|---|
i | number |
the column index of the position |
j | number |
the row index of the position |
*
loopingMatrix.getCell(i, j) ⇒ Returns the value of the given position.
Kind: instance method of LoopingMatrix
Returns: *
- the value of the position
Param | Type | Description |
---|---|---|
i | number |
the column index of the position |
j | number |
the row index of the position |
loopingMatrix.setCell(i, j, val)
Set the value of the given position.
Kind: instance method of LoopingMatrix
Param | Type | Description |
---|---|---|
i | number |
the column index of the position |
j | number |
the row index of the position |
val | * |
the value to set in the given position |
loopingMatrix.copyMatrixAt(i, j)
Copy a source matrix into this matrix starting at the given position of this matrix.
Kind: instance method of LoopingMatrix
Param | Type | Description |
---|---|---|
i | number |
the column index of the start position |
j | number |
the row index of the start position |
LoopingMatrix
loopingMatrix.clone() ⇒ Makes a copy of this matrix.
Kind: instance method of LoopingMatrix
Returns: LoopingMatrix
- the clone
Object
Position : Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
i | number |
The column index of the position |
j | number |
The row index of the position |
License
MIT © David da Silva