<commit_before>Square Matrix
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Validates if a value is an array of arrays and has equal dimensions.


## Installation

``` bash
$ npm install validate.io-square-matrix
```

For use in the browser, use [browserify](https://github.com/substack/node-browserify).


## Usage

``` javascript
var isSquareMatrix = require( 'validate.io-square-matrix' );
```

#### isSquareMatrix( value )

Validates if a value is an `array` of `arrays` and has equal dimensions.

``` javascript
var value = [[1,2],[1,2]];

var bool = isSquareMatrix( value );
// returns true
```

__Note__: the method first validates that the input `value` is an `array` of `arrays`. For any other input, the method returns `false`.


## Examples

``` javascript
var isSquareMatrix = require( 'validate.io-square-matrix' );

console.log( isSquareMatrix( [[1,2],[1,2]] ) );
// returns true

console.log( isSquareMatrix( [] ) );
// returns false

console.log( isSquareMatrix( [[]] ) );
// returns false
<commit_msg>[UPDATE] README.<commit_after>Square Matrix
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Validates if a value is an array of arrays and has equal dimensions.


## Installation

``` bash
$ npm install validate.io-square-matrix
```

For use in the browser, use [browserify](https://github.com/substack/node-browserify).


## Usage

``` javascript
var isSquareMatrix = require( 'validate.io-square-matrix' );
```

#### isSquareMatrix( value )

Validates if a value is an `array` of `arrays` and has equal dimensions.

``` javascript
var value = [[1,2],[1,2]];

var bool = isSquareMatrix( value );
// returns true
```

__Note__: the method first validates that an input `value` is an `array` of `arrays`. For any other input, the method returns `false`.


## Examples

``` javascript
var isSquareMatrix = require( 'validate.io-square-matrix' );

console.log( isSquareMatrix( [[1,2],[1,2]] ) );
// returns true

console.log( isSquareMatrix( [] ) );
// returns false

console.log( isSquareMatrix( [[]] ) );
// returns false

{'fraction_non_alphanumeric': 0.16638152266894782, 'fraction_numerical': 0.006843455945252352, 'mean_word_length': 4.862155388471178, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3328008', 'n_tokens_mistral': 797, 'n_tokens_neox': 737, 'n_words': 213}