Latin-square NPM

latin-square

• Introduction • Installation • Usage • API • Test • License

Introduction

Simple latin square generator from an initial row of elements. The function creates and returns a row generating function. On every call, the created row generating function returns the provided samples in a random order but meeting the latin-square restrictions:

each items will only be in one row
each item will only be in one column

Installation

In node, from the root of the project folder type npm install --save latin-square.

usage

The function takes the desired elements as parameter and returns a row-generating function

latinSquare = require('latin-square')
var sampler = latinSquare([0,1,2])
var row1 = sampler() // example [1,0,2]
var row2 = sampler() // example [2,1,0]
var row3 = sampler() // example [0,2,1]

For example, the following code would generate a random 9x9 Sudoku:

var latinSquare = require('latin-square')
var elements = [0,1,2,3,4,5,6,7,8,9]
var makeRow = LatinSquare(elements)

var sudoku = elements.map(makeRow)

API

latinSquare: Array => Sampler
- takes an array of anything and returns a Sampler function. e.g: var sampler = latinSquare(['Fire','Earth','Water', 'Air'])
Sampler: ([array || count]) => Array
- if no arguments provided, returns a new Array with the shuffled inputs. e.g: var sample = sampler()
- if an array is provided, the target array will be filled with shuffled inputs (oversized arrays are resized)
- if a number smaller than the initial source array is provided, that number of samples will be returned e.g: var sample = sampler(2)