Skip to content

Commit ee3fcd4

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

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ for ( i = 0; i < 10; i++ ) {
139139

140140
#### stdlib_base_dists_degenerate_stdev( mu )
141141

142-
Returns the standard deviation of a degenerate distribution.
142+
Returns the [standard deviation][standard-deviation] of a [degenerate][degenerate-distribution] distribution with constant value `mu`.
143143

144144
```c
145145
double out = stdlib_base_dists_degenerate_stdev( 0.1 );

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616
* limitations under the License.
1717
*/
1818

19-
#include <sys/time.h>
2019
#include "stdlib/stats/base/dists/degenerate/stdev.h"
2120
#include <math.h>
2221
#include <stdio.h>
2322
#include <stdlib.h>
2423
#include <time.h>
24+
#include <sys/time.h>
2525

2626
#define NAME "degenerate-stdev"
2727
#define ITERATIONS 1000000
@@ -74,7 +74,7 @@ static double benchmark( void ) {
7474
start = tic();
7575
for ( i = 0; i < ITERATIONS; i++ ) {
7676
y = stdlib_base_dists_degenerate_stdev( mu[ i % 100 ] );
77-
if ( isnan( y ) ) { // Check for NaN
77+
if ( isnan( y ) ) {
7878
printf( "should not return NaN\n" );
7979
break;
8080
}

lib/node_modules/@stdlib/stats/base/dists/degenerate/stdev/include/stdlib/stats/base/dists/degenerate/stdev.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 standard deviation of a degenerate distribution.
30+
* Returns the standard deviation of a degenerate distribution centered at `mu`.
3131
*
3232
* @param mu constant value of the distribution
3333
* @return standard deviation

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
#include "stdlib/math/base/assert/is_nan.h"
2020

2121
/**
22-
* Returns the standard deviation of a degenerate distribution.
22+
* Returns the standard deviation of a degenerate distribution centered at `mu`.
2323
*
2424
* @param mu constant value of the distribution
25-
* @return standard deviation, or NaN if input is invalid
25+
* @return standard deviation
2626
*
2727
* @example
2828
* double v = stdlib_base_dists_degenerate_stdev( 0.1 );

0 commit comments

Comments
 (0)