Package Exports

math-sqrt

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (math-sqrt) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Square Root

$NPM version$ $Build Status$ $Coverage Status$ $Dependencies$

Computes the principal square root.

The principal square root is defined as

$Principal square root definition.$

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

MIT license.

math-sqrt