JarCastingSquare Root
Computes the principal square root.
The principal square root is defined as
Installation
$ npm install math-sqrt
Usage
var sqrt = require( 'math-sqrt' );
sqrt( x )
Computes the principal square root.
var val = sqrt( 4 );
// returns 2
val = sqrt( 9 );
// returns 3
val = sqrt( 0 );
// returns 0
For negative numbers, the principal square root is not defined.
var val = sqrt( -4 );
// returns NaN
Examples
var sqrt = require( 'math-sqrt' );
var x;
var i;
for ( i = 0; i < 100; i++ ) {
x = Math.round( Math.random() * 100 );
console.log( sqrt( x ) );
}
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
This repository uses tape for unit tests. 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
Browser Support
This repository uses Testling for browser testing. To run the tests in a (headless) local web browser, execute the following command in the top-level application directory:
$ make test-browsers
To view the tests in a local web browser,
$ make view-browser-tests
License
Copyright
Copyright © 2016. The Compute.io Authors.
