Skip to content

Commit fba7ac9

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 236e2e1 commit fba7ac9

File tree

7 files changed

+35
-58
lines changed

7 files changed

+35
-58
lines changed

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

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ for ( i = 0; i < 10; i++ ) {
190190

191191
#### stdlib_base_dists_laplace_mgf( t, mu, b )
192192

193-
Evaluates the moment-generating function (MGF) for a Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b` at a value `t`.
193+
Evaluates the [moment-generating function][mgf] (MGF) for a [Laplace][laplace-distribution] (double exponential) distribution with parameters `mu` (location) and `b` (scale).
194194

195195
```c
196196
double out = stdlib_base_dists_laplace_mgf( 0.5, 0.0, 1.0 );
@@ -201,41 +201,53 @@ The function accepts the following arguments:
201201

202202
- **t**: `[in] double` input value.
203203
- **mu**: `[in] double` location parameter.
204-
- **b**: `[in] double` rate parameter.
204+
- **b**: `[in] double` scale parameter.
205205

206206
```c
207207
double stdlib_base_dists_laplace_mgf( const double t, const double mu, const double b );
208208
```
209209
210210
</section>
211+
211212
<!-- /.usage -->
213+
212214
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
215+
213216
<section class="notes">
217+
214218
</section>
219+
215220
<!-- /.notes -->
221+
216222
<!-- C API usage examples. -->
223+
217224
<section class="examples">
225+
218226
### Examples
227+
219228
```c
220229
#include "stdlib/stats/base/dists/laplace/mgf.h"
221230
#include <stdlib.h>
222231
#include <stdio.h>
232+
223233
static double random_uniform( const double min, const double max ) {
224234
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
225235
return min + ( v*(max-min) );
226236
}
237+
227238
int main( void ) {
228239
double mu;
229240
double b;
230241
double t;
231242
double y;
232243
int i;
244+
233245
for ( i = 0; i < 25; i++ ) {
234246
mu = random_uniform( -5.0, 5.0 );
235-
b = random_uniform( 0.0, 20.0 );
236-
t = random_uniform( 0.0, 20.0 );
247+
b = random_uniform( 0.1, 20.0 );
248+
t = random_uniform( -1.0/b, 1.0/b );
237249
y = stdlib_base_dists_laplace_mgf( t, mu, b );
238-
printf( "t: %lf, µ: %lf, b: %lf, mgf(X;t,µ,b): %lf\n", t, mu, b, y );
250+
printf( "t: %lf, µ: %lf, b: %lf, M_X(t;µ,b): %lf\n", t, mu, b, y );
239251
}
240252
}
241253
```

lib/node_modules/@stdlib/stats/base/dists/laplace/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 tryRequire = require( '@stdlib/utils/try-require' );
2626
var Float64Array = require( '@stdlib/array/float64' );
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
scale = new Float64Array( len );
5454
t = new Float64Array( len );
5555
for ( i = 0; i < len; i++ ) {
56-
mu[ i ] = ( randu()*100.0 ) - 50.0;
57-
scale[ i ] = ( randu()*20.0 ) + EPS;
58-
t[ i ] = ( 2.0 * randu() * 1.0/scale ) - ( 1.0/scale );
56+
mu[ i ] = uniform( -50.0, 50.0 );
57+
scale[ i ] = uniform( EPS, 20.0 );
58+
t[ i ] = uniform( -1.0/scale[ i ], 1.0/scale[ i ] );
5959
}
6060

6161
b.tic();

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,20 +96,20 @@ static double benchmark( void ) {
9696
double elapsed;
9797
double mu[ 100 ];
9898
double b[ 100 ];
99-
double x[ 100 ];
99+
double t_vals[ 100 ];
100100
double y;
101101
double t;
102102
int i;
103103

104104
for ( i = 0; i < 100; i++ ) {
105-
x[ i ] = random_uniform( 0.0, 50.0 );
106105
mu[ i ] = random_uniform( -50.0, 50.0 );
107-
b[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
106+
b[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
107+
t_vals[ i ] = random_uniform( -1.0/b[ i ], 1.0/b[ i ] );
108108
}
109109

110110
t = tic();
111111
for ( i = 0; i < ITERATIONS; i++ ) {
112-
y = stdlib_base_dists_laplace_mgf( x[ i%100 ], mu[ i%100 ], b[ i%100 ] );
112+
y = stdlib_base_dists_laplace_mgf( t_vals[ i%100 ], mu[ i%100 ], b[ i%100 ] );
113113
if ( y != y ) {
114114
printf( "should not return NaN\n" );
115115
break;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ int main( void ) {
3333
int i;
3434

3535
for ( i = 0; i < 25; i++ ) {
36-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
37-
t = random_uniform( 0.0, 1.0 );
38-
b = random_uniform( 0.0, 20.0 );
36+
mu = random_uniform( -5.0, 5.0 );
37+
b = random_uniform( 0.1, 20.0 );
38+
t = random_uniform( -1.0/b, 1.0/b );
3939
y = stdlib_base_dists_laplace_mgf( t, mu, b );
40-
printf( "t: %lf, µ: %lf, b: %lf, mgf(X;t,µ,b): %lf\n", t, mu, b, y );
40+
printf( "t: %lf, µ: %lf, b: %lf, M_X(t;µ,b): %lf\n", t, mu, b, y );
4141
}
4242
}

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

lib/node_modules/@stdlib/stats/base/dists/laplace/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 Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b` at a value `t`.
3030
*
31+
* @private
3132
* @param {number} t - input value
3233
* @param {number} mu - mean
3334
* @param {NonNegativeNumber} b - scale parameter

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

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -25,50 +25,14 @@
2525
/**
2626
* Evaluates the moment-generating function (MGF) for a Laplace (double exponential) distribution with location parameter `mu` and scale parameter `b` at a value `t`.
2727
*
28-
* @param {number} t - input value
29-
* @param {number} mu - mean
30-
* @param {NonNegativeNumber} b - scale parameter
31-
* @returns {number} evaluated MGF
28+
* @param t input value
29+
* @param mu location parameter
30+
* @param b scale parameter
31+
* @return evaluated MGF
3232
*
3333
* @example
3434
* double y = stdlib_base_dists_laplace_mgf( 0.5, 0.0, 1.0 );
3535
* // returns ~1.333
36-
*
37-
* @example
38-
* double y = stdlib_base_dists_laplace_mgf( 0.0, 0.0, 1.0 );
39-
* // returns 1.0
40-
*
41-
* @example
42-
* double y = stdlib_base_dists_laplace_mgf( -1.0, 4.0, 0.2 );
43-
* // returns ~0.019
44-
*
45-
* @example
46-
* double y = stdlib_base_dists_laplace_mgf( NaN, 0.0, 1.0 );
47-
* // returns NaN
48-
*
49-
* @example
50-
* double y = stdlib_base_dists_laplace_mgf( 0.0, NaN, 1.0 );
51-
* // returns NaN
52-
*
53-
* @example
54-
* double y = stdlib_base_dists_laplace_mgf( 0.0, 0.0, NaN );
55-
* // returns NaN
56-
*
57-
* @example
58-
* double y = stdlib_base_dists_laplace_mgf( 1.0, 0.0, 2.0 );
59-
* // returns NaN
60-
*
61-
* @example
62-
* double y = stdlib_base_dists_laplace_mgf( -0.5, 0.0, 4.0 );
63-
* // returns NaN
64-
*
65-
* @example
66-
* double y = stdlib_base_dists_laplace_mgf( 2.0, 0.0, 0.0 );
67-
* // returns NaN
68-
*
69-
* @example
70-
* double y = stdlib_base_dists_laplace_mgf( 2.0, 0.0, -1.0 );
71-
* // returns NaN
7236
*/
7337
double stdlib_base_dists_laplace_mgf( const double t, const double mu, const double b ) {
7438
double bt;

0 commit comments

Comments
 (0)