Skip to content

Commit bc2765b

Browse files
hrshyahrshya
committed
docs: replace manual for loop in examples
1 parent 60aea0a commit bc2765b

File tree

14 files changed

+121
-183
lines changed

14 files changed

+121
-183
lines changed

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

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -140,23 +140,18 @@ var y = myMGF( 0.3 );
140140
<!-- eslint no-undef: "error" -->
141141

142142
```javascript
143-
var randu = require( '@stdlib/random/base/randu' );
144-
var round = require( '@stdlib/math/base/special/round' );
143+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
144+
var logEachMap = require( '@stdlib/console/log-each-map' );
145145
var mgf = require( '@stdlib/stats/base/dists/binomial/mgf' );
146146

147-
var n;
148-
var p;
149-
var t;
150-
var y;
151-
var i;
152-
153-
for ( i = 0; i < 10; i++ ) {
154-
t = round( randu() * 5.0 );
155-
n = round( randu() * 10.0 );
156-
p = randu();
157-
y = mgf( t, n, p );
158-
console.log( 't: %d, n: %d, p: %d, M_X(t;n,p): %d', t, n, p.toFixed( 4 ), y.toFixed( 4 ) );
159-
}
147+
var opts = {
148+
'dtype': 'float64'
149+
};
150+
var t = discreteUniform( 10, 0, 5, opts );
151+
var n = discreteUniform( 10, 0, 10, opts );
152+
var p = discreteUniform( 10, 0, 1, opts );
153+
154+
logEachMap( 't: %0.4f, n: %0.4f, p: %0.4f, M_X(t;n,p): %0.4f', t, n, p, mgf );
160155
```
161156

162157
</section>

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var mgf = require( './../lib' );
2424

25-
var n;
26-
var p;
27-
var t;
28-
var y;
29-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var t = discreteUniform( 10, 0, 5, opts );
29+
var n = discreteUniform( 10, 0, 10, opts );
30+
var p = discreteUniform( 10, 0, 1, opts );
3031

31-
for ( i = 0; i < 10; i++ ) {
32-
t = round( randu() * 5.0 );
33-
n = round( randu() * 10.0 );
34-
p = randu();
35-
y = mgf( t, n, p );
36-
console.log( 't: %d, n: %d, p: %d, M_X(t;n,p): %d', t, n, p.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
32+
logEachMap( 't: %0.4f, n: %0.4f, p: %0.4f, M_X(t;n,p): %0.4f', t, n, p, mgf );

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,17 @@ v = mode( 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 logEachMap = require( '@stdlib/console/log-each-map' );
125125
var mode = require( '@stdlib/stats/base/dists/binomial/mode' );
126126

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

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

140136
</section>

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,14 @@
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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var mode = require( './../lib' );
2424

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

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

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

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -129,23 +129,18 @@ y = mypmf( 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 logEachMap = require( '@stdlib/console/log-each-map' );
134134
var pmf = require( '@stdlib/stats/base/dists/binomial/pmf' );
135135

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 = pmf( x, n, p );
147-
console.log( 'x: %d, n: %d, p: %d, P(X = x;n,p): %d', x, n, p.toFixed( 4 ), y.toFixed( 4 ) );
148-
}
136+
var opts = {
137+
'dtype': 'float64'
138+
};
139+
var x = discreteUniform( 10, 0, 20, opts );
140+
var n = discreteUniform( 10, 0, 100, opts );
141+
var p = discreteUniform( 10, 0, 1, opts );
142+
143+
logEachMap( 'x: %0.4f, n: %0.4f, p: %0.4f, P(X = x;n,p): %0.4f', x, n, p, pmf );
149144
```
150145

151146
</section>

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var pmf = require( './../lib' );
2424

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

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

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

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -132,23 +132,18 @@ y = myquantile( 0.9 );
132132
<!-- eslint no-undef: "error" -->
133133

134134
```javascript
135-
var randu = require( '@stdlib/random/base/randu' );
136-
var round = require( '@stdlib/math/base/special/round' );
135+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
136+
var logEachMap = require( '@stdlib/console/log-each-map' );
137137
var quantile = require( '@stdlib/stats/base/dists/binomial/quantile' );
138138

139-
var r;
140-
var i;
141-
var n;
142-
var p;
143-
var y;
144-
145-
for ( i = 0; i < 10; i++ ) {
146-
r = randu();
147-
n = round( randu() * 100.0 );
148-
p = randu();
149-
y = quantile( r, n, p );
150-
console.log( 'r: %d, n: %d, p: %d, Q(r;n,p): %d', r.toFixed( 4 ), n, p.toFixed( 4 ) );
151-
}
139+
var opts = {
140+
'dtype': 'float64'
141+
};
142+
var r = discreteUniform( 10, 0, 1, opts );
143+
var n = discreteUniform( 10, 0, 100, opts );
144+
var p = discreteUniform( 10, 0, 1, opts );
145+
146+
logEachMap( 'r: %0.4f, n: %0.4f, p: %0.4f, Q(r;n,p): %0.4f', r, n, p, quantile );
152147
```
153148

154149
</section>

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

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var quantile = require( './../lib' );
2424

25-
var r;
26-
var i;
27-
var n;
28-
var p;
29-
var y;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var r = discreteUniform( 10, 0, 1, opts );
29+
var n = discreteUniform( 10, 0, 100, opts );
30+
var p = discreteUniform( 10, 0, 1, opts );
3031

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

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,17 @@ v = skewness( 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 logEachMap = require( '@stdlib/console/log-each-map' );
125125
var skewness = require( '@stdlib/stats/base/dists/binomial/skewness' );
126126

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

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

140136
</section>

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,14 @@
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 logEachMap = require( '@stdlib/console/log-each-map' );
2323
var skewness = require( './../lib' );
2424

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

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

0 commit comments

Comments
 (0)