time-to-botec

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

README.md (1872B)

      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 # Min Safe Integer
     22 
     23 > Minimum safe [single-precision floating-point][ieee754] integer.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var FLOAT32_MIN_SAFE_INTEGER = require( '@stdlib/constants/float32/min-safe-integer' );
     31 ```
     32 
     33 #### FLOAT32_MIN_SAFE_INTEGER
     34 
     35 The minimum [safe][safe-integers] [single-precision floating-point][ieee754] integer.
     36 
     37 ```javascript
     38 var bool = ( FLOAT32_MIN_SAFE_INTEGER === -16777215 );
     39 // returns true
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="examples">
     47 
     48 ## Examples
     49 
     50 <!-- eslint no-undef: "error" -->
     51 
     52 ```javascript
     53 var randu = require( '@stdlib/random/base/randu' );
     54 var round = require( '@stdlib/math/base/special/round' );
     55 var pow = require( '@stdlib/math/base/special/pow' );
     56 var FLOAT32_MIN_SAFE_INTEGER = require( '@stdlib/constants/float32/min-safe-integer' );
     57 
     58 var min;
     59 var x;
     60 var i;
     61 
     62 min = -pow( 2.0, 26 );
     63 for ( i = 0; i < 100; i++ ) {
     64     x = round( randu() * min );
     65     if ( x < FLOAT32_MIN_SAFE_INTEGER ) {
     66         console.log( 'Unsafe: %d', x );
     67     } else {
     68         console.log( 'Safe: %d', x );
     69     }
     70 }
     71 ```
     72 
     73 </section>
     74 
     75 <!-- /.examples -->
     76 
     77 <section class="links">
     78 
     79 [safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
     80 
     81 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
     82 
     83 </section>
     84 
     85 <!-- /.links -->