https://github.com/hyunseob/spiral-matrix

Generate a spiral matrix.
https://github.com/hyunseob/spiral-matrix

Last synced: 11 days ago
JSON representation

Generate a spiral matrix.

• Host: GitHub
• URL: https://github.com/hyunseob/spiral-matrix
• Owner: HyunSeob
• License: other
• Created: 2016-05-02T16:45:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-05-09T15:45:25.000Z (over 8 years ago)
• Last Synced: 2024-09-29T08:36:56.749Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# spiral-matrix 

[![Build Status](https://travis-ci.org/HyunSeob/spiral-matrix.svg?branch=master)](https://travis-ci.org/HyunSeob/spiral-matrix) [![npm](https://img.shields.io/npm/v/spiral-matrix.svg)](https://npmjs.org/package/spiral-matrix) [![Downloads](https://img.shields.io/npm/dm/spiral-matrix.svg)](https://npmjs.org/package/spiral-matrix) [![Dependencies](https://img.shields.io/david/hyunseob/spiral-matrix.svg)](https://david-dm.org/hyunseob/spiral-matrix) [![LICENSE](https://img.shields.io/npm/l/spiral-matrix.svg)](LICENSE)

Generate a spiral matrix.

## Installation

You can easily install this module via npm.

```

$ npm install spiral-matrix

```

## Usage

First, import the SpiralMatrix module.

``` javascript

const SpiralMatrix = require('spiral-matrix');

```

Then, You can generate a spiral matrix with following code:

``` javascript

const spiralMatrix = new SpiralMatrix(6, 6, 0);

// This will generate a 6 by 6 spiral matrix which start from 0.

// Like this:

// [ [ 0, 1, 2, 3, 4, 5 ],

//   [ 19, 20, 21, 22, 23, 6 ],

//   [ 18, 31, 32, 33, 24, 7 ],

//   [ 17, 30, 35, 34, 25, 8 ],

//   [ 16, 29, 28, 27, 26, 9 ],

//   [ 15, 14, 13, 12, 11, 10 ] ]

```

SpiralMatrix object has two methods.

``` javascript

spiralMatrix.get(); // Returns matrix as two dimensional array.

```

``` javascript

spiralMatrix.toString(); // Returns matrix as string.

```

## License

[GFDL-1.2](https://github.com/HyunSeob/spiral-matrix/blob/master/LICENSE)