Logical Array
Validates if a value is a logical array.
A logical array
is defined as an array
consisting exclusively of 0s
and 1s
. The definition is purely conventional, but such arrays
are useful when wanting to combine, e.g., boolean-like filtering with element-by-element array
multiplication. Similar use cases are common in numerical computing environments.
Installation
$ npm install validate.io-logical-array
For use in the browser, use browserify.
Usage
var isLogicalArray = ;
isLogicalArray( value )
Validates if a value
is a logical array
; i.e., an array
consisting solely of numeric 0s
and 1s
.
var arr = 1 0 0 1 1 ;var bool = ;// returns true
Note: the method will return false
for an empty array
.
Examples
var isLogicalArray = ;console;// returns trueconsole;// returns falseconsole;// returns falseconsole;// 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
Copyright
Copyright © 2015. Athan Reines.