time-to-botec

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

README.md (2167B)

      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 nth [Lucas number][lucas-number] when stored in [double-precision floating-point][ieee754] format.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 <!-- eslint-disable id-length -->
     30 
     31 ```javascript
     32 var FLOAT64_MAX_SAFE_NTH_LUCAS = require( '@stdlib/constants/float64/max-safe-nth-lucas' );
     33 ```
     34 
     35 #### FLOAT64_MAX_SAFE_NTH_LUCAS
     36 
     37 The maximum [safe][safe-integers] nth [Lucas number][lucas-number] when stored in [double-precision floating-point][ieee754] format.
     38 
     39 <!-- eslint-disable id-length -->
     40 
     41 ```javascript
     42 var bool = ( FLOAT64_MAX_SAFE_NTH_LUCAS === 76 );
     43 // returns true
     44 ```
     45 
     46 </section>
     47 
     48 <!-- /.usage -->
     49 
     50 <section class="examples">
     51 
     52 ## Examples
     53 
     54 <!-- eslint-disable id-length -->
     55 
     56 <!-- eslint no-undef: "error" -->
     57 
     58 ```javascript
     59 var FLOAT64_MAX_SAFE_NTH_LUCAS = require( '@stdlib/constants/float64/max-safe-nth-lucas' );
     60 
     61 var v;
     62 var i;
     63 
     64 function lucas( n ) {
     65     var a;
     66     var b;
     67     var c;
     68     var i;
     69 
     70     a = 2;
     71     if ( n === 0 ) {
     72         return a;
     73     }
     74     b = 1;
     75     for ( i = 2; i <= n; i++ ) {
     76         c = a + b;
     77         a = b;
     78         b = c;
     79     }
     80     return b;
     81 }
     82 
     83 for ( i = 0; i < 100; i++ ) {
     84     v = lucas( i );
     85     if ( i > FLOAT64_MAX_SAFE_NTH_LUCAS ) {
     86         console.log( 'Unsafe: %d', v );
     87     } else {
     88         console.log( 'Safe:   %d', v );
     89     }
     90 }
     91 ```
     92 
     93 </section>
     94 
     95 <!-- /.examples -->
     96 
     97 <section class="links">
     98 
     99 [safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
    100 
    101 [lucas-number]: https://en.wikipedia.org/wiki/Lucas_number
    102 
    103 [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
    104 
    105 </section>
    106 
    107 <!-- /.links -->