Skip to content

Commit 1122999

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #9019 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent b33ccca commit 1122999

File tree

22 files changed

+195
-272
lines changed

22 files changed

+195
-272
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -138,22 +138,18 @@ y = mycdf( 11.0 );
138138
<!-- eslint no-undef: "error" -->
139139

140140
```javascript
141-
var randu = require( '@stdlib/random/base/randu' );
141+
var uniform = require( '@stdlib/random/array/uniform' );
142+
var logEachMap = require( '@stdlib/console/log-each-map' );
142143
var cdf = require( '@stdlib/stats/base/dists/negative-binomial/cdf' );
143144

144-
var i;
145-
var r;
146-
var p;
147-
var x;
148-
var y;
149-
150-
for ( i = 0; i < 10; i++ ) {
151-
x = randu() * 50;
152-
r = randu() * 50;
153-
p = randu();
154-
y = cdf( x, r, p );
155-
console.log( 'x: %d, r: %d, p: %d, F(x;r,p): %d', x.toFixed( 4 ), r.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
156-
}
145+
var opts = {
146+
'dtype': 'float64'
147+
};
148+
var x = uniform( 10, 0.0, 50.0, opts );
149+
var r = uniform( 10, 0.0, 50.0, opts );
150+
var p = uniform( 10, 0.0, 1.0, opts );
151+
152+
logEachMap( 'x: %0.4f, r: %0.4f, p: %0.4f, F(x;r,p): %0.4f', x, r, p, cdf );
157153
```
158154

159155
</section>

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

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var cdf = require( './../lib' );
2324

24-
var i;
25-
var r;
26-
var p;
27-
var x;
28-
var y;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 50.0, opts );
29+
var r = uniform( 10, 0.0, 50.0, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -117,20 +117,17 @@ v = kurtosis( 20, 1.5 );
117117
<!-- eslint no-undef: "error" -->
118118

119119
```javascript
120-
var randu = require( '@stdlib/random/base/randu' );
120+
var uniform = require( '@stdlib/random/array/uniform' );
121+
var logEachMap = require( '@stdlib/console/log-each-map' );
121122
var kurtosis = require( '@stdlib/stats/base/dists/negative-binomial/kurtosis' );
122123

123-
var v;
124-
var i;
125-
var r;
126-
var p;
124+
var opts = {
125+
'dtype': 'float64'
126+
};
127+
var r = uniform( 10, 0.0, 100.0, opts );
128+
var p = uniform( 10, 0.0, 1.0, opts );
127129

128-
for ( i = 0; i < 10; i++ ) {
129-
r = randu() * 100;
130-
p = randu();
131-
v = kurtosis( r, p );
132-
console.log( 'r: %d, p: %d, Kurt(X;r,p): %d', r, p.toFixed( 4 ), v.toFixed( 4 ) );
133-
}
130+
logEachMap( 'r: %0.4f, p: %0.4f, Kurt(X;r,p): %0.4f', r, p, kurtosis );
134131
```
135132

136133
</section>

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var kurtosis = require( './../lib' );
2324

24-
var v;
25-
var i;
26-
var r;
27-
var p;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var r = uniform( 10, 0.0, 100.0, opts );
29+
var p = uniform( 10, 0.0, 1.0, opts );
2830

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

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

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -138,23 +138,19 @@ y = mylogpmf( 10.0 );
138138
<!-- eslint no-undef: "error" -->
139139

140140
```javascript
141-
var randu = require( '@stdlib/random/base/randu' );
142-
var round = require( '@stdlib/math/base/special/round' );
141+
var uniform = require( '@stdlib/random/array/uniform' );
142+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
143+
var logEachMap = require( '@stdlib/console/log-each-map' );
143144
var logpmf = require( '@stdlib/stats/base/dists/negative-binomial/logpmf' );
144145

145-
var i;
146-
var r;
147-
var p;
148-
var x;
149-
var y;
150-
151-
for ( i = 0; i < 10; i++ ) {
152-
x = round( randu() * 30.0 );
153-
r = randu() * 50.0;
154-
p = randu();
155-
y = logpmf( x, r, p );
156-
console.log( 'x: %d, r: %d, p: %d, ln(P(X=x;r,p)): %d', x, r, p.toFixed( 4 ), y.toFixed( 4 ) );
157-
}
146+
var opts = {
147+
'dtype': 'float64'
148+
};
149+
var x = discreteUniform( 10, 0, 30, opts );
150+
var r = uniform( 10, 0.0, 50.0, opts );
151+
var p = uniform( 10, 0.0, 1.0, opts );
152+
153+
logEachMap( 'x: %d, r: %0.4f, p: %0.4f, ln(P(X=x;r,p)): %0.4f', x, r, p, logpmf );
158154
```
159155

160156
</section>

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

Lines changed: 10 additions & 14 deletions
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 uniform = require( '@stdlib/random/array/uniform' );
22+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var logpmf = require( './../lib' );
2425

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

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -117,20 +117,17 @@ v = mean( 20, 1.5 );
117117
<!-- eslint no-undef: "error" -->
118118

119119
```javascript
120-
var randu = require( '@stdlib/random/base/randu' );
120+
var uniform = require( '@stdlib/random/array/uniform' );
121+
var logEachMap = require( '@stdlib/console/log-each-map' );
121122
var mean = require( '@stdlib/stats/base/dists/negative-binomial/mean' );
122123

123-
var v;
124-
var i;
125-
var r;
126-
var p;
124+
var opts = {
125+
'dtype': 'float64'
126+
};
127+
var r = uniform( 10, 0.0, 100.0, opts );
128+
var p = uniform( 10, 0.0, 1.0, opts );
127129

128-
for ( i = 0; i < 10; i++ ) {
129-
r = randu() * 100;
130-
p = randu();
131-
v = mean( r, p );
132-
console.log( 'r: %d, p: %d, E(X;r,p): %d', r, p.toFixed( 4 ), v.toFixed( 4 ) );
133-
}
130+
logEachMap( 'r: %0.4f, p: %0.4f, E(X;r,p): %0.4f', r, p, mean );
134131
```
135132

136133
</section>

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,14 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var mean = require( './../lib' );
2324

24-
var v;
25-
var i;
26-
var r;
27-
var p;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var r = uniform( 10, 0.0, 100.0, opts );
29+
var p = uniform( 10, 0.0, 1.0, opts );
2830

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

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

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -153,23 +153,18 @@ y = myMGF( 0.4 );
153153
<!-- eslint no-undef: "error" -->
154154

155155
```javascript
156-
var randu = require( '@stdlib/random/base/randu' );
157-
var round = require( '@stdlib/math/base/special/round' );
156+
var uniform = require( '@stdlib/random/array/uniform' );
157+
var logEachMap = require( '@stdlib/console/log-each-map' );
158158
var mgf = require( '@stdlib/stats/base/dists/negative-binomial/mgf' );
159159

160-
var p;
161-
var r;
162-
var t;
163-
var y;
164-
var i;
165-
166-
for ( i = 0; i < 10; i++ ) {
167-
t = (randu() * 1.0) - 0.5;
168-
r = randu() * 50;
169-
p = randu();
170-
y = mgf( t, r, p );
171-
console.log( 't: %d, r: %d, p: %d, M_X(t;r,p): %d', t, r.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
172-
}
160+
var opts = {
161+
'dtype': 'float64'
162+
};
163+
var t = uniform( 10, -0.5, 0.5, opts );
164+
var r = uniform( 10, 0.0, 50.0, opts );
165+
var p = uniform( 10, 0.0, 1.0, opts );
166+
167+
logEachMap( 't: %0.4f, r: %0.4f, p: %0.4f, M_X(t;r,p): %0.4f', t, r, p, mgf );
173168
```
174169

175170
</section>

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

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var mgf = require( './../lib' );
2324

24-
var p;
25-
var r;
26-
var t;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var t = uniform( 10, -0.5, 0.5, opts );
29+
var r = uniform( 10, 0.0, 50.0, opts );
30+
var p = uniform( 10, 0.0, 1.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
t = (randu() * 1.0) - 0.5;
32-
r = randu() * 50;
33-
p = randu();
34-
y = mgf( t, r, p );
35-
console.log( 't: %d, r: %d, p: %d, M_X(t;r,p): %d', t, r.toFixed( 4 ), p.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 't: %0.4f, r: %0.4f, p: %0.4f, M_X(t;r,p): %0.4f', t, r, p, mgf );

0 commit comments

Comments
 (0)