time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/geometric/mean
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00
..
docs feat: add the node modules 2022-12-03 12:44:49 +00:00
lib feat: add the node modules 2022-12-03 12:44:49 +00:00
package.json feat: add the node modules 2022-12-03 12:44:49 +00:00
README.md feat: add the node modules 2022-12-03 12:44:49 +00:00

Mean

Geometric distribution expected value.

The expected value for a geometric random variable is

Expected value for a geometric distribution.

where p is the success probability.

Usage

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

mean( p )

Returns the expected value of a geometric distribution with success probability p.

var v = mean( 0.1 );
// returns 9.0

v = mean( 0.5 );
// returns 1.0

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

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

v = mean( 1.5 );
// returns NaN

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

Examples

var randu = require( '@stdlib/random/base/randu' );
var round = require( '@stdlib/math/base/special/round' );
var mean = require( '@stdlib/stats/base/dists/geometric/mean' );

var v;
var i;
var p;

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