time-to-botec

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

README.md (3993B)

      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 # Logarithm of Probability Density Function
     22 
     23 > Evaluate the natural logarithm of the probability density function (PDF) for a [normal][normal-distribution] distribution.
     24 
     25 <section class="intro">
     26 
     27 The [probability density function][pdf] (PDF) for a [normal][normal-distribution] random variable is
     28 
     29 <!-- <equation class="equation" label="eq:normal_normal_pdf" align="center" raw="f(x;\mu,\sigma)=\frac{1}{\sigma\sqrt{2\pi}}\, e^{-\frac{(x - \mu)^2}{2 \sigma^2}}" alt="Probability density function (PDF) for a normal distribution."> -->
     30 
     31 <div class="equation" align="center" data-raw-text="f(x;\mu,\sigma)=\frac{1}{\sigma\sqrt{2\pi}}\, e^{-\frac{(x - \mu)^2}{2 \sigma^2}}" data-equation="eq:normal_normal_pdf">
     32     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@51534079fef45e990850102147e8945fb023d1d0/lib/node_modules/@stdlib/stats/base/dists/normal/logpdf/docs/img/equation_normal_normal_pdf.svg" alt="Probability density function (PDF) for a normal distribution.">
     33     <br>
     34 </div>
     35 
     36 <!-- </equation> -->
     37 
     38 where `µ` is the mean and `σ` is the standard deviation.
     39 
     40 </section>
     41 
     42 <!-- /.intro -->
     43 
     44 <section class="usage">
     45 
     46 ## Usage
     47 
     48 ```javascript
     49 var logpdf = require( '@stdlib/stats/base/dists/normal/logpdf' );
     50 ```
     51 
     52 #### logpdf( x, mu, sigma )
     53 
     54 Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [normal][normal-distribution] distribution with parameters `mu` (mean) and `sigma` (standard deviation).
     55 
     56 ```javascript
     57 var y = logpdf( 2.0, 0.0, 1.0 );
     58 // returns ~-2.919
     59 
     60 y = logpdf( -1.0, 4.0, 2.0 );
     61 // returns ~-4.737
     62 ```
     63 
     64 If provided `NaN` as any argument, the function returns `NaN`.
     65 
     66 ```javascript
     67 var y = logpdf( NaN, 0.0, 1.0 );
     68 // returns NaN
     69 
     70 y = logpdf( 0.0, NaN, 1.0 );
     71 // returns NaN
     72 
     73 y = logpdf( 0.0, 0.0, NaN );
     74 // returns NaN
     75 ```
     76 
     77 If provided `sigma < 0`, the function returns `NaN`.
     78 
     79 ```javascript
     80 var y = logpdf( 2.0, 0.0, -1.0 );
     81 // returns NaN
     82 ```
     83 
     84 If provided `sigma = 0`, the function evaluates the natural logarithm of the [PDF][pdf] of a [degenerate distribution][degenerate-distribution] centered at `mu`.
     85 
     86 ```javascript
     87 var y = logpdf( 2.0, 8.0, 0.0 );
     88 // returns -Infinity
     89 
     90 y = logpdf( 8.0, 8.0, 0.0 );
     91 // returns Infinity
     92 ```
     93 
     94 #### logpdf.factory( mu, sigma )
     95 
     96 Returns a `function` for evaluating the [probability density function][pdf] (PDF) of a [normal][normal-distribution] distribution with parameters `mu` (mean) and `sigma` (standard deviation).
     97 
     98 ```javascript
     99 var mylogpdf = logpdf.factory( 10.0, 2.0 );
    100 
    101 var y = mylogpdf( 10.0 );
    102 // returns ~-1.612
    103 
    104 y = mylogpdf( 5.0 );
    105 // returns ~-4.737
    106 ```
    107 
    108 </section>
    109 
    110 <!-- /.usage -->
    111 
    112 <section class="examples">
    113 
    114 ## Examples
    115 
    116 <!-- eslint no-undef: "error" -->
    117 
    118 ```javascript
    119 var randu = require( '@stdlib/random/base/randu' );
    120 var logpdf = require( '@stdlib/stats/base/dists/normal/logpdf' );
    121 
    122 var sigma;
    123 var mu;
    124 var x;
    125 var y;
    126 var i;
    127 
    128 for ( i = 0; i < 10; i++ ) {
    129     x = randu() * 10.0;
    130     mu = (randu() * 10.0) - 5.0;
    131     sigma = randu() * 20.0;
    132     y = logpdf( x, mu, sigma );
    133     console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x, mu, sigma, y );
    134 }
    135 ```
    136 
    137 </section>
    138 
    139 <!-- /.examples -->
    140 
    141 <section class="links">
    142 
    143 [pdf]: https://en.wikipedia.org/wiki/Probability_density_function
    144 
    145 [normal-distribution]: https://en.wikipedia.org/wiki/Normal_distribution
    146 
    147 [degenerate-distribution]: https://en.wikipedia.org/wiki/Degenerate_distribution
    148 
    149 </section>
    150 
    151 <!-- /.links -->