97 lines
2.3 KiB
Markdown
97 lines
2.3 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# From Binary String
|
||
|
|
|
||
|
|
> Create an unsigned 16-bit integer from a [literal bit representation][@stdlib/number/uint16/base/to-binary-string].
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var fromBinaryStringUint16 = require( '@stdlib/number/uint16/base/from-binary-string' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### fromBinaryStringUint16( bstr )
|
||
|
|
|
||
|
|
Creates an unsigned 16-bit integer from a [literal bit representation][@stdlib/number/uint16/base/to-binary-string].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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 );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[@stdlib/number/uint16/base/to-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint16/base/to-binary-string
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|