Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cross Product

NPM version Build Status Coverage Status Dependencies

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 = require( 'compute-cross' );

cross( x, y )

Computes the cross product between two numeric arrays.

var arr = cross( [1,2,3], [4,5,6] );
// returns [ -3, 6, -3 ]

Note: both arrays must be length 3.

Examples

var cross = require( 'compute-cross' );

// Parallel vectors:
console.log( cross( [1,-2,3], [2,-4,6] ) );
// returns [ 0, 0, 0 ]

// Anti-parallel vectors:
console.log( cross( [-1,2,-3], [2,-4,6] ) );
// returns [ 0, 0, 0 ]

// Non-parallel vectors:
console.log( cross( [4,-2,1], [1,-1,3] ) );
// 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

MIT license.


Copyright

Copyright © 2014. Athan Reines.

About

Computes the cross product between two arrays.

Resources

Stars

4 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages