@stdlib/stats-base-dists-binomial-mean
v0.3.1
Published
Binomial distribution expected value.
Readme
Mean
Binomial distribution expected value.
The expected value for a binomial random variable is
where n is the number of trials and p is the success probability.
Installation
npm install @stdlib/stats-base-dists-binomial-meanUsage
var mean = require( '@stdlib/stats-base-dists-binomial-mean' );mean( n, p )
Returns the expected value of a binomial distribution with number of trials n and success probability p.
var v = mean( 20, 0.1 );
// returns 2.0
v = mean( 50, 0.5 );
// returns 25.0If provided NaN as any argument, the function returns NaN.
var v = mean( NaN, 0.5 );
// returns NaN
v = mean( 20, NaN );
// returns NaNIf provided a number of trials n which is not a nonnegative integer, the function returns NaN.
var v = mean( 1.5, 0.5 );
// returns NaN
v = mean( -2.0, 0.5 );
// returns NaNIf provided a success probability p outside of [0,1], the function returns NaN.
var v = mean( 20, -1.0 );
// returns NaN
v = mean( 20, 1.5 );
// returns NaNExamples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mean = require( '@stdlib/stats-base-dists-binomial-mean' );
var opts = {
'dtype': 'float64'
};
var n = discreteUniform( 10, 0, 100, opts );
var p = uniform( 10, 0.0, 1.0, opts );
logEachMap( 'n: %0.4f, p: %0.4f, E(X;n,p): %0.4f', n, p, mean );C APIs
Usage
#include "stdlib/stats/base/dists/binomial/mean.h"stdlib_base_dists_binomial_mean( n, p )
Returns the expected value of a binomial distribution with number of trials n and success probability p.
double out = stdlib_base_dists_binomial_mean( 100, 0.1 );
// returns 10.0The function accepts the following arguments:
- n:
[in] int32_tnumber of trials. - p:
[in] doublesuccess probability.
double stdlib_base_dists_binomial_mean( const int32_t n, const double p );Examples
#include "stdlib/stats/base/dists/binomial/mean.h"
#include "stdlib/math/base/special/ceil.h"
#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
static double random_uniform( const double min, const double max ) {
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
return min + ( v * (max - min) );
}
int main( void ) {
int32_t n;
double p;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
n = stdlib_base_ceil( random_uniform( 0.0, 100.0 ) );
p = random_uniform( 0.0, 1.0 );
y = stdlib_base_dists_binomial_mean( n, p );
printf( "n: %d, p: %lf, E(X;n,p): %lf\n", n, p, y );
}
return 0;
}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
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
