Skip to content

Commit c1df69c

Browse files
hrshyakgryte
hrshya
and
kgryte
authored
docs: replace manual for loop in examples
PR-URL: #6848 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent f6baee4 commit c1df69c

File tree

12 files changed

+115
-155
lines changed

12 files changed

+115
-155
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/binomial/cdf/README.md

+11-15
Original file line numberDiff line numberDiff line change
@@ -144,23 +144,19 @@ y = mycdf( 1.0 );
144144
<!-- eslint no-undef: "error" -->
145145

146146
```javascript
147-
var randu = require( '@stdlib/random/base/randu' );
148-
var round = require( '@stdlib/math/base/special/round' );
147+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
148+
var uniform = require( '@stdlib/random/array/uniform' );
149+
var logEachMap = require( '@stdlib/console/log-each-map' );
149150
var cdf = require( '@stdlib/stats/base/dists/binomial/cdf' );
150151

151-
var i;
152-
var n;
153-
var p;
154-
var x;
155-
var y;
156-
157-
for ( i = 0; i < 10; i++ ) {
158-
x = randu() * 20.0;
159-
n = round( randu() * 100.0 );
160-
p = randu();
161-
y = cdf( x, n, p );
162-
console.log( 'x: %d, n: %d, p: %d, F(x;n,p): %d', x.toFixed( 4 ), n, p.toFixed( 4 ), y.toFixed( 4 ) );
163-
}
152+
var opts = {
153+
'dtype': 'float64'
154+
};
155+
var x = uniform( 10, 0.0, 20.0, opts );
156+
var n = discreteUniform( 10, 0, 100, opts );
157+
var p = uniform( 10, 0.0, 1.0, opts );
158+
159+
logEachMap( 'x: %0.4f, n: %0.4f, p: %0.4f, F(x;n,p): %0.4f', x, n, p, cdf );
164160
```
165161

166162
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/cdf/examples/index.js

+10-14
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var cdf = require( './../lib' );
2425

25-
var i;
26-
var n;
27-
var p;
28-
var x;
29-
var y;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 10, 0.0, 20.0, opts );
30+
var n = discreteUniform( 10, 0, 100, opts );
31+
var p = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = randu() * 20.0;
33-
n = round( randu() * 100.0 );
34-
p = randu();
35-
y = cdf( x, n, p );
36-
console.log( 'x: %d, n: %d, p: %d, F(x;n,p): %d', x.toFixed( 4 ), n, p.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, n: %0.4f, p: %0.4f, F(x;n,p): %0.4f', x, n, p, cdf );

‎lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,18 @@ v = entropy( 20, 1.5 );
120120
<!-- eslint no-undef: "error" -->
121121

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
124-
var round = require( '@stdlib/math/base/special/round' );
123+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var entropy = require( '@stdlib/stats/base/dists/binomial/entropy' );
126127

127-
var v;
128-
var i;
129-
var n;
130-
var p;
131-
132-
for ( i = 0; i < 10; i++ ) {
133-
n = round( randu() * 100.0 );
134-
p = randu();
135-
v = entropy( n, p );
136-
console.log( 'n: %d, p: %d, H(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
137-
}
128+
var opts = {
129+
'dtype': 'float64'
130+
};
131+
var n = discreteUniform( 10, 0, 100, opts );
132+
var p = uniform( 10, 0.0, 1.0, opts );
133+
134+
logEachMap( 'n: %0.4f, p: %0.4f, H(X;n,p): %0.4f', n, p, entropy );
138135
```
139136

140137
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/entropy/examples/index.js

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var entropy = require( './../lib' );
2425

25-
var v;
26-
var i;
27-
var n;
28-
var p;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var n = discreteUniform( 10, 0, 100, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
n = round( randu() * 100.0 );
32-
p = randu();
33-
v = entropy( n, p );
34-
console.log( 'n: %d, p: %d, H(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'n: %0.4f, p: %0.4f, H(X;n,p): %0.4f', n, p, entropy );

‎lib/node_modules/@stdlib/stats/base/dists/binomial/kurtosis/README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,18 @@ v = kurtosis( 20, 1.5 );
120120
<!-- eslint no-undef: "error" -->
121121

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
124-
var round = require( '@stdlib/math/base/special/round' );
123+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var kurtosis = require( '@stdlib/stats/base/dists/binomial/kurtosis' );
126127

127-
var v;
128-
var i;
129-
var n;
130-
var p;
128+
var opts = {
129+
'dtype': 'float64'
130+
};
131+
var n = discreteUniform( 10, 0, 100, opts );
132+
var p = uniform( 10, 0.0, 1.0, opts );
131133

132-
for ( i = 0; i < 10; i++ ) {
133-
n = round( randu() * 100.0 );
134-
p = randu();
135-
v = kurtosis( n, p );
136-
console.log( 'n: %d, p: %d, Kurt(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
137-
}
134+
logEachMap( 'n: %0.4f, p: %0.4f, Kurt(X;n,p): %0.4f', n, p, kurtosis );
138135
```
139136

140137
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/kurtosis/examples/index.js

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var kurtosis = require( './../lib' );
2425

25-
var v;
26-
var i;
27-
var n;
28-
var p;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var n = discreteUniform( 10, 0, 100, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
n = round( randu() * 100.0 );
32-
p = randu();
33-
v = kurtosis( n, p );
34-
console.log( 'n: %d, p: %d, Kurt(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'n: %0.4f, p: %0.4f, Kurt(X;n,p): %0.4f', n, p, kurtosis );

‎lib/node_modules/@stdlib/stats/base/dists/binomial/logpmf/README.md

+11-15
Original file line numberDiff line numberDiff line change
@@ -129,23 +129,19 @@ y = mylogpmf( 5.0 );
129129
<!-- eslint no-undef: "error" -->
130130

131131
```javascript
132-
var randu = require( '@stdlib/random/base/randu' );
133-
var round = require( '@stdlib/math/base/special/round' );
132+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
133+
var uniform = require( '@stdlib/random/array/uniform' );
134+
var logEachMap = require( '@stdlib/console/log-each-map' );
134135
var logpmf = require( '@stdlib/stats/base/dists/binomial/logpmf' );
135136

136-
var i;
137-
var n;
138-
var p;
139-
var x;
140-
var y;
141-
142-
for ( i = 0; i < 10; i++ ) {
143-
x = round( randu() * 20.0 );
144-
n = round( randu() * 100.0 );
145-
p = randu();
146-
y = logpmf( x, n, p );
147-
console.log( 'x: %d, n: %d, p: %d, ln(P(X = x;n,p)): %d', x, n, p.toFixed( 4 ), y.toFixed( 4 ) );
148-
}
137+
var opts = {
138+
'dtype': 'float64'
139+
};
140+
var x = discreteUniform( 10, 0, 20, opts );
141+
var n = discreteUniform( 10, 0, 100, opts );
142+
var p = uniform( 10, 0.0, 1.0, opts );
143+
144+
logEachMap( 'x: %0.4f, n: %0.4f, p: %0.4f, ln(P(X = x;n,p)): %0.4f', x, n, p, logpmf );
149145
```
150146

151147
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/logpmf/examples/index.js

+10-14
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var logpmf = require( './../lib' );
2425

25-
var i;
26-
var n;
27-
var p;
28-
var x;
29-
var y;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = discreteUniform( 10, 0, 20, opts );
30+
var n = discreteUniform( 10, 0, 100, opts );
31+
var p = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = round( randu() * 20.0 );
33-
n = round( randu() * 100.0 );
34-
p = randu();
35-
y = logpmf( x, n, p );
36-
console.log( 'x: %d, n: %d, p: %d, ln(P(X = x;n,p)): %d', x, n, p.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, n: %0.4f, p: %0.4f, ln(P(X = x;n,p)): %0.4f', x, n, p, logpmf );

‎lib/node_modules/@stdlib/stats/base/dists/binomial/mean/README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,18 @@ v = mean( 20, 1.5 );
120120
<!-- eslint no-undef: "error" -->
121121

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
124-
var round = require( '@stdlib/math/base/special/round' );
123+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var mean = require( '@stdlib/stats/base/dists/binomial/mean' );
126127

127-
var v;
128-
var i;
129-
var n;
130-
var p;
128+
var opts = {
129+
'dtype': 'float64'
130+
};
131+
var n = discreteUniform( 10, 0, 100, opts );
132+
var p = uniform( 10, 0.0, 1.0, opts );
131133

132-
for ( i = 0; i < 10; i++ ) {
133-
n = round( randu() * 100.0 );
134-
p = randu();
135-
v = mean( n, p );
136-
console.log( 'n: %d, p: %d, E(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
137-
}
134+
logEachMap( 'n: %0.4f, p: %0.4f, E(X;n,p): %0.4f', n, p, mean );
138135
```
139136

140137
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/mean/examples/index.js

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var mean = require( './../lib' );
2425

25-
var v;
26-
var i;
27-
var n;
28-
var p;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var n = discreteUniform( 10, 0, 100, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
n = round( randu() * 100.0 );
32-
p = randu();
33-
v = mean( n, p );
34-
console.log( 'n: %d, p: %d, E(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'n: %0.4f, p: %0.4f, E(X;n,p): %0.4f', n, p, mean );

‎lib/node_modules/@stdlib/stats/base/dists/binomial/median/README.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,18 @@ v = median( 20, 1.5 );
120120
<!-- eslint no-undef: "error" -->
121121

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
124-
var round = require( '@stdlib/math/base/special/round' );
123+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var median = require( '@stdlib/stats/base/dists/binomial/median' );
126127

127-
var v;
128-
var i;
129-
var n;
130-
var p;
128+
var opts = {
129+
'dtype': 'float64'
130+
};
131+
var n = discreteUniform( 10, 0, 100, opts );
132+
var p = uniform( 10, 0.0, 1.0, opts );
131133

132-
for ( i = 0; i < 10; i++ ) {
133-
n = round( randu() * 100.0 );
134-
p = randu();
135-
v = median( n, p );
136-
console.log( 'n: %d, p: %d, Median(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
137-
}
134+
logEachMap( 'n: %0.4f, p: %0.4f, Median(X;n,p): %0.4f', n, p, median );
138135
```
139136

140137
</section>

‎lib/node_modules/@stdlib/stats/base/dists/binomial/median/examples/index.js

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var median = require( './../lib' );
2425

25-
var v;
26-
var i;
27-
var n;
28-
var p;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var n = discreteUniform( 10, 0, 100, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
n = round( randu() * 100.0 );
32-
p = randu();
33-
v = median( n, p );
34-
console.log( 'n: %d, p: %d, Median(X;n,p): %d', n, p.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'n: %0.4f, p: %0.4f, Median(X;n,p): %0.4f', n, p, median );

0 commit comments

Comments
 (0)