Skip to content

Commit a3a900c

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

File tree

14 files changed

+106
-148
lines changed

14 files changed

+106
-148
lines changed

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,21 +111,17 @@ var y = mymgf( 0.1 );
111111
<!-- eslint no-undef: "error" -->
112112

113113
```javascript
114-
var randu = require( '@stdlib/random/base/randu' );
115-
var round = require( '@stdlib/math/base/special/round' );
114+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
115+
var logEachMap = require( '@stdlib/console/log-each-map' );
116116
var mgf = require( '@stdlib/stats/base/dists/degenerate/mgf' );
117117

118-
var mu;
119-
var t;
120-
var y;
121-
var i;
118+
var opts = {
119+
'dtype': 'float64'
120+
};
121+
var t = discreteUniform( 100, 0, 5, opts );
122+
var mu = discreteUniform( 100, 0, 5, opts );
122123

123-
for ( i = 0; i < 100; i++ ) {
124-
t = round( randu()*5.0 );
125-
mu = round( randu()*5.0 );
126-
y = mgf( t, mu );
127-
console.log( 'x: %d, µ: %d, M_X(t;µ): %d', t, mu, y );
128-
}
124+
logEachMap( 'x: %0.4f, µ: %0.4f, M_X(t;µ): %0.4f', t, mu, mgf );
129125
```
130126

131127
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/mgf/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 mgf = require( './../lib' );
2424

25-
var mu;
26-
var t;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var t = discreteUniform( 100, 0, 5, opts );
29+
var mu = discreteUniform( 100, 0, 5, opts );
2930

30-
for ( i = 0; i < 100; i++ ) {
31-
t = round( randu()*5.0 );
32-
mu = round( randu()*5.0 );
33-
y = mgf( t, mu );
34-
console.log( 'x: %d, µ: %d, M_X(t;µ): %d', t, mu, y );
35-
}
31+
logEachMap( 'x: %0.4f, µ: %0.4f, M_X(t;µ): %0.4f', t, mu, mgf );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,16 @@ v = mode( -0.5 );
9090
<!-- eslint no-undef: "error" -->
9191

9292
```javascript
93-
var randu = require( '@stdlib/random/base/randu' );
93+
var uniform = require( '@stdlib/random/array/uniform' );
94+
var logEachMap = require( '@stdlib/console/log-each-map' );
9495
var mode = require( '@stdlib/stats/base/dists/degenerate/mode' );
9596

96-
var mu;
97-
var v;
98-
var i;
97+
var opts = {
98+
'dtype': 'float64'
99+
};
100+
var mu = uniform( 10, 0.0, 1.0, opts );
99101

100-
for ( i = 0; i < 10; i++ ) {
101-
mu = randu();
102-
v = mode( mu );
103-
console.log( 'µ: %d, mode(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
104-
}
102+
logEachMap( 'µ: %0.4f, mode(X;µ): %0.4f', mu, mode );
105103
```
106104

107105
</section>

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 mode = require( './../lib' );
2324

24-
var mu;
25-
var v;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var mu = uniform( 10, 0.0, 1.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
mu = randu();
30-
v = mode( mu );
31-
console.log( 'µ: %d, mode(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, mode(X;µ): %0.4f', mu, mode );

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/pdf/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -106,21 +106,17 @@ y = mypdf( 12.0 );
106106
<!-- eslint no-undef: "error" -->
107107

108108
```javascript
109-
var randu = require( '@stdlib/random/base/randu' );
110-
var round = require( '@stdlib/math/base/special/round' );
111109
var pdf = require( '@stdlib/stats/base/dists/degenerate/pdf' );
110+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
111+
var logEachMap = require( '@stdlib/console/log-each-map' );
112112

113-
var mu;
114-
var x;
115-
var y;
116-
var i;
113+
var opts = {
114+
'dtype': 'float64'
115+
};
116+
var x = discreteUniform( 100, 0, 5, opts );
117+
var mu = discreteUniform( 100, 0, 5, opts );
117118

118-
for ( i = 0; i < 100; i++ ) {
119-
x = round( randu()*5.0 );
120-
mu = round( randu()*5.0 );
121-
y = pdf( x, mu );
122-
console.log( 'x: %d, µ: %d, f(x;µ): %d', x, mu, y );
123-
}
119+
logEachMap( 'x: %0.4f, µ: %0.4f, f(x;µ): %0.4f', x, mu, pdf );
124120
```
125121

126122
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/pdf/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 pdf = require( './../lib' );
2424

25-
var mu;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = discreteUniform( 100, 0, 5, opts );
29+
var mu = discreteUniform( 100, 0, 5, opts );
2930

30-
for ( i = 0; i < 100; i++ ) {
31-
x = round( randu()*5.0 );
32-
mu = round( randu()*5.0 );
33-
y = pdf( x, mu );
34-
console.log( 'x: %d, µ: %d, f(x;µ): %d', x, mu, y );
35-
}
31+
logEachMap( 'x: %0.4f, µ: %0.4f, f(x;µ): %0.4f', x, mu, pdf );

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,17 @@ y = mypmf( 12.0 );
7676
<!-- eslint no-undef: "error" -->
7777

7878
```javascript
79-
var randu = require( '@stdlib/random/base/randu' );
80-
var round = require( '@stdlib/math/base/special/round' );
79+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
80+
var logEachMap = require( '@stdlib/console/log-each-map' );
8181
var pmf = require( '@stdlib/stats/base/dists/degenerate/pmf' );
8282

83-
var mu;
84-
var x;
85-
var y;
86-
var i;
83+
var opts = {
84+
'dtype': 'float64'
85+
};
86+
var x = discreteUniform( 100, 0, 5, opts );
87+
var mu = discreteUniform( 100, 0, 5, opts );
8788

88-
for ( i = 0; i < 100; i++ ) {
89-
x = round( randu()*5.0 );
90-
mu = round( randu()*5.0 );
91-
y = pmf( x, mu );
92-
console.log( 'x: %d, µ: %d, P(X=x;µ): %d', x, mu, y );
93-
}
89+
logEachMap( 'x: %0.4f, µ: %0.4f, P(X=x;µ): %0.4f', x, mu, pmf );
9490
```
9591

9692
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/pmf/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 pmf = require( './../lib' );
2424

25-
var mu;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = discreteUniform( 100, 0, 5, opts );
29+
var mu = discreteUniform( 100, 0, 5, opts );
2930

30-
for ( i = 0; i < 100; i++ ) {
31-
x = round( randu()*5.0 );
32-
mu = round( randu()*5.0 );
33-
y = pmf( x, mu );
34-
console.log( 'x: %d, µ: %d, P(X=x;µ): %d', x, mu, y );
35-
}
31+
logEachMap( 'x: %0.4f, µ: %0.4f, P(X=x;µ): %0.4f', x, mu, pmf );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -90,20 +90,17 @@ y = myquantile( 1.1 );
9090
<!-- eslint no-undef: "error" -->
9191

9292
```javascript
93-
var randu = require( '@stdlib/random/base/randu' );
93+
var uniform = require( '@stdlib/random/array/uniform' );
94+
var logEachMap = require( '@stdlib/console/log-each-map' );
9495
var quantile = require( '@stdlib/stats/base/dists/degenerate/quantile' );
9596

96-
var mu;
97-
var p;
98-
var y;
99-
var i;
97+
var opts = {
98+
'dtype': 'float64'
99+
};
100+
var p = uniform( 10, 0.0, 1.0, opts );
101+
var mu = uniform( 10, -5.0, 5.0, opts );
100102

101-
for ( i = 0; i < 10; i++ ) {
102-
p = randu();
103-
mu = ( randu()*10.0 ) - 5.0;
104-
y = quantile( p, mu );
105-
console.log( 'p: %d, µ: %d, Q(p;µ): %d', p, mu, y );
106-
}
103+
logEachMap( 'p: %0.4f, µ: %0.4f, Q(p;µ): %0.4f', p, mu, quantile );
107104
```
108105

109106
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/quantile/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 quantile = require( './../lib' );
2324

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

29-
for ( i = 0; i < 10; i++ ) {
30-
p = randu();
31-
mu = ( randu()*10.0 ) - 5.0;
32-
y = quantile( p, mu );
33-
console.log( 'p: %d, µ: %d, Q(p;µ): %d', p, mu, y );
34-
}
31+
logEachMap( 'p: %0.4f, µ: %0.4f, Q(p;µ): %0.4f', p, mu, quantile );

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/stdev/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,16 @@ v = stdev( NaN );
9393
<!-- eslint no-undef: "error" -->
9494

9595
```javascript
96-
var randu = require( '@stdlib/random/base/randu' );
96+
var uniform = require( '@stdlib/random/array/uniform' );
97+
var logEachMap = require( '@stdlib/console/log-each-map' );
9798
var stdev = require( '@stdlib/stats/base/dists/degenerate/stdev' );
9899

99-
var mu;
100-
var v;
101-
var i;
100+
var opts = {
101+
'dtype': 'float64'
102+
};
103+
var mu = uniform( 10, 0.0, 1.0, opts );
102104

103-
for ( i = 0; i < 10; i++ ) {
104-
mu = randu();
105-
v = stdev( mu );
106-
console.log( 'µ: %d, SD(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
107-
}
105+
logEachMap( 'µ: %0.4f, SD(X;µ): %0.4f', mu, stdev );
108106
```
109107

110108
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/stdev/examples/index.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 stdev = require( './../lib' );
2324

24-
var mu;
25-
var v;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var mu = uniform( 10, 0.0, 1.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
mu = randu();
30-
v = stdev( mu );
31-
console.log( 'µ: %d, SD(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, SD(X;µ): %0.4f', mu, stdev );

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,16 @@ v = variance( NaN );
9393
<!-- eslint no-undef: "error" -->
9494

9595
```javascript
96-
var randu = require( '@stdlib/random/base/randu' );
96+
var uniform = require( '@stdlib/random/array/uniform' );
97+
var logEachMap = require( '@stdlib/console/log-each-map' );
9798
var variance = require( '@stdlib/stats/base/dists/degenerate/variance' );
9899

99-
var mu;
100-
var v;
101-
var i;
100+
var opts = {
101+
'dtype': 'float64'
102+
};
103+
var mu = uniform( 10, 0.0, 1.0, opts );
102104

103-
for ( i = 0; i < 10; i++ ) {
104-
mu = randu();
105-
v = variance( mu );
106-
console.log( 'µ: %d, Var(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
107-
}
105+
logEachMap( 'µ: %0.4f, Var(X;µ): %0.4f', mu, variance );
108106
```
109107

110108
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/variance/examples/index.js

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 variance = require( './../lib' );
2324

24-
var mu;
25-
var v;
26-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var mu = uniform( 10, 0.0, 1.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
mu = randu();
30-
v = variance( mu );
31-
console.log( 'µ: %d, Var(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, Var(X;µ): %0.4f', mu, variance );

0 commit comments

Comments
 (0)