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