time-to-botec/js/node_modules/@stdlib/number/uint16/base/from-binary-string/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.3 KiB

From Binary String

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

Usage

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

fromBinaryStringUint16( bstr )

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

var bstr = '0101010101010101';
var val = fromBinaryStringUint16( bstr );
// returns 21845

bstr = '0000000000000000';
val = fromBinaryStringUint16( bstr );
// returns 0

bstr = '0000000000000010';
val = fromBinaryStringUint16( bstr );
// returns 2

bstr = '1111111111111111';
val = fromBinaryStringUint16( bstr );
// returns 65535

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var MAX_UINT = require( '@stdlib/constants/uint16/max' );
var toBinaryStringUint16 = require( '@stdlib/number/uint16/base/to-binary-string' );
var fromBinaryStringUint16 = require( '@stdlib/number/uint16/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 = toBinaryStringUint16( x );
    y = fromBinaryStringUint16( b );
    console.log( '%d => %s => %d', x, b, y );
}