time-to-botec/squiggle/node_modules/@stdlib/number/uint8/base/to-binary-string/README.md

Binary String

Return a string giving the literal bit representation of an unsigned 8-bit integer.

Usage

var toBinaryString = require( '@stdlib/number/uint8/base/to-binary-string' );

toBinaryString( x )

Returns a string giving the literal bit representation of an unsigned 8-bit integer.

var Uint8Array = require( '@stdlib/array/uint8' );

var a = new Uint8Array( [ 1, 4, 9 ] );

var str = toBinaryString( a[0] );
// returns '00000001'

str = toBinaryString( a[1] );
// returns '00000100'

str = toBinaryString( a[2] );
// returns '00001001'

Notes

• Except for typed arrays, JavaScript does not provide native user support for unsigned 8-bit integers. According to the ECMAScript standard, number values correspond to double-precision floating-point numbers. While this function is intended for unsigned 8-bit integers, the function will accept floating-point values and represent the values as if they are unsigned 8-bit integers. Accordingly, care should be taken to ensure that only nonnegative integer values less than 256 (2^8) are provided.

  var str = toBinaryString( 1 );
  // returns '00000001'
  
  str = toBinaryString( 4 );
  // returns '00000100'
  
  str = toBinaryString( 9 );
  // returns '00001001'
  
  str = toBinaryString( 255 );
  // returns '11111111'
  

Examples

var Uint8Array = require( '@stdlib/array/uint8' );
var MAX_UINT8 = require( '@stdlib/constants/uint8/max' );
var toBinaryString = require( '@stdlib/number/uint8/base/to-binary-string' );

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

x = new Uint8Array( MAX_UINT8+1 );
for ( i = 0; i < x.length; i++ ) {
    x[ i ] = i;
}

// Convert unsigned 8-bit integers to literal bit representations...
for ( i = 0; i < x.length; i++ ) {
    b = toBinaryString( x[i] );
    y = parseInt( b, 2 );
    console.log( 'x: %d, b: %s, y: %d', x[i], b, y );
}