@stdlib/stats-base-dists-geometric-mode
TypeScript icon, indicating that this package has built-in type declarations

0.0.8 • Public • Published

Mode

NPM version Build Status Coverage Status

Geometric distribution mode.

The mode for a geometric random variable with success probability p is

Mode for a geometric distribution.

Installation

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

Usage

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

mode( p )

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

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

v = mode( 0.5 );
// returns 0

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

Examples

var randu = require( '@stdlib/random-base-randu' );
var round = require( '@stdlib/math-base-special-round' );
var mode = require( '@stdlib/stats-base-dists-geometric-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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.

Install

npm i @stdlib/stats-base-dists-geometric-mode

Homepage

stdlib.io

DownloadsWeekly Downloads

61

Version

0.0.8

License

Apache-2.0

Unpacked Size

29 kB

Total Files

10

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser