Skip to content

Commit 746c8bf

Browse files
committed
chore: minor clean-up
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent c1ab60f commit 746c8bf

File tree

6 files changed

+27
-43
lines changed

6 files changed

+27
-43
lines changed

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ double out = stdlib_base_dists_logistic_mgf( 0.9, 0.0, 1.0 );
189189

190190
The function accepts the following arguments:
191191

192-
- **t**: `[in] double` value parameter.
192+
- **t**: `[in] double` input value.
193193
- **mu**: `[in] double` location parameter.
194194
- **s**: `[in] double` scale parameter.
195195

@@ -198,34 +198,46 @@ double stdlib_base_dists_logistic_mgf( const double t, const double mu, const do
198198
```
199199
200200
</section>
201+
201202
<!-- /.usage -->
203+
202204
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
205+
203206
<section class="notes">
207+
204208
</section>
209+
205210
<!-- /.notes -->
211+
206212
<!-- C API usage examples. -->
213+
207214
<section class="examples">
215+
208216
### Examples
217+
209218
```c
210219
#include "stdlib/stats/base/dists/logistic/mgf.h"
211220
#include <stdlib.h>
212221
#include <stdio.h>
222+
213223
static double random_uniform( const double min, const double max ) {
214224
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
215225
return min + ( v * ( max-min ) );
216226
}
227+
217228
int main( void ) {
218229
double mu;
219230
double s;
220231
double t;
221232
double y;
222233
int i;
234+
223235
for ( i = 0; i < 25; i++ ) {
224-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
236+
mu = random_uniform( -5.0, 5.0 );
225237
s = random_uniform( 0.0, 20.0 );
226238
t = random_uniform( 0.0, 10.0 );
227239
y = stdlib_base_dists_logistic_mgf( t, mu, s );
228-
printf( "t: %lf, µ: %lf, s: %lf, mgf(X;t,µ,s): %lf\n", t, mu, s, y );
240+
printf( "t: %lf, µ: %lf, s: %lf, M_X(t;µ,s): %lf\n", t, mu, s, y );
229241
}
230242
}
231243
```

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
2525
var Float64Array = require( '@stdlib/array/float64' );
2626
var tryRequire = require( '@stdlib/utils/try-require' );
27-
var randu = require( '@stdlib/random/base/randu' );
27+
var uniform = require( '@stdlib/random/base/uniform' );
2828
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2929
var EPS = require( '@stdlib/constants/float64/eps' );
3030
var pkg = require( './../package.json' ).name;
@@ -53,9 +53,9 @@ bench( pkg, opts, function benchmark( b ) {
5353
mu = new Float64Array( len );
5454
s = new Float64Array( len );
5555
for ( i = 0; i < len; i++ ) {
56-
t[ i ] = randu();
57-
mu[ i ] = ( randu() * 20.0 ) - 10.0;
58-
s[ i ] = ( randu() * 5.0 ) + EPS;
56+
t[ i ] = uniform( 0.0, 1.0 );
57+
mu[ i ] = uniform( -5.0, 5.0 );
58+
s[ i ] = uniform( EPS, 5.0 );
5959
}
6060

6161
b.tic();

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ static double benchmark( void ) {
104104
for ( i = 0; i < 100; i++ ) {
105105
x[ i ] = random_uniform( 0.0, 100.0 );
106106
mu[ i ] = random_uniform( 0.0, 100.0 );
107-
s[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
107+
s[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
108108
}
109109

110110
t = tic();

lib/node_modules/@stdlib/stats/base/dists/logistic/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
s = random_uniform( 0.0, 10.0 );
3939
y = stdlib_base_dists_logistic_mgf( t, mu, s );
40-
printf( "t: %lf, µ: %lf, s: %lf, mgf(X;t,µ,s): %lf\n", t, mu, s, y );
40+
printf( "t: %lf, µ: %lf, s: %lf, M_X(t;µ,s): %lf\n", t, mu, s, y );
4141
}
4242
}

lib/node_modules/@stdlib/stats/base/dists/logistic/mgf/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
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
3030
*
31+
* @private
3132
* @param {number} t - input value
3233
* @param {number} mu - mean
3334
* @param {NonNegativeNumber} s - scale parameter

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

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -25,46 +25,17 @@
2525
/**
2626
* Evaluates the moment-generating function (MGF) for a logistic distribution with mean `mu` and scale parameter `s` at a value `t`.
2727
*
28-
* @param {number} t - input value
29-
* @param {number} mu - mean
30-
* @param {NonNegativeNumber} s - scale parameter
31-
* @returns {number} evaluated MGF
28+
* @param t input value
29+
* @param mu mean
30+
* @param s scale parameter
31+
* @return evaluated MGF
3232
*
3333
* @example
3434
* double y = stdlib_base_dists_logistic_mgf( 0.9, 0.0, 1.0 );
3535
* // returns ~9.15
36-
*
37-
* @example
38-
* double y = stdlib_base_dists_logistic_mgf( 0.1, 4.0, 4.0 );
39-
* // returns ~1.971
40-
*
41-
* @example
42-
* double y = stdlib_base_dists_logistic_mgf( -0.2, 4.0, 4.0 );
43-
* // returns ~1.921
44-
*
45-
* @example
46-
* double y = stdlib_base_dists_logistic_mgf( 0.5, 0.0, -1.0 );
47-
* // returns NaN
48-
*
49-
* @example
50-
* double y = stdlib_base_dists_logistic_mgf( 0.5, 0.0, 4.0 );
51-
* // returns NaN
52-
*
53-
* @example
54-
* double y = stdlib_base_dists_logistic_mgf( NaN, 0.0, 1.0 );
55-
* // returns NaN
56-
*
57-
* @example
58-
* double y = stdlib_base_dists_logistic_mgf( 0.0, NaN, 1.0 );
59-
* // returns NaN
60-
*
61-
* @example
62-
* double y = stdlib_base_dists_logistic_mgf( 0.0, 0.0, NaN );
63-
* // returns NaN
6436
*/
6537
double stdlib_base_dists_logistic_mgf( const double t, const double mu, const double s ) {
66-
double st;
67-
st = s * t;
38+
double st = s * t;
6839
if (
6940
stdlib_base_is_nan( st ) ||
7041
stdlib_base_is_nan( mu ) ||

0 commit comments

Comments
 (0)