@stdlib/stats-base-dists-beta-mean
v0.3.1
Published
Beta distribution expected value.
Readme
Mean
Beta distribution expected value.
The expected value for a beta random variable is
where α > 0 is the first shape parameter and β > 0 is the second shape parameter.
Installation
npm install @stdlib/stats-base-dists-beta-meanUsage
var mean = require( '@stdlib/stats-base-dists-beta-mean' );mean( alpha, beta )
Returns the expected value of a beta distribution with parameters alpha (first shape parameter) and beta (second shape parameter).
var v = mean( 1.0, 1.0 );
// returns 0.5
v = mean( 4.0, 12.0 );
// returns 0.25
v = mean( 8.0, 2.0 );
// returns 0.8If provided NaN as any argument, the function returns NaN.
var v = mean( NaN, 2.0 );
// returns NaN
v = mean( 2.0, NaN );
// returns NaNIf provided alpha <= 0, the function returns NaN.
var v = mean( 0.0, 1.0 );
// returns NaN
v = mean( -1.0, 1.0 );
// returns NaNIf provided beta <= 0, the function returns NaN.
var v = mean( 1.0, 0.0 );
// returns NaN
v = mean( 1.0, -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var EPS = require( '@stdlib/constants-float64-eps' );
var mean = require( '@stdlib/stats-base-dists-beta-mean' );
var opts = {
'dtype': 'float64'
};
var alpha = uniform( 10, EPS, 10.0, opts );
var beta = uniform( 10, EPS, 10.0, opts );
logEachMap( 'α: %0.4f, β: %0.4f, E(X;α,β): %0.4f', alpha, beta, mean );C APIs
Usage
#include "stdlib/stats/base/dists/beta/mean.h"stdlib_base_dists_beta_mean( alpha, beta )
Returns the expected value of a beta distribution with parameters alpha (first shape parameter) and beta (second shape parameter).
double out = stdlib_base_dists_beta_mean( 1.0, 1.0 );
// returns 0.5The function accepts the following arguments:
- alpha:
[in] doublefirst shape parameter. - beta:
[in] doublesecond shape parameter.
double stdlib_base_dists_beta_mean( const double alpha, const double beta );Examples
#include "stdlib/stats/base/dists/beta/mean.h"
#include "stdlib/constants/float64/eps.h"
#include <stdlib.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) ) + STDLIB_CONSTANT_FLOAT64_EPS;
}
int main( void ) {
double alpha;
double beta;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
alpha = random_uniform( 0.0, 10.0 );
beta = random_uniform( 0.0, 10.0 );
y = stdlib_base_dists_beta_mean( alpha, beta );
printf( "α: %lf, β: %lf, E(X;α,β): %lf\n", alpha, beta, y );
}
}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.
