README.md

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!

Logarithm of Probability Mass Function

Geometric distribution logarithm of probability mass function (PMF).

The probability mass function (PMF) for a geometric random variable is defined as

$$\Pr(X = x) = \begin{cases}(1-p)^{x}\,p & \text{ for } x=0,1,2,\ldots \\ 0 & \text{ otherwise } \end{cases}$$

where 0 <= p <= 1 is the success probability. The random variable X denotes the number of failures until the first success in a sequence of independent Bernoulli trials.

Usage

import logpmf from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-geometric-logpmf@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-geometric-logpmf@deno/mod.js';

logpmf( x, p )

Evaluates the logarithm of the probability mass function (PMF) of a geometric distribution with success probability 0 <= p <= 1.

var y = logpmf( 4.0, 0.3 );
// returns ~-2.631

y = logpmf( 2.0, 0.7 );
// returns ~-2.765

y = logpmf( -1.0, 0.5 );
// returns -Infinity

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

var y = logpmf( NaN, 0.0 );
// returns NaN

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

If provided a success probability p outside of the interval [0,1], the function returns NaN.

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

y = logpmf( 2.0, 1.5 );
// returns NaN

logpmf.factory( p )

Returns a function for evaluating the logarithm of the probability mass function (PMF) of a geometric distribution with success probability 0 <= p <= 1.

var mylogpmf = logpmf.factory( 0.5 );
var y = mylogpmf( 3.0 );
// returns ~-2.773

y = mylogpmf( 1.0 );
// returns ~-1.386

Notes

• In virtually all cases, using the logpmf or logcdf functions is preferable to manually computing the logarithm of the pmf or cdf, respectively, since the latter is prone to overflow and underflow.

Examples

import randu from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@deno/mod.js';
import round from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-round@deno/mod.js';
import logpmf from 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-base-dists-geometric-logpmf@deno/mod.js';

var p;
var x;
var y;
var i;

for ( i = 0; i < 10; i++ ) {
    x = round( randu() * 5.0 );
    p = randu();
    y = logpmf( x, p );
    console.log( 'x: %d, p: %d, ln( P( X = x; p ) ): %d', x, p.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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.