Skip to content

Commit 85f541e

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

File tree

5 files changed

+10
-9
lines changed

5 files changed

+10
-9
lines changed

lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,8 @@ for ( i = 0; i < 10; i++ ) {
186186

187187
#### stdlib_base_dists_gumbel_median( t, mu, beta )
188188

189-
Evaluates the moment-generating function (MGF) for a Gumbel distribution
189+
Evaluates the [moment-generating function][mgf] (MGF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter).
190+
190191

191192
```c
192193
double out = stdlib_base_dists_gumbel_mgf( -1.0, 0.0, 1.0 );
@@ -196,7 +197,7 @@ double out = stdlib_base_dists_gumbel_mgf( -1.0, 0.0, 1.0 );
196197
The function accepts the following arguments:
197198

198199
- **t**: `[in] double` input value.
199-
- **mu**: `[in] double` mean.
200+
- **mu**: `[in] double` location parameter.
200201
- **beta**: `[in] double` scale parameter.
201202

202203
```c
@@ -243,7 +244,7 @@ int main( void ) {
243244
mu = random_uniform( 0.0, 10.0 );
244245
beta = random_uniform( 0.0, 10.0 );
245246
y = stdlib_base_dists_gumbel_mgf( t, mu, beta );
246-
printf( "x: %lf, µ: %lf, β: %lf, F(x;µ,β): %lf\n", t, mu, beta, y );
247+
printf( "t: %lf, µ: %lf, β: %lf, M_X(t;µ,β): %lf\n", t, mu, beta, y );
247248
}
248249
}
249250
```

lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@ int main( void ) {
3737
mu = random_uniform( 0.0, 10.0 );
3838
beta = random_uniform( 0.0, 10.0 );
3939
y = stdlib_base_dists_gumbel_mgf( t, mu, beta );
40-
printf( "x: %lf, µ: %lf, β: %lf, F(x;µ,β): %lf\n", t, mu, beta, y );
40+
printf( "t: %lf, µ: %lf, β: %lf, M_X(t;µ,β): %lf\n", t, mu, beta, y );
4141
}
4242
}

lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var exp = require( '@stdlib/math/base/special/exp' );
3333
* @param {number} t - input value
3434
* @param {number} mu - mean
3535
* @param {PositiveNumber} beta - scale parameter
36-
* @returns {number} mgf
36+
* @returns {number} evaluated MGF
3737
*
3838
* @example
3939
* var y = mgf( -1.0, 0.0, 3.0 );

lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var addon = require( './../src/addon.node' );
3030
*
3131
* @private
3232
* @param {number} t - input value
33-
* @param {number} mu - mean
33+
* @param {number} mu - location parameter
3434
* @param {PositiveNumber} beta - scale parameter
3535
* @returns {number} mgf
3636
*

lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/src/main.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525
* Evaluates the moment-generating function (MGF) for a Gumbel distribution with location parameter `mu` and scale parameter `b` at a value `t`.
2626
*
2727
* @param t input value
28-
* @param mu mean
29-
* @param beta sclae parameter
28+
* @param mu location parameter
29+
* @param beta scale parameter
3030
* @return evaluated MGF
3131
*
3232
* @example
33-
* double y = stdlib_base_gumbel_mgf( -1.0, 0.0, 3.0 );
33+
* double y = stdlib_base_dists_gumbel_mgf( -1.0, 0.0, 3.0 );
3434
* // returns 6.0
3535
*/
3636
double stdlib_base_dists_gumbel_mgf( const double t, const double mu, const double beta ) {

0 commit comments

Comments
 (0)