0.2.0 • Published 3 months ago

@stdlib/stats-base-dists-discrete-uniform-mean v0.2.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
3 months ago

Mean

NPM version Build Status Coverage Status

Discrete uniform distribution expected value.

The expected value for a discrete uniform random variable is

where a is the minimum support and b the maximum support of the distribution.

Installation

npm install @stdlib/stats-base-dists-discrete-uniform-mean

Usage

var mean = require( '@stdlib/stats-base-dists-discrete-uniform-mean' );

mean( a, b )

Returns the expected value of a discrete uniform distribution with parameters a (minimum support) and b (maximum support).

var v = mean( 0, 1 );
// returns 0.5

v = mean( 4, 12 );
// returns 8.0

v = mean( 2, 8 );
// returns 5.0

If a or b is not an integer value, the function returns NaN.

var v = mean( 0.1, 2 );
// returns NaN

v = mean( 0, 2.2 );
// returns NaN

v = mean( NaN, 2 );
// returns NaN

v = mean( 2, NaN );
// returns NaN

If provided a > b, the function returns NaN.

var y = mean( 3, 2 );
// returns NaN

y = mean( -1, -2 );
// 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-discrete-uniform-mean' );

var a;
var b;
var v;
var i;

for ( i = 0; i < 10; i++ ) {
    a = round( randu()*10.0 );
    b = round( ( randu()*10.0 ) + a );
    v = mean( a, b );
    console.log( 'a: %d, b: %d, E(X;a,b): %d', a.toFixed( 4 ), b.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-2024. The Stdlib Authors.