time-to-botec

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

README.md (3074B)

      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 # Uint32
     22 
     23 > Base utilities for unsigned 32-bit integers.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ns = require( '@stdlib/number/uint32/base' );
     31 ```
     32 
     33 #### ns
     34 
     35 Base utilities for unsigned 32-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">[`fromBinaryStringUint32( bstr )`][@stdlib/number/uint32/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 32-bit integer from a literal bit representation.</span>
     47 -   <span class="signature">[`rotl32( x, shift )`][@stdlib/number/uint32/base/rotl]</span><span class="delimiter">: </span><span class="description">bitwise rotation to the left.</span>
     48 -   <span class="signature">[`rotr32( x, shift )`][@stdlib/number/uint32/base/rotr]</span><span class="delimiter">: </span><span class="description">bitwise rotation to the right.</span>
     49 -   <span class="signature">[`toBinaryStringUint32( x )`][@stdlib/number/uint32/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of an unsigned 32-bit integer.</span>
     50 -   <span class="signature">[`uint32ToInt32( x )`][@stdlib/number/uint32/base/to-int32]</span><span class="delimiter">: </span><span class="description">convert an unsigned 32-bit integer to a signed 32-bit integer.</span>
     51 
     52 </div>
     53 
     54 <!-- </toc> -->
     55 
     56 </section>
     57 
     58 <!-- /.usage -->
     59 
     60 <section class="examples">
     61 
     62 ## Examples
     63 
     64 <!-- TODO: better examples -->
     65 
     66 <!-- eslint no-undef: "error" -->
     67 
     68 ```javascript
     69 var objectKeys = require( '@stdlib/utils/keys' );
     70 var ns = require( '@stdlib/number/uint32/base' );
     71 
     72 console.log( objectKeys( ns ) );
     73 ```
     74 
     75 </section>
     76 
     77 <!-- /.examples -->
     78 
     79 <section class="links">
     80 
     81 <!-- <toc-links> -->
     82 
     83 [@stdlib/number/uint32/base/from-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint32/base/from-binary-string
     84 
     85 [@stdlib/number/uint32/base/rotl]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint32/base/rotl
     86 
     87 [@stdlib/number/uint32/base/rotr]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint32/base/rotr
     88 
     89 [@stdlib/number/uint32/base/to-binary-string]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint32/base/to-binary-string
     90 
     91 [@stdlib/number/uint32/base/to-int32]: https://www.npmjs.com/package/@stdlib/number/tree/main/uint32/base/to-int32
     92 
     93 <!-- </toc-links> -->
     94 
     95 </section>
     96 
     97 <!-- /.links -->