Naughty Pterodactyl Maid

    looping-matrix

    1.1.1 • Public • Published

    looping-matrix

    Build Status npm npm Downloads Coverage Status

    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

    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

    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

    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.clone() ⇒ LoopingMatrix

    Makes a copy of this matrix.

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

    Position : Object

    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

    Install

    npm i looping-matrix

    DownloadsWeekly Downloads

    2

    Version

    1.1.1

    License

    MIT

    Last publish

    Collaborators

    • dasilvacontin