@stdlib/stats-base-dists-planck-variance
v0.1.1
Published
Planck distribution variance.
Readme
Variance
Planck distribution variance.
The variance for a Planck random variable is
where λ is the shape parameter.
Installation
npm install @stdlib/stats-base-dists-planck-varianceUsage
var variance = require( '@stdlib/stats-base-dists-planck-variance' );variance( lambda )
Returns the variance of a Planck distribution with shape parameter λ.
var v = variance( 0.1 );
// returns ~99.9167
v = variance( 1.5 );
// returns ~0.3697If provided a shape parameter λ which is nonpositive, the function returns NaN.
var v = variance( NaN );
// returns NaN
v = variance( -1.0 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var variance = require( '@stdlib/stats-base-dists-planck-variance' );
var opts = {
'dtype': 'float64'
};
var lambda = uniform( 10, 0.1, 10.0, opts );
logEachMap( 'λ: %0.4f, Var(X;λ): %0.4f', lambda, variance );C APIs
Usage
#include "stdlib/stats/base/dists/planck/variance.h"stdlib_base_dists_planck_variance( lambda )
Returns the variance of a Planck distribution with shape parameter lambda.
double out = stdlib_base_dists_planck_variance( 0.1 );
// returns ~99.9167The function accepts the following arguments:
- lambda:
[in] doubleshape parameter.
double stdlib_base_dists_planck_variance( const double lambda );Examples
#include "stdlib/stats/base/dists/planck/variance.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, 5.0 );
y = stdlib_base_dists_planck_variance( lambda );
printf( "λ: %lf, Var(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.
