Skip to content

Commit d380b9a

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

File tree

5 files changed

+6
-5
lines changed

5 files changed

+6
-5
lines changed

lib/node_modules/@stdlib/stats/base/dists/geometric/mean/README.md

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

151151
#### stdlib_base_dists_geometric_mean( p )
152152

153-
Returns the mean of a geometric distribution.
153+
Returns the [expected value][expected-value] of a [geometric][geometric-distribution] distribution with success probability `p`.
154154

155155
```c
156156
double out = stdlib_base_dists_geometric_mean( 0.5 );

lib/node_modules/@stdlib/stats/base/dists/geometric/mean/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
p = random_uniform( 0.0, 1.0 );
3535
y = stdlib_base_dists_geometric_mean( p );
36-
printf( "p: %lf, E[X;p]: %lf\n", p, y );
36+
printf( "p: %lf, E(X;p): %lf\n", p, y );
3737
}
3838
}

lib/node_modules/@stdlib/stats/base/dists/geometric/mean/include/stdlib/stats/base/dists/geometric/mean.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 mean of a geometric distribution.
30+
* Returns the expected value of a geometric distribution.
3131
*/
3232
double stdlib_base_dists_geometric_mean( const double p );
3333

lib/node_modules/@stdlib/stats/base/dists/geometric/mean/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 expected value of a geometric distribution.
3030
*
31+
* @private
3132
* @param {Probability} p - success probability
3233
* @returns {NonNegativeNumber} expected value
3334
*

lib/node_modules/@stdlib/stats/base/dists/geometric/mean/src/main.c

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

2222
/**
23-
* Returns the mean of a geometric distribution.
23+
* Returns the expected value of a geometric distribution.
2424
*
2525
* @param p success probability
26-
* @return mean
26+
* @return expected value
2727
*
2828
* @example
2929
* double y = stdlib_base_dists_geometric_mean( 0.1 );

0 commit comments

Comments
 (0)