Skip to content

Commit 9a18379

Browse files
authored
docs: describe mu as location parameter in stats/base/dists/logistic/mgf
PR-URL: #12874 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent cbe79e4 commit 9a18379

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/logistic/mgf/include/stdlib/stats/base/dists/logistic/mgf.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-
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
30+
* Evaluates the moment-generating function (MGF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `t`.
3131
*/
3232
double stdlib_base_dists_logistic_mgf( const double t, const double mu, const double s );
3333

lib/node_modules/@stdlib/stats/base/dists/logistic/mgf/lib/factory.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ var abs = require( '@stdlib/math/base/special/abs' );
3131
// MAIN //
3232

3333
/**
34-
* Returns a function for evaluating the moment-generating function (MGF) of a logistic distribution with mean `mu` and scale parameter `s`.
34+
* Returns a function for evaluating the moment-generating function (MGF) of a logistic distribution with location parameter `mu` and scale parameter `s`.
3535
*
36-
* @param {number} mu - mean
36+
* @param {number} mu - location parameter
3737
* @param {NonNegativeNumber} s - scale parameter
3838
* @returns {Function} MGF
3939
*

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
2929
// MAIN //
3030

3131
/**
32-
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
32+
* Evaluates the moment-generating function (MGF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `t`.
3333
*
3434
* @param {number} t - input value
35-
* @param {number} mu - mean
35+
* @param {number} mu - location parameter
3636
* @param {NonNegativeNumber} s - scale parameter
3737
* @returns {number} evaluated MGF
3838
*

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
29+
* Evaluates the moment-generating function (MGF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `t`.
3030
*
3131
* @private
3232
* @param {number} t - input value
33-
* @param {number} mu - mean
33+
* @param {number} mu - location parameter
3434
* @param {NonNegativeNumber} s - scale parameter
3535
* @returns {number} evaluated MGF
3636
*

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
#include "stdlib/math/base/special/sinc.h"
2424

2525
/**
26-
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
26+
* Evaluates the moment-generating function (MGF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `t`.
2727
*
2828
* @param t input value
29-
* @param mu mean
29+
* @param mu location parameter
3030
* @param s scale parameter
3131
* @return evaluated MGF
3232
*

0 commit comments

Comments
 (0)