Skip to content

Commit 4c4a8bf

Browse files
committed
fix: update examples and benchmarks to use proper uniform distribution ranges
--- 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: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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 9deb7c6 commit 4c4a8bf

File tree

8 files changed

+31
-26
lines changed

8 files changed

+31
-26
lines changed

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,8 @@ y = myquantile( 0.8 );
126126
<!-- eslint no-undef: "error" -->
127127

128128
```javascript
129-
var randu = require( '@stdlib/random/base/randu' );
129+
var uniform = require( '@stdlib/random/base/uniform' );
130+
var EPS = require( '@stdlib/constants/float64/eps' );
130131
var quantile = require( '@stdlib/stats/base/dists/gumbel/quantile' );
131132

132133
var beta;
@@ -136,9 +137,9 @@ var y;
136137
var i;
137138

138139
for ( i = 0; i < 100; i++ ) {
139-
p = randu();
140-
mu = randu() * 10.0;
141-
beta = randu() * 10.0;
140+
p = uniform( 0.0, 1.0 );
141+
mu = uniform( -5.0, 5.0 );
142+
beta = uniform( EPS, 10.0 );
142143
y = quantile( p, mu, beta );
143144
console.log( 'p: %d, µ: %d, β: %d, Q(p;µ,β): %d', p.toFixed( 4 ), mu.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
144145
}
@@ -219,6 +220,7 @@ double stdlib_base_dists_gumbel_quantile( const double p, const double mu, const
219220
220221
```c
221222
#include "stdlib/stats/base/dists/gumbel/quantile.h"
223+
#include "stdlib/constants/float64/eps.h"
222224
#include <stdlib.h>
223225
#include <stdio.h>
224226
@@ -236,8 +238,8 @@ int main( void ) {
236238
237239
for ( i = 0; i < 25; i++ ) {
238240
p = random_uniform( 0.0, 1.0 );
239-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
240-
beta = random_uniform( 0.0, 20.0 );
241+
mu = random_uniform( -5.0, 5.0 );
242+
beta = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
241243
y = stdlib_base_dists_gumbel_quantile( p, mu, beta );
242244
printf( "p: %lf, mu: %lf, beta: %lf, Q(p;mu,beta): %lf\n", p, mu, beta, y );
243245
}

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/benchmark/benchmark.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var Float64Array = require( '@stdlib/array/float64' );
25-
var randu = require( '@stdlib/random/base/randu' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
2626
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2727
var EPS = require( '@stdlib/constants/float64/eps' );
2828
var pkg = require( './../package.json' ).name;
@@ -40,12 +40,13 @@ bench( pkg, function benchmark( b ) {
4040
var i;
4141

4242
len = 100;
43+
p = new Float64Array( len );
4344
mu = new Float64Array( len );
4445
beta = new Float64Array( len );
4546
for ( i = 0; i < len; i++ ) {
46-
p = randu();
47-
mu[ i ] = ( randu() * 100.0 ) - 50.0;
48-
beta[ i ] = ( randu() * 20.0 ) + EPS;
47+
p[ i ] = uniform( 0.0, 1.0 );
48+
mu[ i ] = uniform( -50.0, 50.0 );
49+
beta[ i ] = uniform( EPS, 20.0 );
4950
}
5051

5152
b.tic();
@@ -77,7 +78,7 @@ bench( pkg+':factory', function benchmark( b ) {
7778

7879
b.tic();
7980
for ( i = 0; i < b.iterations; i++ ) {
80-
p = randu();
81+
p = uniform( 0.0, 1.0 );
8182
y = myquantile( p );
8283
if ( isnan( y ) ) {
8384
b.fail( 'should not return NaN' );

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/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+'::native', opts, function benchmark( b ) {
5353
mu = new Float64Array( len );
5454
beta = new Float64Array( len );
5555
for ( i = 0; i < len; i++ ) {
56-
p[ i ] = randu();
57-
mu[ i ] = ( randu() * 100.0 ) - 50.0;
58-
beta[ i ] = ( randu() * 20.0 ) + EPS;
56+
p[ i ] = uniform( 0.0, 1.0 );
57+
mu[ i ] = uniform( -50.0, 50.0 );
58+
beta[ i ] = uniform( EPS, 20.0 );
5959
}
6060

6161
b.tic();

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/benchmark/c/benchmark.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ static double benchmark( void ) {
103103

104104
for ( i = 0; i < 100; i++ ) {
105105
p[ i ] = random_uniform( 0.0, 1.0 );
106-
mu[ i ] = random_uniform( 0.0, 100.0 ) - 50.0;
107-
beta[ i ] = random_uniform( 0.0, 20.0 ) + STDLIB_CONSTANT_FLOAT64_EPS;
106+
mu[ i ] = random_uniform( -50.0, 50.0 );
107+
beta[ i ] = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
108108
}
109109

110110
t = tic();

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
*/
1818

1919
#include "stdlib/stats/base/dists/gumbel/quantile.h"
20+
#include "stdlib/constants/float64/eps.h"
2021
#include <stdlib.h>
2122
#include <stdio.h>
2223

@@ -34,8 +35,8 @@ int main( void ) {
3435

3536
for ( i = 0; i < 25; i++ ) {
3637
p = random_uniform( 0.0, 1.0 );
37-
mu = random_uniform( 0.0, 10.0 ) - 5.0;
38-
beta = random_uniform( 0.0, 20.0 );
38+
mu = random_uniform( -5.0, 5.0 );
39+
beta = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
3940
y = stdlib_base_dists_gumbel_quantile( p, mu, beta );
4041
printf( "p: %lf, mu: %lf, beta: %lf, Q(p;mu,beta): %lf\n", p, mu, beta, y );
4142
}

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/examples/index.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/base/uniform' );
22+
var EPS = require( '@stdlib/constants/float64/eps' );
2223
var quantile = require( './../lib' );
2324

2425
var beta;
@@ -28,9 +29,9 @@ var y;
2829
var i;
2930

3031
for ( i = 0; i < 100; i++ ) {
31-
p = randu();
32-
mu = randu() * 10.0;
33-
beta = randu() * 10.0;
32+
p = uniform( 0.0, 1.0 );
33+
mu = uniform( -5.0, 5.0 );
34+
beta = uniform( EPS, 10.0 );
3435
y = quantile( p, mu, beta );
3536
console.log( 'p: %d, µ: %d, β: %d, Q(p;µ,β): %d', p.toFixed( 4 ), mu.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
3637
}

lib/node_modules/@stdlib/stats/base/dists/gumbel/quantile/include/stdlib/stats/base/dists/gumbel/quantile.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 quantile for a Gumbel distribution with location `mu` and scale `beta`.
30+
* Evaluates the quantile function for a Gumbel distribution with location `mu` and scale `beta`.
3131
*/
3232
double stdlib_base_dists_gumbel_quantile( const double p, const double mu, const double beta );
3333

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@
2121
#include "stdlib/math/base/special/ln.h"
2222

2323
/**
24-
* Returns the quantile for a Gumbel distribution with location `mu` and scale `beta`.
24+
* Evaluates the quantile function for a Gumbel distribution with location `mu` and scale `beta`.
2525
*
2626
* @param p probability
2727
* @param mu location parameter
2828
* @param beta scale parameter
29-
* @return quantile
29+
* @return evaluated quantile
3030
*
3131
* @example
3232
* double y = stdlib_base_dists_gumbel_quantile( 0.8, 0.0, 1.0 );

0 commit comments

Comments
 (0)