Skip to content

Commit 86a34e3

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent adbb5f4 commit 86a34e3

File tree

8 files changed

+15
-27
lines changed

8 files changed

+15
-27
lines changed

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -146,10 +146,10 @@ for ( i = 0; i < 10; i++ ) {
146146

147147
#### stdlib_base_dists_poisson_stdev( lambda )
148148

149-
Evaluates the standard deviation of a Poisson distribution.
149+
Returns the [standard deviation][standard-deviation] of a [Poisson][poisson-distribution] distribution with mean parameter `lambda`.
150150

151151
```c
152-
double out = sstdlib_base_dists_poisson_stdev( 9.0 );
152+
double out = stdlib_base_dists_poisson_stdev( 9.0 );
153153
// returns 3.0
154154
```
155155

@@ -197,7 +197,7 @@ int main( void ) {
197197
for ( i = 0; i < 10; i++ ) {
198198
lambda = random_uniform( 0.0, 10.0 );
199199
y = stdlib_base_dists_poisson_stdev( lambda );
200-
printf( "\u03bb: %.4f, SD(X;\u03bb): %.4f\n", lambda, y );
200+
printf( "λ: %.4f, SD(X;λ): %.4f\n", lambda, y );
201201
}
202202
}
203203
```

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/benchmark/benchmark.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var Float64Array = require( '@stdlib/array/float64' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
2626
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2727
var EPS = require( '@stdlib/constants/float64/eps' );
2828
var pkg = require( './../package.json' ).name;
@@ -40,7 +40,7 @@ bench( pkg, function benchmark( b ) {
4040
len = 100;
4141
lambda = new Float64Array( len );
4242
for ( i = 0; i < len; i++ ) {
43-
lambda[ i ] = ( randu() * 20.0 ) + EPS;
43+
lambda[ i ] = uniform( EPS, 20.0 );
4444
}
4545

4646
b.tic();

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/benchmark/benchmark.native.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
2525
var Float64Array = require( '@stdlib/array/float64' );
26-
var randu = require( '@stdlib/random/base/randu' );
26+
var uniform = require( '@stdlib/random/base/uniform' );
2727
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2828
var tryRequire = require( '@stdlib/utils/try-require' );
2929
var EPS = require( '@stdlib/constants/float64/eps' );
@@ -49,7 +49,7 @@ bench( pkg+'::native', opts, function benchmark( b ) {
4949
len = 100;
5050
lambda = new Float64Array( len );
5151
for ( i = 0; i < len; i++ ) {
52-
lambda[ i ] = ( randu() * 20.0 ) + EPS;
52+
lambda[ i ] = uniform( EPS, 20.0 );
5353
}
5454
b.tic();
5555
for ( i = 0; i < b.iterations; i++ ) {

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/benchmark/c/benchmark.c

+3-3
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,18 @@ static double random_uniform( const double min, const double max ) {
9393
*/
9494
static double benchmark( void ) {
9595
double elapsed;
96-
double lambda[100];
96+
double lambda[ 100 ];
9797
double y;
9898
double t;
9999
int i;
100100

101101
for ( i = 0; i < 100; i++ ) {
102-
lambda[i] = random_uniform(0.0, 20.0);
102+
lambda[i] = random_uniform( 0.0, 20.0 );
103103
}
104104

105105
t = tic();
106106
for ( i = 0; i < ITERATIONS; i++ ) {
107-
y = stdlib_base_dists_poisson_stdev(lambda[i%100]);
107+
y = stdlib_base_dists_poisson_stdev( lambda[ i % 100 ] );
108108
if ( y != y ) {
109109
printf( "should not return NaN\n" );
110110
break;

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/examples/c/example.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ int main( void ) {
3333
for ( i = 0; i < 10; i++ ) {
3434
lambda = random_uniform( 0.0, 20.0 );
3535
y = stdlib_base_dists_poisson_stdev( lambda );
36-
printf( "\u03bb: %.4f, SD(X;\u03bb): %.4f\n", lambda, y );
36+
printf( "λ: %.4f, SD(X;λ): %.4f\n", lambda, y );
3737
}
3838
}

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/include/stdlib/stats/base/dists/poisson/stdev.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Evaluates the standard deviation of a Poisson distribution with parameter `lambda`.
30+
* Returns the standard deviation of a Poisson distribution with parameter `lambda`.
3131
*/
3232
double stdlib_base_dists_poisson_stdev( const double lambda );
3333

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/lib/native.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the standard deviation of a Poisson distribution.
29+
* Returns the standard deviation of a Poisson distribution with parameter `lambda`.
3030
*
3131
* @private
3232
* @param {NonNegativeNumber} lambda - mean parameter

lib/node_modules/@stdlib/stats/base/dists/poisson/stdev/src/main.c

+2-14
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,12 @@
2323
/**
2424
* Returns the standard deviation of a Poisson distribution with parameter `lambda`.
2525
*
26-
* @param lambda mean parameter of the distribution
27-
* @return standard deviation of the Poisson distribution
26+
* @param lambda mean parameter
27+
* @return standard deviation
2828
*
2929
* @example
3030
* double y = stdlib_base_dists_poisson_stdev( 9.0 );
3131
* // returns 3.0
32-
*
33-
* @example
34-
* double y = stdlib_base_dists_poisson_stdev( 1.0 );
35-
* // returns 1.0
36-
*
37-
* @example
38-
* double y = stdlib_base_dists_poisson_stdev( -0.2 );
39-
* // returns NaN
40-
*
41-
* @example
42-
* double y = stdlib_base_dists_poisson_stdev( NAN );
43-
* // returns NaN
4432
*/
4533
double stdlib_base_dists_poisson_stdev( const double lambda ) {
4634
if (

0 commit comments

Comments
 (0)