Skip to content

Create an unsigned 32-bit integer from a literal bit representation.

License

Notifications You must be signed in to change notification settings

stdlib-js/number-uint32-base-from-binary-string

Repository files navigation

From Binary String

NPM version Build Status Coverage Status

Create an unsigned 32-bit integer from a literal bit representation.

Installation

npm install @stdlib/number-uint32-base-from-binary-string

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

Usage

var fromBinaryStringUint32 = require( '@stdlib/number-uint32-base-from-binary-string' );

fromBinaryStringUint32( bstr )

Creates an unsigned 32-bit integer from a literal bit representation.

var bstr = '01010101010101010101010101010101';
var val = fromBinaryStringUint32( bstr );
// returns 1431655765

bstr = '00000000000000000000000000000000';
val = fromBinaryStringUint32( bstr );
// returns 0

bstr = '00000000000000000000000000000010';
val = fromBinaryStringUint32( bstr );
// returns 2

bstr = '11111111111111111111111111111111';
val = fromBinaryStringUint32( bstr );
// returns 4294967295

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var MAX_UINT = require( '@stdlib/constants-uint32-max' );
var toBinaryStringUint32 = require( '@stdlib/number-uint32-base-to-binary-string' );
var fromBinaryStringUint32 = require( '@stdlib/number-uint32-base-from-binary-string' );

var b;
var x;
var y;
var i;

// Convert random integers to literal bit representations and then convert them back...
for ( i = 0; i < 100; i++ ) {
    x = round( randu()*MAX_UINT );
    b = toBinaryStringUint32( x );
    y = fromBinaryStringUint32( b );
    console.log( '%d => %s => %d', x, b, y );
}

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.