Skip to content

Commit 6c55701

Browse files
chore: changes from code review
1 parent 2582806 commit 6c55701

File tree

5 files changed

+5
-28
lines changed

5 files changed

+5
-28
lines changed

lib/node_modules/@stdlib/stats/base/dists/erlang/variance/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ double y = stdlib_base_dists_beta_variance( 1.0, 1.0 );
180180

181181
The function accepts the following arguments:
182182

183-
- **k**: `[in] double` shape parameter
184-
- **lambda**: `[in] double` rate parameter
183+
- **k**: `[in] double` shape parameter.
184+
- **lambda**: `[in] double` rate parameter.
185185

186186
```c
187187
double stdlib_base_dists_erlang_variance( const double k, const double lambda );

lib/node_modules/@stdlib/stats/base/dists/erlang/variance/benchmark/c/benchmark.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ static double benchmark( void ) {
110110

111111
t = tic();
112112
for ( i = 0; i < ITERATIONS; i++ ) {
113-
y = stdlib_base_dists_erlang_variance( k[ i%100 ], lambda[ i%100 ] );
113+
y = stdlib_base_dists_erlang_variance( k[ i % 100 ], lambda[ i % 100 ] );
114114
if ( y != y ) {
115115
printf( "should not return NaN\n" );
116116
break;

lib/node_modules/@stdlib/stats/base/dists/erlang/variance/include/stdlib/stats/base/dists/erlang/variance.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-
* Retruns the excess variance for a erlang distribution with shape parameter `k` and rate parameter `lambda`.
30+
* Returns the variance for a erlang distribution with shape parameter `k` and rate parameter `lambda`.
3131
*/
3232
double stdlib_base_dists_erlang_variance( const double k, const double lambda );
3333

lib/node_modules/@stdlib/stats/base/dists/erlang/variance/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 variance of an Erlang distribution.
3030
*
31+
* @private
3132
* @param {PositiveInteger} k - shape parameter
3233
* @param {PositiveNumber} lambda - rate parameter
3334
* @returns {NonNegativeNumber} variance

lib/node_modules/@stdlib/stats/base/dists/erlang/variance/src/main.c

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -30,30 +30,6 @@
3030
* @example
3131
* double y = stdlib_base_dists_beta_variance( 1.0, 1.0 );
3232
* // returns ~1.0
33-
*
34-
* @example
35-
* double y = stdlib_base_dists_beta_variance( 4.0, 12.0 );
36-
* // returns ~0.028
37-
*
38-
* @example
39-
* double y = stdlib_base_dists_beta_variance( 8.0, 2.0 );
40-
* // returns ~2.0
41-
*
42-
* @example
43-
* double y = stdlib_base_dists_beta_variance( 1.0, -0.1 );
44-
* // returns NaN
45-
*
46-
* @example
47-
* double y = stdlib_base_dists_beta_variance( -0.1, 1.0 );
48-
* // returns NaN
49-
*
50-
* @example
51-
* double y = stdlib_base_dists_beta_variance( 2.0, NaN );
52-
* // returns NaN
53-
*
54-
* @example
55-
* double y = stdlib_base_dists_beta_variance( NaN, 2.0 );
56-
* // returns NaN
5733
*/
5834
double stdlib_base_dists_erlang_variance( const double k, const double lambda ) {
5935
if (

0 commit comments

Comments
 (0)