time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1360B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2018 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Create an unsigned 16-bit integer from a literal bit representation.
     23 *
     24 * @module @stdlib/number/uint16/base/from-binary-string
     25 *
     26 * @example
     27 * var fromBinaryStringUint16 = require( '@stdlib/number/uint16/base/from-binary-string' );
     28 *
     29 * var bstr = '0101010101010101';
     30 * var val = fromBinaryStringUint16( bstr );
     31 * // returns 21845
     32 *
     33 * bstr = '0000000000000000';
     34 * val = fromBinaryStringUint16( bstr );
     35 * // returns 0
     36 *
     37 * bstr = '0000000000000010';
     38 * val = fromBinaryStringUint16( bstr );
     39 * // returns 2
     40 *
     41 * bstr = '1111111111111111';
     42 * val = fromBinaryStringUint16( bstr );
     43 * // returns 65535
     44 */
     45 
     46 // MODULES //
     47 
     48 var fromBinaryStringUint16 = require( './main.js' );
     49 
     50 
     51 // EXPORTS //
     52 
     53 module.exports = fromBinaryStringUint16;