@stdlib/stats-base-dists-bernoulli-mode NPM

Mode

Bernoulli distribution mode.

The mode for a Bernoulli random variable is

where p is the success probability.

Installation

npm install @stdlib/stats-base-dists-bernoulli-mode

Usage

var mode = require( '@stdlib/stats-base-dists-bernoulli-mode' );

mode( p )

Returns the mode of a Bernoulli distribution with success probability p.

var v = mode( 0.1 );
// returns 0

v = mode( 0.5 );
// returns 0

v = mode( 0.8 );
// returns 1

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

var v = mode( NaN );
// returns NaN

v = mode( 1.5 );
// returns NaN

v = mode( -1.0 );
// returns NaN

Notes

For p = 0.5, the mode is either 0 or 1. This implementation returns 0 for p = 0.5.

Examples

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

var v;
var i;
var p;

for ( i = 0; i < 10; i++ ) {
    p = randu();
    v = mode( p );
    console.log( 'p: %d, Mode(X;p): %d', p.toFixed( 4 ), v.toFixed( 4 ) );
}

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.