time-to-botec

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

README.md (3780B)

      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 # Quantile Function
     22 
     23 > [Gumbel][gumbel-distribution] distribution [quantile function][quantile-function].
     24 
     25 <section class="intro">
     26 
     27 The [quantile function][quantile-function] for a [Gumbel][gumbel-distribution] random variable is
     28 
     29 <!-- <equation class="equation" label="eq:gumbel_quantile_function" align="center" raw="Q(p)=\mu-\beta\ln(-\ln(p))" alt="Quantile function for a Gumbel distribution."> -->
     30 
     31 <div class="equation" align="center" data-raw-text="Q(p)=\mu-\beta\ln(-\ln(p))" data-equation="eq:gumbel_quantile_function">
     32     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/docs/img/equation_gumbel_quantile_function.svg" alt="Quantile function for a Gumbel distribution.">
     33     <br>
     34 </div>
     35 
     36 <!-- </equation> -->
     37 
     38 for `0 <= p < 1`, where `mu` is the location parameter and `beta > 0` is the scale parameter.
     39 
     40 </section>
     41 
     42 <!-- /.intro -->
     43 
     44 <section class="usage">
     45 
     46 ## Usage
     47 
     48 ```javascript
     49 var quantile = require( '@stdlib/stats/base/dists/gumbel/quantile' );
     50 ```
     51 
     52 #### quantile( p, mu, beta )
     53 
     54 Evaluates the [quantile function][quantile-function] for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta` (scale parameter).
     55 
     56 ```javascript
     57 var y = quantile( 0.8, 0.0, 1.0 );
     58 // returns ~1.5
     59 
     60 y = quantile( 0.5, 4.0, 2.0 );
     61 // returns ~4.733
     62 
     63 y = quantile( 0.5, 4.0, 4.0 );
     64 // returns ~5.466
     65 ```
     66 
     67 If provided a probability `p` outside the interval `[0,1]`, the function returns `NaN`.
     68 
     69 ```javascript
     70 var y = quantile( 1.9, 0.0, 1.0 );
     71 // returns NaN
     72 
     73 y = quantile( -0.1, 0.0, 1.0 );
     74 // returns NaN
     75 ```
     76 
     77 If provided `NaN` as any argument, the function returns `NaN`.
     78 
     79 ```javascript
     80 var y = quantile( NaN, 0.0, 1.0 );
     81 // returns NaN
     82 
     83 y = quantile( 0.0, NaN, 1.0 );
     84 // returns NaN
     85 
     86 y = quantile( 0.0, 0.0, NaN );
     87 // returns NaN
     88 ```
     89 
     90 If provided `beta <= 0`, the function returns `NaN`.
     91 
     92 ```javascript
     93 var y = quantile( 0.4, 0.0, -1.0 );
     94 // returns NaN
     95 
     96 y = quantile( 0.4, 0.0, 0.0 );
     97 // returns NaN
     98 ```
     99 
    100 #### quantile.factory( mu, beta )
    101 
    102 Returns a function for evaluating the [quantile function][quantile-function] of a [Gumbel][gumbel-distribution] distribution with parameters `mu` and `beta`.
    103 
    104 ```javascript
    105 var myquantile = quantile.factory( 10.0, 2.0 );
    106 
    107 var y = myquantile( 0.2 );
    108 // returns ~9.048
    109 
    110 y = myquantile( 0.8 );
    111 // returns ~13.00
    112 ```
    113 
    114 </section>
    115 
    116 <!-- /.usage -->
    117 
    118 <section class="examples">
    119 
    120 ## Examples
    121 
    122 <!-- eslint no-undef: "error" -->
    123 
    124 ```javascript
    125 var randu = require( '@stdlib/random/base/randu' );
    126 var quantile = require( '@stdlib/stats/base/dists/gumbel/quantile' );
    127 
    128 var beta;
    129 var mu;
    130 var p;
    131 var y;
    132 var i;
    133 
    134 for ( i = 0; i < 100; i++ ) {
    135     p = randu();
    136     mu = randu() * 10.0;
    137     beta = randu() * 10.0;
    138     y = quantile( p, mu, beta );
    139     console.log( 'p: %d, µ: %d, β: %d, Q(p;µ,β): %d', p.toFixed( 4 ), mu.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
    140 }
    141 ```
    142 
    143 </section>
    144 
    145 <!-- /.examples -->
    146 
    147 <section class="links">
    148 
    149 [gumbel-distribution]: https://en.wikipedia.org/wiki/Gumbel_distribution
    150 
    151 [quantile-function]: https://en.wikipedia.org/wiki/Quantile_function
    152 
    153 </section>
    154 
    155 <!-- /.links -->