Skip to content

Commit 023fcd3

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 7575fc3 commit 023fcd3

File tree

4 files changed

+18
-5
lines changed

4 files changed

+18
-5
lines changed

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

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ for ( i = 0; i < 10; i++ ) {
145145

146146
#### stdlib_base_dists_rayleigh_kurtosis( sigma )
147147

148-
Evaluates the skewness for a Rayleigh distribution.
148+
Returns the [excess kurtosis][kurtosis] of a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`.
149149

150150
```c
151151
double out = stdlib_base_dists_rayleigh_kurtosis( 9.0 );
@@ -161,30 +161,42 @@ double stdlib_base_dists_rayleigh_kurtosis( const double sigma );
161161
```
162162
163163
</section>
164+
164165
<!-- /.usage -->
166+
165167
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
168+
166169
<section class="notes">
170+
167171
</section>
172+
168173
<!-- /.notes -->
174+
169175
<!-- C API usage examples. -->
176+
170177
<section class="examples">
178+
171179
### Examples
180+
172181
```c
173182
#include "stdlib/stats/base/dists/rayleigh/kurtosis.h"
174183
#include <stdlib.h>
175184
#include <stdio.h>
185+
176186
static double random_uniform( const double min, const double max ) {
177187
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
178188
return min + ( v*(max-min) );
179189
}
190+
180191
int main( void ) {
181192
double sigma;
182193
double y;
183194
int i;
195+
184196
for ( i = 0; i < 25; i++ ) {
185197
sigma = random_uniform( 0.0, 10.0 );
186198
y = stdlib_base_dists_rayleigh_skewness( sigma );
187-
printf( "σ: %lf, f(x;σ): %lf\n", sigma, y );
199+
printf( "σ: %lf, Kurt(X,σ): %lf\n", sigma, y );
188200
}
189201
}
190202
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ int main( void ) {
3131
int i;
3232

3333
for ( i = 0; i < 25; i++ ) {
34-
sigma = random_uniform( 0 , 10.0 );
34+
sigma = random_uniform( 0.0, 10.0 );
3535
y = stdlib_base_dists_rayleigh_kurtosis( sigma );
36-
printf( "σ: %lf, kurtosis(X;σ): %lf\n", sigma, y );
36+
printf( "σ: %lf, Kurt(X,σ): %lf\n", sigma, y );
3737
}
3838
}

lib/node_modules/@stdlib/stats/base/dists/rayleigh/kurtosis/include/stdlib/stats/base/dists/rayleigh/kurtosis.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Returns the kurtosis for a Rayleigh distribution.
30+
* Returns the excess kurtosis of a Rayleigh distribution.
3131
*/
3232
double stdlib_base_dists_rayleigh_kurtosis( const double sigma );
3333

lib/node_modules/@stdlib/stats/base/dists/rayleigh/kurtosis/lib/native.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var addon = require( './../src/addon.node' );
2828
/**
2929
* Returns the excess kurtosis of a Rayleigh distribution.
3030
*
31+
* @private
3132
* @param {NonNegativeNumber} sigma - scale parameter
3233
* @returns {NonNegativeNumber} excess kurtosis
3334
*

0 commit comments

Comments
 (0)