README.md

deg2rad

Converts degrees to radians.

Installation

$ npm install compute-deg2rad

For use in the browser, use browserify.

Usage

To use the module,

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

deg2rad( x )

Converts degrees to radians. x may be either a numeric array or a single numeric value.

// Single value:
var rad = deg2rad( 90 );
// returns pi/2

// Array of values:
var degs = [ 0, 45, 90, 135, 180 ];

deg2rad( degs );
// returns [ 0, pi/4, pi/2, 3pi/4, pi ]

Examples

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

// Simulate some data...
var data = new Array( 100 );

for ( var i = 0; i < data.length; i++ ) {
	data[ i ] = Math.random()*360;
}

deg2rad( data );

console.log( data.join( '\n' ) );

To run the example code from the top-level application directory,

$ node ./examples/index.js

Notes

If provided an input array, the array is mutated. If mutation is undesired,

var data = [ 0, 45, 90, 135, 180 ],
	copy = data.slice();

deg2rad( copy );

If provided an empty array, the function returns null.

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.