Standard Deviation
Normal distribution standard deviation.
Usage
var stdev = require( '@stdlib/stats/base/dists/normal/stdev' );
stdev( mu, sigma )
Returns the standard deviation for a normal distribution with parameters mu
(mean) and sigma
(standard deviation).
var y = stdev( 2.0, 1.0 );
// returns 1.0
y = stdev( -1.0, 4.0 );
// returns 4.0
If provided NaN
as any argument, the function returns NaN
.
var y = stdev( NaN, 1.0 );
// returns NaN
y = stdev( 0.0, NaN );
// returns NaN
If provided sigma <= 0
, the function returns NaN
.
var y = stdev( 0.0, 0.0 );
// returns NaN
y = stdev( 0.0, -1.0 );
// returns NaN
Examples
var randu = require( '@stdlib/random/base/randu' );
var stdev = require( '@stdlib/stats/base/dists/normal/stdev' );
var sigma;
var mu;
var y;
var i;
for ( i = 0; i < 10; i++ ) {
mu = ( randu()*10.0 ) - 5.0;
sigma = randu() * 20.0;
y = stdev( mu, sigma );
console.log( 'µ: %d, σ: %d, SD(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
}
C APIs
Usage
#include "stdlib/stats/base/dists/normal/stdev.h"
stdlib_base_dists_normal_stdev( mu, sigma )
Evaluates the standard deviation for a normal distribution with mean mu
and standard deviation sigma
.
double out = stdlib_base_dists_normal_stdev( 0.0, 1.0 );
// returns ~1.4189
The function accepts the following arguments:
- mu:
[in] double
mean. - sigma:
[in] double
standard deviation.
double stdlib_base_dists_normal_stdev( const double mu, const double sigma );
Examples
#include "stdlib/stats/base/dists/normal/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 mu;
double sigma;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.1, 20.0 );
y = stdlib_base_dists_normal_stdev( mu, sigma );
printf( "µ: %.4f, σ: %.4f, SD(X;µ,σ): %.4f\n", mu, sigma, y );
}
}