Cross Product
Computes the cross product between two numeric arrays.
Installation
$ npm install compute-cross
For use in the browser, use browserify.
Usage
To use the module,
var cross = ;
cross( x, y )
Computes the cross product between two numeric arrays
.
var arr = ;// returns [ -3, 6, -3 ]
Note: both arrays
must be length 3
.
Examples
var cross = ;// Parallel vectors:console;// returns [ 0, 0, 0 ]// Anti-parallel vectors:console;// returns [ 0, 0, 0 ]// Non-parallel vectors:console;// returns [ -5, -11, -2 ]
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. Athan Reines.