validate.io-matrix-like

Validates if a value is matrix-like.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
validate.io-matrix-like
301.0.29 years ago9 years agoMinified + gzip package size for validate.io-matrix-like in KB

Readme

matrix-like
!NPM versionnpm-imagenpm-url !Build Statustravis-imagetravis-url !Coverage Statuscoveralls-imagecoveralls-url !Dependenciesdependencies-imagedependencies-url
Validates if a value is matrix-like.

Installation

$ npm install validate.io-matrix-like

For use in the browser, use browserify.

Usage

var matrixLike = require( 'validate.io-matrix-like' );

matrixLike( value )

Validates if a value is matrix-like.
var mat = {
	'data': new Int8Array( 10 ),
	'shape': [5,2],
	'offset': 0,
	'strides': [2,1],
	'dtype': 'int8',
	'length': 10
};

console.log( matrixLike( mat ) );
// returns true

Examples

var matrixLike = require( 'validate.io-matrix-like' );

var mat = {
	'data': new Int8Array( 10 ),
	'shape': [5,2],
	'offset': 0,
	'strides': [2,1],
	'dtype': 'int8',
	'length': 10
};
console.log( matrixLike( mat ) );
// returns true

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

console.log( matrixLike( {} ) );
// returns false

console.log( matrixLike( null ) );
// returns false

To run the example code from the top-level application directory,
$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,
$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.