time-to-botec

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

README.md (2406B)

      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 # isSafeInteger
     22 
     23 > Test if a finite [double-precision floating-point number][ieee754] is a safe integer.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isSafeInteger = require( '@stdlib/math/base/assert/is-safe-integer' );
     31 ```
     32 
     33 #### isSafeInteger( x )
     34 
     35 Tests if a finite [double-precision floating-point number][ieee754] is a safe `integer`.
     36 
     37 ```javascript
     38 var bool = isSafeInteger( 1.0 );
     39 // returns true
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 ## Notes
     49 
     50 -   An integer valued number is "safe" when the number can be exactly represented as a [double-precision floating-point number][ieee754]. For example,
     51 
     52     ```javascript
     53     var MAX_SAFE_INTEGER = require( '@stdlib/constants/float64/max-safe-integer' );
     54     // returns 9007199254740991
     55 
     56     var x = 9007199254740992;
     57     // returns 9007199254740992
     58 
     59     var y = 9007199254740993;
     60     // returns 9007199254740992
     61 
     62     var bool = ( x === y );
     63     // returns true
     64     ```
     65 
     66     In this example, `x` and `y` should be distinct, but they are not due to constraints imposed by storing numeric values in [double-precision floating-point format][ieee754]. "Safe" integers are thus [double-precision floating-point numbers][ieee754] having integer values with unequivocal binary representations.
     67 
     68 </section>
     69 
     70 <!-- /.notes -->
     71 
     72 <section class="examples">
     73 
     74 ## Examples
     75 
     76 <!-- eslint no-undef: "error" -->
     77 
     78 ```javascript
     79 var isSafeInteger = require( '@stdlib/math/base/assert/is-safe-integer' );
     80 
     81 var bool = isSafeInteger( -5.0 );
     82 // returns true
     83 
     84 bool = isSafeInteger( 2.0e200 );
     85 // returns false
     86 
     87 bool = isSafeInteger( 3.14 );
     88 // returns false
     89 
     90 bool = isSafeInteger( NaN );
     91 // returns false
     92 ```
     93 
     94 </section>
     95 
     96 <!-- /.examples -->
     97 
     98 <section class="links">
     99 
    100 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
    101 
    102 </section>
    103 
    104 <!-- /.links -->