time-to-botec

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

README.md (3736B)

      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 # Cumulative Distribution Function
     22 
     23 > [Cauchy][cauchy-distribution] distribution [cumulative distribution function][cdf].
     24 
     25 <section class="intro">
     26 
     27 The [cumulative distribution function][cdf] for a [Cauchy][cauchy-distribution] random variable is
     28 
     29 <!-- <equation class="equation" label="eq:cauchy_cdf" align="center" raw="F(x; x_0,\gamma)=\frac{1}{\pi} \operatorname{arctan} \left(\frac{x-x_0}{\gamma}\right)+\frac{1}{2}" alt="Cumulative distribution function for a Cauchy distribution."> -->
     30 
     31 <div class="equation" align="center" data-raw-text="F(x; x_0,\gamma)=\frac{1}{\pi} \operatorname{arctan} \left(\frac{x-x_0}{\gamma}\right)+\frac{1}{2}" data-equation="eq:cauchy_cdf">
     32     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/docs/img/equation_cauchy_cdf.svg" alt="Cumulative distribution function for a Cauchy distribution.">
     33     <br>
     34 </div>
     35 
     36 <!-- </equation> -->
     37 
     38 where `x0` is the location parameter and `gamma > 0` is the scale parameter.
     39 
     40 </section>
     41 
     42 <!-- /.intro -->
     43 
     44 <section class="usage">
     45 
     46 ## Usage
     47 
     48 ```javascript
     49 var cdf = require( '@stdlib/stats/base/dists/cauchy/cdf' );
     50 ```
     51 
     52 #### cdf( x, x0, gamma )
     53 
     54 Evaluates the [cumulative distribution function][cdf] (CDF) for a [Cauchy][cauchy-distribution] distribution with parameters `x0` (location parameter) and `gamma > 0` (scale parameter).
     55 
     56 ```javascript
     57 var y = cdf( 4.0, 0.0, 2.0 );
     58 // returns ~0.852
     59 
     60 y = cdf( 1.0, 0.0, 2.0 );
     61 // returns ~0.648
     62 
     63 y = cdf( 1.0, 3.0, 2.0 );
     64 // returns 0.25
     65 ```
     66 
     67 If provided `NaN` as any argument, the function returns `NaN`.
     68 
     69 ```javascript
     70 var y = cdf( NaN, 0.0, 2.0 );
     71 // returns NaN
     72 
     73 y = cdf( 1.0, 2.0, NaN );
     74 // returns NaN
     75 
     76 y = cdf( 1.0, NaN, 3.0 );
     77 // returns NaN
     78 ```
     79 
     80 If provided `gamma <= 0`, the function returns `NaN`.
     81 
     82 ```javascript
     83 var y = cdf( 2.0, 0.0, -1.0 );
     84 // returns NaN
     85 
     86 y = cdf( 2.0, 0.0, 0.0 );
     87 // returns NaN
     88 ```
     89 
     90 #### cdf.factory( x0, gamma )
     91 
     92 Returns a function for evaluating the [cumulative distribution function][cdf] of a [Cauchy][cauchy-distribution] distribution with parameters `x0` (location parameter) and `gamma > 0` (scale parameter).
     93 
     94 ```javascript
     95 var mycdf = cdf.factory( 10.0, 2.0 );
     96 
     97 var y = mycdf( 10.0 );
     98 // returns 0.5
     99 
    100 y = mycdf( 12.0 );
    101 // returns 0.75
    102 ```
    103 
    104 </section>
    105 
    106 <!-- /.usage -->
    107 
    108 <section class="examples">
    109 
    110 ## Examples
    111 
    112 <!-- eslint no-undef: "error" -->
    113 
    114 ```javascript
    115 var randu = require( '@stdlib/random/base/randu' );
    116 var EPS = require( '@stdlib/constants/float64/eps' );
    117 var cdf = require( '@stdlib/stats/base/dists/cauchy/cdf' );
    118 
    119 var gamma;
    120 var x0;
    121 var x;
    122 var y;
    123 var i;
    124 
    125 for ( i = 0; i < 10; i++ ) {
    126     x = randu() * 10.0;
    127     x0 = randu() * 10.0;
    128     gamma = ( randu()*10.0 ) + EPS;
    129     y = cdf( x, x0, gamma );
    130     console.log( 'x: %d, x0: %d, γ: %d, F(x;x0,γ): %d', x.toFixed( 4 ), x0.toFixed( 4 ), gamma.toFixed( 4 ), y.toFixed( 4 ) );
    131 }
    132 ```
    133 
    134 </section>
    135 
    136 <!-- /.examples -->
    137 
    138 <section class="links">
    139 
    140 [cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
    141 
    142 [cauchy-distribution]: https://en.wikipedia.org/wiki/Cauchy_distribution
    143 
    144 </section>
    145 
    146 <!-- /.links -->