Skip to content

Commit 5a13cb4

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 9d5e362 commit 5a13cb4

File tree

5 files changed

+5
-18
lines changed

5 files changed

+5
-18
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ int main( void ) {
184184
for ( i = 0; i < 25; i++ ) {
185185
sigma = random_uniform( 0.0, 10.0 );
186186
y = stdlib_base_dists_rayleigh_stdev( sigma );
187-
printf( "σ: %lf, f(x;σ): %lf\n", sigma, y );
187+
printf( "σ: %lf, SD(X;σ): %lf\n", sigma, y );
188188
}
189189
}
190190
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ static double benchmark( void ) {
100100
int i;
101101

102102
for ( i = 0; i < 100; i++ ) {
103-
sigma[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
103+
sigma[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
104104
}
105105

106106
t = tic();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ int main( void ) {
3333
for ( i = 0; i < 25; i++ ) {
3434
sigma = random_uniform( 0 , 10.0 );
3535
y = stdlib_base_dists_rayleigh_stdev( sigma );
36-
printf( "σ: %lf, stdev(X;σ): %lf\n", sigma, y );
36+
printf( "σ: %lf, SD(X;σ): %lf\n", sigma, y );
3737
}
3838
}

lib/node_modules/@stdlib/stats/base/dists/rayleigh/stdev/src/addon.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@
1919
#include "stdlib/stats/base/dists/rayleigh/stdev.h"
2020
#include "stdlib/math/base/napi/unary.h"
2121

22-
// cppcheck-suppress shadowFunction
2322
STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_dists_rayleigh_stdev )

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,12 @@
2626
/**
2727
* Returns the standard deviation of a Rayleigh distribution.
2828
*
29-
* @param {NonNegativeNumber} sigma - scale parameter
30-
* @returns {NonNegativeNumber} standard deviation
29+
* @param sigma scale parameter
30+
* @return standard deviation
3131
*
3232
* @example
3333
* double v = stdlib_base_dists_rayleigh_stdev( 9.0 );
3434
* // returns ~5.896
35-
*
36-
* @example
37-
* double v = stdlib_base_dists_rayleigh_stdev( 2.0 );
38-
* // returns ~1.31
39-
*
40-
* @example
41-
* double v = stdlib_base_dists_rayleigh_stdev( -0.2 );
42-
* // returns NaN
43-
*
44-
* @example
45-
* double v = stdlib_base_dists_rayleigh_stdev( NaN );
46-
* // returns NaN
4735
*/
4836
double stdlib_base_dists_rayleigh_stdev( const double sigma ) {
4937
const double SQRT4MPI = stdlib_base_sqrt( 4 - STDLIB_CONSTANT_FLOAT64_PI );

0 commit comments

Comments
 (0)