time-to-botec

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

README.md (2146B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2018 The Stdlib Authors.
      6 
      7 Licensed under the Apache License, Version 2.0 (the "License");
      8 you may not use this file except in compliance with the License.
      9 You may obtain a copy of the License at
     10 
     11    http://www.apache.org/licenses/LICENSE-2.0
     12 
     13 Unless required by applicable law or agreed to in writing, software
     14 distributed under the License is distributed on an "AS IS" BASIS,
     15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     16 See the License for the specific language governing permissions and
     17 limitations under the License.
     18 
     19 -->
     20 
     21 # Uint16
     22 
     23 > Base utilities for unsigned 16-bit integers.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ns = require( '@stdlib/number/uint16/base' );
     31 ```
     32 
     33 #### ns
     34 
     35 Base utilities for unsigned 16-bit integers.
     36 
     37 ```javascript
     38 var o = ns;
     39 // returns {...}
     40 ```
     41 
     42 <!-- <toc pattern="*"> -->
     43 
     44 <div class="namespace-toc">
     45 
     46 -   <span class="signature">[`fromBinaryStringUint16( bstr )`][@stdlib/number/uint16/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 16-bit integer from a literal bit representation.</span>
     47 -   <span class="signature">[`toBinaryStringUint16( x )`][@stdlib/number/uint16/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of an unsigned 16-bit integer.</span>
     48 
     49 </div>
     50 
     51 <!-- </toc> -->
     52 
     53 </section>
     54 
     55 <!-- /.usage -->
     56 
     57 <section class="examples">
     58 
     59 ## Examples
     60 
     61 <!-- TODO: better examples -->
     62 
     63 <!-- eslint no-undef: "error" -->
     64 
     65 ```javascript
     66 var objectKeys = require( '@stdlib/utils/keys' );
     67 var ns = require( '@stdlib/number/uint16/base' );
     68 
     69 console.log( objectKeys( ns ) );
     70 ```
     71 
     72 </section>
     73 
     74 <!-- /.examples -->
     75 
     76 <section class="links">
     77 
     78 <!-- <toc-links> -->
     79 
     80 [@stdlib/number/uint16/base/from-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint16/base/from-binary-string
     81 
     82 [@stdlib/number/uint16/base/to-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint16/base/to-binary-string
     83 
     84 <!-- </toc-links> -->
     85 
     86 </section>
     87 
     88 <!-- /.links -->