time-to-botec

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

README.md (4209B)

      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 # Mode
     22 
     23 > [Kumaraswamy's double bounded][kumaraswamy-distribution] distribution [mode][mode].
     24 
     25 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
     26 
     27 <section class="intro">
     28 
     29 The [mode][mode] for a [Kumaraswamy's double bounded][kumaraswamy-distribution] random variable with first shape parameter `a` and second shape parameter `b` is
     30 
     31 <!-- <equation class="equation" label="eq:kumaraswamy_mode" align="center" raw="\operatorname{mode}\left( X \right) = \left(\frac{a-1}{ab-1}\right)^{1/a}" alt="Mode for a Kumaraswamy's double bounded distribution."> -->
     32 
     33 <div class="equation" align="center" data-raw-text="\operatorname{mode}\left( X \right) = \left(\frac{a-1}{ab-1}\right)^{1/a}" data-equation="eq:kumaraswamy_mode">
     34     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/mode/docs/img/equation_kumaraswamy_mode.svg" alt="Mode for a Kumaraswamy's double bounded distribution.">
     35     <br>
     36 </div>
     37 
     38 <!-- </equation> -->
     39 
     40 for `a >= 1`, `b >=1` and not `a = b = 1`.
     41 
     42 </section>
     43 
     44 <!-- /.intro -->
     45 
     46 <!-- Package usage documentation. -->
     47 
     48 <section class="usage">
     49 
     50 ## Usage
     51 
     52 ```javascript
     53 var mode = require( '@stdlib/stats/base/dists/kumaraswamy/mode' );
     54 ```
     55 
     56 #### mode( a, b )
     57 
     58 Returns the [mode][mode] of a [Kumaraswamy's double bounded][kumaraswamy-distribution] distribution with first shape parameter `a` and second shape parameter `b`.
     59 
     60 ```javascript
     61 var v = mode( 1.5, 1.5 );
     62 // returns ~0.543
     63 
     64 v = mode( 4.0, 12.0 );
     65 // returns ~0.503
     66 
     67 v = mode( 2.0, 8.0 );
     68 // returns ~0.258
     69 ```
     70 
     71 If provided `NaN` as any argument, the function returns `NaN`.
     72 
     73 ```javascript
     74 var v = mode( NaN, 2.0 );
     75 // returns NaN
     76 
     77 v = mode( 2.0, NaN );
     78 // returns NaN
     79 ```
     80 
     81 If provided `a = 1` and `b = 1`, the function returns `NaN`.
     82 
     83 ```javascript
     84 var y = mode( 1.0, 1.0 );
     85 // returns NaN
     86 ```
     87 
     88 If provided `a < 1`, the function returns `NaN`.
     89 
     90 ```javascript
     91 var y = mode( -1.0, 2.0 );
     92 // returns NaN
     93 
     94 y = mode( 0.0, 2.0 );
     95 // returns NaN
     96 ```
     97 
     98 If provided `b < 1`, the function returns `NaN`.
     99 
    100 ```javascript
    101 var y = mode( 2.0, -1.0 );
    102 // returns NaN
    103 
    104 y = mode( 2.0, 0.0 );
    105 // returns NaN
    106 ```
    107 
    108 </section>
    109 
    110 <!-- /.usage -->
    111 
    112 <!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    113 
    114 <section class="notes">
    115 
    116 </section>
    117 
    118 <!-- /.notes -->
    119 
    120 <!-- Package usage examples. -->
    121 
    122 <section class="examples">
    123 
    124 ## Examples
    125 
    126 <!-- eslint no-undef: "error" -->
    127 
    128 ```javascript
    129 var randu = require( '@stdlib/random/base/randu' );
    130 var mode = require( '@stdlib/stats/base/dists/kumaraswamy/mode' );
    131 
    132 var a;
    133 var b;
    134 var v;
    135 var i;
    136 
    137 for ( i = 0; i < 10; i++ ) {
    138     a = randu() * 10.0;
    139     b = randu() * 10.0;
    140     v = mode( a, b );
    141     console.log( 'a: %d, b: %d, mode(X;a,b): %d', a.toFixed( 4 ), b.toFixed( 4 ), v.toFixed( 4 ) );
    142 }
    143 ```
    144 
    145 </section>
    146 
    147 <!-- /.examples -->
    148 
    149 <!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    150 
    151 <section class="references">
    152 
    153 </section>
    154 
    155 <!-- /.references -->
    156 
    157 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
    158 
    159 <section class="links">
    160 
    161 [kumaraswamy-distribution]: https://en.wikipedia.org/wiki/Kumaraswamy_distribution
    162 
    163 [mode]: https://en.wikipedia.org/wiki/Mode_%28statistics%29
    164 
    165 </section>
    166 
    167 <!-- /.links -->