@stdlib/stats-base-dists-planck-mean
v0.1.1
Published
Planck distribution expected value.
Readme
Mean
Planck distribution expected value.
The expected value for a Planck random variable is
where λ is the shape parameter.
Installation
npm install @stdlib/stats-base-dists-planck-meanUsage
var mean = require( '@stdlib/stats-base-dists-planck-mean' );mean( lambda )
Returns the expected value of a Planck distribution with shape parameter lambda.
var v = mean( 0.1 );
// returns ~9.5083
v = mean( 0.5 );
// returns ~1.5415If provided a shape parameter lambda which is nonpositive or NaN, the function returns NaN.
var v = mean( NaN );
// returns NaN
v = mean( -1.5 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var mean = require( '@stdlib/stats-base-dists-planck-mean' );
var opts = {
'dtype': 'float64'
};
var lambda = uniform( 10, 0.1, 10.0, opts );
logEachMap( 'λ: %0.4f, E(X;λ): %0.4f', lambda, mean );C APIs
Usage
#include "stdlib/stats/base/dists/planck/mean.h"stdlib_base_dists_planck_mean( lambda )
Returns the expected value of a Planck distribution with shape parameter lambda.
double out = stdlib_base_dists_planck_mean( 0.1 );
// returns ~9.5083The function accepts the following arguments:
- lambda:
[in] doubleshape parameter.
double stdlib_base_dists_planck_mean( const double lambda );Examples
#include "stdlib/stats/base/dists/planck/mean.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) );
}
int main( void ) {
double lambda;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
lambda = random_uniform( 0.1, 10.0 );
y = stdlib_base_dists_planck_mean( lambda );
printf( "λ: %lf, E(X;λ): %lf\n", lambda, 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.
