README

Probability Mass Function

Degenerate distribution probability mass function (PMF).

Installation

npm install @stdlib/stats-base-dists-degenerate-pmf

Usage

var pmf = require( '@stdlib/stats-base-dists-degenerate-pmf' );

pmf( x, mu )

Evaluates the PMF of a degenerate distribution centered at mu.

var y = pmf( 2.0, 8.0 );
// returns 0.0

y = pmf( 8.0, 8.0 );
// returns 1.0

pmf.factory( mu )

Returns a function for evaluating the PMF of a degenerate distribution centered at mu.

var mypmf = pmf.factory( 10.0 );

var y = mypmf( 10.0 );
// returns 1.0

y = mypmf( 5.0 );
// returns 0.0

y = mypmf( 12.0 );
// returns 0.0

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var pmf = require( '@stdlib/stats-base-dists-degenerate-pmf' );

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

for ( i = 0; i < 100; i++ ) {
    x = round( randu()*5.0 );
    mu = round( randu()*5.0 );
    y = pmf( x, mu );
    console.log( 'x: %d, µ: %d, P(X=x;µ): %d', x, mu, y );
}

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, 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

License

See LICENSE.

@stdlib/stats-base-dists-degenerate-pmf

Usage no npm install needed!