looping-matrix

A matrix that loops from edge to edge.

Install

$ npm install --save looping-matrix

Usage

var LoopingMatrix = require('looping-matrix');
var loopingMatrix = new LoopingMatrix(50, 50);
 
loopingMatrix.getCell(1, 1) // => undefined
loopingMatrix.reset(0)
loopingMatrix.getCell(1, 1) // => 0
 
loopingMatrix.setCell(1, 1, 'cake')
loopingMatrix.getCell(1, 1) // => 'cake'
loopingMatrix.getCell(51, 51) // => 'cake'
loopingMatrix.getCell(-49, -49) // => 'cake'
 
var copy = loopingMatrix.clone()
loopingMatrix.setCell(1, 1, 'lie')
copy.getCell(1, 1) // => 'cake'

API

• LoopingMatrix
  • new LoopingMatrix(width, height)
  • .reset(value)
  • .loopPosition(i, j) ⇒ Position
  • .getCell(i, j) ⇒ *
  • .setCell(i, j, val)
  • .copyMatrixAt(i, j)
  • .clone() ⇒ LoopingMatrix

new LoopingMatrix(width, height)

A matrix that loops indexes from edge to edge.

loopingMatrix.reset(value)

Reset all the positions in the matrix to a given value.

Kind: instance method of LoopingMatrix

loopingMatrix.loopPosition(i, j) ⇒ Position

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

loopingMatrix.getCell(i, j) ⇒ *

Returns the value of the given position.

Kind: instance method of LoopingMatrix
Returns: * - the value of the position

loopingMatrix.setCell(i, j, val)

Set the value of the given position.

Kind: instance method of LoopingMatrix

loopingMatrix.copyMatrixAt(i, j)

Copy a source matrix into this matrix starting at the given position of this matrix.

Kind: instance method of LoopingMatrix

loopingMatrix.clone() ⇒ LoopingMatrix

Makes a copy of this matrix.

Kind: instance method of LoopingMatrix
Returns: LoopingMatrix - the clone

Position : Object

Kind: global typedef
Properties

License

MIT © David da Silva