Skip to content

Commit 68f4b92

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 62f11cb commit 68f4b92

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,8 @@ double out = stdlib_base_dists_cosine_stdev( 0.0, 1.0 );
166166

167167
The function accepts the following arguments:
168168

169-
- **mu**: `[in] int` location parameter
170-
- **s**: `[in] int` scale parameter
169+
- **mu**: `[in] int` location parameter.
170+
- **s**: `[in] int` scale parameter.
171171

172172
```c
173173
double stdlib_base_dists_cosine_stdev( const double mu, const double s );

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#include "stdlib/constants/float64/pi_squared.h"
2323

2424
/**
25-
* Returns the standard deviation of a Cosine distribution.
25+
* Returns the mode for a raised cosine distribution with location `mu` and scale `s`.
2626
*
2727
* @param mu location parameter
2828
* @param s scale parameter
@@ -33,9 +33,10 @@
3333
* // returns ~0.362
3434
*/
3535
double stdlib_base_dists_cosine_stdev( const double mu, const double s ) {
36-
if ( stdlib_base_is_nan( mu ) ||
37-
stdlib_base_is_nan( s ) ||
38-
s <= 0.0
36+
if (
37+
stdlib_base_is_nan( mu ) ||
38+
stdlib_base_is_nan( s ) ||
39+
s <= 0.0
3940
) {
4041
return 0.0/0.0; // NaN
4142
}

0 commit comments

Comments
 (0)