time-to-botec

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

README.md (1919B)

      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 # Golden Ratio (φ)
     22 
     23 > [Golden ratio][phi].
     24 
     25 <section class="intro">
     26 
     27 The [golden ratio][phi] can be defined algebraically as
     28 
     29 <!-- <equation class="equation" label="eq:golden_ratio" align="center" raw="\phi = \frac{1 + \sqrt{5}}{2}" alt="Golden ratio"> -->
     30 
     31 <div class="equation" align="center" data-raw-text="\phi = \frac{1 + \sqrt{5}}{2}" data-equation="eq:golden_ratio">
     32     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@5d87cc7cb2c58aeb732872f89562d2c89571cc8a/lib/node_modules/@stdlib/constants/float64/phi/docs/img/equation_golden_ratio.svg" alt="Golden ratio">
     33     <br>
     34 </div>
     35 
     36 <!-- </equation> -->
     37 
     38 </section>
     39 
     40 <!-- /.intro -->
     41 
     42 <section class="usage">
     43 
     44 ## Usage
     45 
     46 ```javascript
     47 var PHI = require( '@stdlib/constants/float64/phi' );
     48 ```
     49 
     50 #### PHI
     51 
     52 The [golden ratio][phi-value].
     53 
     54 ```javascript
     55 var bool = ( PHI === 1.618033988749895 );
     56 // returns true
     57 ```
     58 
     59 </section>
     60 
     61 <!-- /.usage -->
     62 
     63 <section class="examples">
     64 
     65 ## Examples
     66 
     67 <!-- TODO: better example using Fibonacci(?) -->
     68 
     69 <!-- eslint no-undef: "error" -->
     70 
     71 ```javascript
     72 var PHI = require( '@stdlib/constants/float64/phi' );
     73 
     74 console.log( PHI );
     75 // => 1.618033988749895
     76 ```
     77 
     78 </section>
     79 
     80 <!-- /.examples -->
     81 
     82 <section class="links">
     83 
     84 [phi]: http://en.wikipedia.org/wiki/Golden_ratio
     85 
     86 [phi-value]: http://oeis.org/A001622
     87 
     88 </section>
     89 
     90 <!-- /.links -->