time-to-botec

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

README.md (2040B)

      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 # Lucas Number
     22 
     23 > Maximum safe [Lucas number][lucas-number] when stored in [double-precision floating-point][ieee754] format.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var FLOAT64_MAX_SAFE_LUCAS = require( '@stdlib/constants/float64/max-safe-lucas' );
     31 ```
     32 
     33 #### FLOAT64_MAX_SAFE_LUCAS
     34 
     35 The maximum [safe][safe-integers] [Lucas number][lucas-number] when stored in [double-precision floating-point][ieee754] format.
     36 
     37 ```javascript
     38 var bool = ( FLOAT64_MAX_SAFE_LUCAS === 7639424778862807 );
     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 FLOAT64_MAX_SAFE_LUCAS = require( '@stdlib/constants/float64/max-safe-lucas' );
     54 
     55 var v;
     56 var i;
     57 
     58 function lucas( n ) {
     59     var a;
     60     var b;
     61     var c;
     62     var i;
     63 
     64     a = 2;
     65     if ( n === 0 ) {
     66         return a;
     67     }
     68     b = 1;
     69     for ( i = 2; i <= n; i++ ) {
     70         c = a + b;
     71         a = b;
     72         b = c;
     73     }
     74     return b;
     75 }
     76 
     77 for ( i = 0; i < 100; i++ ) {
     78     v = lucas( i );
     79     if ( v > FLOAT64_MAX_SAFE_LUCAS ) {
     80         console.log( 'Unsafe: %d', v );
     81     } else {
     82         console.log( 'Safe:   %d', v );
     83     }
     84 }
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.examples -->
     90 
     91 <section class="links">
     92 
     93 [safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
     94 
     95 [lucas-number]: https://en.wikipedia.org/wiki/Lucas_number
     96 
     97 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
     98 
     99 </section>
    100 
    101 <!-- /.links -->