92 lines
2.1 KiB
Markdown
92 lines
2.1 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 8-bit integer from a [literal bit representation][@stdlib/number/uint8/base/to-binary-string].
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var fromBinaryStringUint8 = require( '@stdlib/number/uint8/base/from-binary-string' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### fromBinaryStringUint8( bstr )
|
||
|
|
|
||
|
|
Creates an unsigned 8-bit integer from a [literal bit representation][@stdlib/number/uint8/base/to-binary-string].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bstr = '01010101';
|
||
|
|
var val = fromBinaryStringUint8( bstr );
|
||
|
|
// returns 85
|
||
|
|
|
||
|
|
bstr = '00000000';
|
||
|
|
val = fromBinaryStringUint8( bstr );
|
||
|
|
// returns 0
|
||
|
|
|
||
|
|
bstr = '00000010';
|
||
|
|
val = fromBinaryStringUint8( bstr );
|
||
|
|
// returns 2
|
||
|
|
|
||
|
|
bstr = '11111111';
|
||
|
|
val = fromBinaryStringUint8( bstr );
|
||
|
|
// returns 255
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var toBinaryStringUint8 = require( '@stdlib/number/uint8/base/to-binary-string' );
|
||
|
|
var fromBinaryStringUint8 = require( '@stdlib/number/uint8/base/from-binary-string' );
|
||
|
|
|
||
|
|
var b;
|
||
|
|
var y;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
// Convert integers to literal bit representations and then convert them back...
|
||
|
|
for ( i = 0; i < 256; i++ ) {
|
||
|
|
b = toBinaryStringUint8( i );
|
||
|
|
y = fromBinaryStringUint8( b );
|
||
|
|
console.log( '%d => %s => %d', i, b, y );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[@stdlib/number/uint8/base/to-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint8/base/to-binary-string
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|