@stdlib/stats-base-dists-t-stdev
v0.3.1
Published
Student's t distribution standard deviation.
Readme
Standard Deviation
Student's t distribution standard deviation.
The standard deviation for a Student's t random variable with degrees of freedom ν is
For ν smaller than one, the standard deviation is not defined.
Installation
npm install @stdlib/stats-base-dists-t-stdevUsage
var stdev = require( '@stdlib/stats-base-dists-t-stdev' );stdev( v )
Returns the standard deviation of a Student's t distribution with degrees of freedom v.
var y = stdev( 9.0 );
// returns ~1.134
y = stdev( 3.5 );
// returns ~1.528If provided 1 < v <= 2, the function returns infinity.
var y = stdev( 1.5 );
// returns Infinity
y = stdev( 2.0 );
// returns InfinityIf provided v <= 1, the function returns NaN.
var y = stdev( -1.0 );
// returns NaN
y = stdev( 0.8 );
// returns NaNExamples
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var stdev = require( '@stdlib/stats-base-dists-t-stdev' );
var opts = {
'dtype': 'float64'
};
var v = uniform( 10, 0.0, 20.0, opts );
logEachMap( 'v: %0.4f, SD(X;v): %0.4f', v, stdev );C APIs
Usage
#include "stdlib/stats/base/dists/t/stdev.h"stdlib_base_dists_t_stdev( v )
Returns the standard deviation of a Student's t distribution.
double out = stdlib_base_dists_t_stdev( 9.0 );
// returns ~1.134The function accepts the following arguments:
- v:
[in] doubledegrees of freedom.
double stdlib_base_dists_t_stdev( const double v );Examples
#include "stdlib/stats/base/dists/t/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 v;
double y;
int i;
for ( i = 0; i < 25; i++ ) {
v = random_uniform( 0.0, 20.0 );
y = stdlib_base_dists_t_stdev( v );
printf( "v: %lf, SD(X;v): %lf\n", v, 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.
