dims
Computes dimensions for arrays and matrices.
Installation
$ npm install compute-dims
For use in the browser, use browserify.
Usage
var dims = ;
dims( x[, max] )
Computes dimensions of x
. x
may be either an array
(including nested arrays
) or a matrix
.
var matrix =datad;data = 1 2 ;d = ;// returns [2]data = 12 12 ;d = ;// returns [2,2]data =d = ;// returns [2,2]
If an array
element has a dimension inconsistent with other elements, the function returns null
.
data = 12 1 ;d = ;// returns null
To limit the number of dimensions returned, set the max
option.
data = 12 34 ; // 1x2x2d = ;// returns [1,2]data = 12 345678 ;d = ;// returns nulld = ;// returns [1,2]data = ;d = ;// returns [2]
Examples
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
Copyright
Copyright © 2014-2015. The Compute.io Authors.