@stdlib/math-base-special-fast-uint32-sqrt
v0.3.0
Published
Compute an integer square root.
Downloads
58
Readme
Square Root
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 );
}
C APIs
Usage
#include "stdlib/math/base/special/fast/uint32_sqrt.h"
stdlib_base_fast_uint32_sqrt( x )
Compute an integer square root.
#include <stdint.h>
uint32_t out = stdlib_base_fast_uint32_sqrt( 2 );
// returns 1
out = stdlib_base_fast_uint32_sqrt( 8 );
// returns 3
The function accepts the following arguments:
- x:
[in] uint32_t
input value.
uint32_t stdlib_base_fast_uint32_sqrt( const uint32_t x );
Examples
#include "stdlib/math/base/special/fast/uint32_sqrt.h"
#include <stdio.h>
#include <stdint.h>
int main( void ) {
const uint32_t x[] = { 10, 17, 20, 22, 98 };
uint32_t y;
int i;
for ( i = 0; i < 5; i++ ) {
y = stdlib_base_fast_uint32_sqrt( x[ i ] );
printf( "uint32_sqrt(%u) = %u\n", x[ i ], y );
}
}
See Also
@stdlib/math-base/special/sqrt
: compute the principal square root of a double-precision floating-point number.
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.