@stdlib/math-base-special-fast-uint32-sqrt NPM

Square Root

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

Compute an integer square root.

Installation

npm install @stdlib/math-base-special-fast-uint32-sqrt

Usage

var sqrtUint32 = require( '@stdlib/math-base-special-fast-uint32-sqrt' );

sqrtUint32( x )

Returns an approximate square root of an unsigned 32-bit integer x.

var v = sqrtUint32( 9 >>> 0 );
// returns 3

v = sqrtUint32( 2 >>> 0 );
// returns 1

v = sqrtUint32( 3 >>> 0 );
// returns 1

v = sqrtUint32( 0 >>> 0 );
// returns 0

Notes

Prefer hardware sqrt over a software implementation.
When using a software sqrt, this implementation provides a performance boost when an application requires only approximate computations for integer arguments.
For applications requiring high-precision, this implementation is never suitable.

Examples

var sqrtUint32 = require( '@stdlib/math-base-special-fast-uint32-sqrt' );

var v;
var i;

for ( i = 0; i < 101; i++ ) {
    v = sqrtUint32( i >>> 0 );
    console.log( 'sqrt(%d) ≈ %d', i, v );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.