diff --git a/lib/node_modules/@stdlib/stats/base/dists/t/quantile/README.md b/lib/node_modules/@stdlib/stats/base/dists/t/quantile/README.md index c3c3ef441379..45e396b13d69 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/t/quantile/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/t/quantile/README.md @@ -3,7 +3,7 @@ @license Apache-2.0 Copyright (c) 2018 The Stdlib Authors. - + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -143,6 +143,98 @@ for ( i = 0; i < 10; i++ ) { + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/dists/t/quantile.h" +``` + +#### stdlib_base_dists_t_quantile( v ) + +Returns the standard deviation of a Student's t distribution. + +```c +double out = stdlib_base_dists_t_quantile( 9.0 ); +// returns 0.0 +``` + +The function accepts the following arguments: + +- **v**: `[in] double` degrees of freedom. + +```c +double stdlib_base_dists_t_quantile( const double v ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/dists/t/quantile.h" +#include +#include + +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_quantile( v ); + printf( "v: %lf, SD(X;v): %lf\n", v, y ); + } +} +``` + +
+ + + +
+ + +