Skip to content

Latest commit

 

History

History
251 lines (157 loc) · 8.08 KB

README.md

File metadata and controls

251 lines (157 loc) · 8.08 KB
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Probability Density Function

NPM version Build Status Coverage Status

Laplace distribution probability density function (PDF).

The probability density function (PDF) for a Laplace random variable is

$$f(x\mid\mu,b) = \frac{1}{2b} \exp \left( -\frac{|x-\mu|}{b} \right)$$

where mu is the location parameter and b > 0 is the scale parameter (also called diversity).

Usage

import pdf from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-laplace-pdf@deno/mod.js';

You can also import the following named exports from the package:

import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-laplace-pdf@deno/mod.js';

pdf( x, mu, b )

Evaluates the probability density function (PDF) for a Laplace distribution with parameters mu (location parameter) and b > 0 (scale parameter).

var y = pdf( 2.0, 0.0, 1.0 );
// returns ~0.068

y = pdf( -1.0, 2.0, 3.0 );
// returns ~0.061

y = pdf( 2.5, 2.0, 3.0 );
// returns ~0.141

If provided NaN as any argument, the function returns NaN.

var y = pdf( NaN, 0.0, 1.0 );
// returns NaN

y = pdf( 0.0, NaN, 1.0 );
// returns NaN

y = pdf( 0.0, 0.0, NaN );
// returns NaN

If provided b <= 0, the function returns NaN.

var y = pdf( 2.0, 0.0, -1.0 );
// returns NaN

y = pdf( 2.0, 8.0, 0.0 );
// returns NaN

pdf.factory( mu, b )

Returns a function for evaluating the PDF of a Laplace distribution with parameters mu (location parameter) and b > 0 (scale parameter).

var mypdf = pdf.factory( 10.0, 2.0 );

var y = mypdf( 10.0 );
// returns 0.25

y = mypdf( 5.0 );
// returns ~0.021

y = mypdf( 12.0 );
// returns ~0.092

Examples

import randu from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@deno/mod.js';
import pdf from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-laplace-pdf@deno/mod.js';

var mu;
var b;
var x;
var y;
var i;

for ( i = 0; i < 100; i++ ) {
    x = randu() * 10.0;
    mu = randu() * 10.0;
    b = randu() * 10.0;
    y = pdf( x, mu, b );
    console.log( 'x: %d, µ: %d, b: %d, f(x;µ,b): %d', x.toFixed( 4 ), mu.toFixed( 4 ), b.toFixed( 4 ), y.toFixed( 4 ) );
}

Notice

This package is part of stdlib, a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.