time-to-botec

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

README.md (2243B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 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 # Constants
     22 
     23 > 16-bit signed integer mathematical constants.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var constants = require( '@stdlib/constants/int16' );
     31 ```
     32 
     33 #### constants
     34 
     35 16-bit signed integer mathematical constants.
     36 
     37 ```javascript
     38 var c = constants;
     39 // returns {...}
     40 ```
     41 
     42 <!-- <toc pattern="*" > -->
     43 
     44 <div class="namespace-toc">
     45 
     46 -   <span class="signature">[`MAX`][@stdlib/constants/int16/max]</span><span class="delimiter">: </span><span class="description">maximum signed 16-bit integer.</span>
     47 -   <span class="signature">[`MIN`][@stdlib/constants/int16/min]</span><span class="delimiter">: </span><span class="description">minimum signed 16-bit integer.</span>
     48 -   <span class="signature">[`NUM_BYTES`][@stdlib/constants/int16/num-bytes]</span><span class="delimiter">: </span><span class="description">size (in bytes) of a 16-bit signed integer.</span>
     49 
     50 </div>
     51 
     52 <!-- </toc> -->
     53 
     54 </section>
     55 
     56 <!-- /.usage -->
     57 
     58 <section class="examples">
     59 
     60 ## Examples
     61 
     62 <!-- TODO: better examples -->
     63 
     64 <!-- eslint no-undef: "error" -->
     65 
     66 ```javascript
     67 var objectKeys = require( '@stdlib/utils/keys' );
     68 var constants = require( '@stdlib/constants/int16' );
     69 
     70 console.log( objectKeys( constants ) );
     71 ```
     72 
     73 </section>
     74 
     75 <!-- /.examples -->
     76 
     77 <section class="links">
     78 
     79 <!-- <toc-links> -->
     80 
     81 [@stdlib/constants/int16/max]: https://www.npmjs.com/package/@stdlib/constants/tree/main/int16/max
     82 
     83 [@stdlib/constants/int16/min]: https://www.npmjs.com/package/@stdlib/constants/tree/main/int16/min
     84 
     85 [@stdlib/constants/int16/num-bytes]: https://www.npmjs.com/package/@stdlib/constants/tree/main/int16/num-bytes
     86 
     87 <!-- </toc-links> -->
     88 
     89 </section>
     90 
     91 <!-- /.links -->