Skip to content

Commit 776c7e4

Browse files
hrshyaPlaneshifter
hrshya
and
Planeshifter
authored
docs: replace manual for loop in examples
PR-URL: #7122 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent c24ea87 commit 776c7e4

File tree

14 files changed

+106
-150
lines changed

14 files changed

+106
-150
lines changed

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,17 @@ y = mycdf( 8.0 );
9393
<!-- eslint no-undef: "error" -->
9494

9595
```javascript
96-
var randu = require( '@stdlib/random/base/randu' );
97-
var round = require( '@stdlib/math/base/special/round' );
96+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
97+
var logEachMap = require( '@stdlib/console/log-each-map' );
9898
var cdf = require( '@stdlib/stats/base/dists/degenerate/cdf' );
9999

100-
var mu;
101-
var x;
102-
var y;
103-
var i;
100+
var opts = {
101+
'dtype': 'float64'
102+
};
103+
var x = discreteUniform( 10, 0.0, 10.0, opts );
104+
var mu = discreteUniform( 10, 0.0, 10.0, opts );
104105

105-
for ( i = 0; i < 100; i++ ) {
106-
x = round( randu()*10.0 );
107-
mu = round( randu()*10.0 );
108-
y = cdf( x, mu );
109-
console.log( 'x: %d, µ: %d, F(x;µ): %d', x, mu, y );
110-
}
106+
logEachMap( 'x: %0.4f, µ: %0.4f, F(x;µ): %0.4f', x, mu, cdf );
111107
```
112108

113109
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/cdf/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 cdf = 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( 10, 0, 10, opts );
29+
var mu = discreteUniform( 10, 0, 10, opts );
2930

30-
for ( i = 0; i < 100; i++ ) {
31-
x = round( randu()*10.0 );
32-
mu = round( randu()*10.0 );
33-
y = cdf( 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, cdf );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,16 @@ v = entropy( 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 entropy = require( '@stdlib/stats/base/dists/degenerate/entropy' );
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 = entropy( mu );
106-
console.log( 'µ: %d, H(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
107-
}
105+
logEachMap( 'µ: %0.4f, H(X;µ): %0.4f', mu, entropy );
108106
```
109107

110108
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/entropy/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 entropy = 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 = entropy( mu );
31-
console.log( 'µ: %d, H(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, H(X;µ): %0.4f', mu, entropy );

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -93,21 +93,17 @@ y = mylogcdf( 8.0 );
9393
<!-- eslint no-undef: "error" -->
9494

9595
```javascript
96-
var randu = require( '@stdlib/random/base/randu' );
97-
var round = require( '@stdlib/math/base/special/round' );
96+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
97+
var logEachMap = require( '@stdlib/console/log-each-map' );
9898
var logcdf = require( '@stdlib/stats/base/dists/degenerate/logcdf' );
9999

100-
var mu;
101-
var x;
102-
var y;
103-
var i;
100+
var opts = {
101+
'dtype': 'float64'
102+
};
103+
var x = discreteUniform( 10, 0, 10, opts );
104+
var mu = discreteUniform( 10, 0, 10, opts );
104105

105-
for ( i = 0; i < 100; i++ ) {
106-
x = round( randu()*10.0 );
107-
mu = round( randu()*10.0 );
108-
y = logcdf( x, mu );
109-
console.log( 'x: %d, µ: %d, ln(F(x;µ)): %d', x, mu, y );
110-
}
106+
logEachMap( 'x: %d, µ: %d, ln(F(x;µ)): %0.4f', x, mu, logcdf );
111107
```
112108

113109
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/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 logcdf = 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( 10, 0, 10, opts );
29+
var mu = discreteUniform( 10, 0, 10, opts );
2930

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

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -106,21 +106,17 @@ y = mylogpdf( 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' );
109+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
110+
var logEachMap = require( '@stdlib/console/log-each-map' );
111111
var logpdf = require( '@stdlib/stats/base/dists/degenerate/logpdf' );
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 = logpdf( x, mu );
122-
console.log( 'x: %d, µ: %d, ln(f(x;µ)): %d', x, mu, y );
123-
}
119+
logEachMap( 'x: %d, µ: %d, ln(f(x;µ)): %0.4f', x, mu, logpdf );
124120
```
125121

126122
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/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 logpdf = 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 = logpdf( x, mu );
34-
console.log( 'x: %d, µ: %d, ln(f(x;µ)): %d', x, mu, y );
35-
}
31+
logEachMap( 'x: %d, µ: %d, ln(f(x;µ)): %0.4f', x, mu, logpdf );

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

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,17 @@ y = mylogpmf( 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 logpmf = require( '@stdlib/stats/base/dists/degenerate/logpmf' );
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 = logpmf( x, mu );
92-
console.log( 'x: %d, µ: %d, ln(P(X=x;µ)): %d', x, mu, y );
93-
}
89+
logEachMap( 'x: %d, µ: %d, ln(P(X=x;µ)): %0.4f', x, mu, logpmf );
9490
```
9591

9692
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/logpmf/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 logpmf = 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 = logpmf( x, mu );
34-
console.log( 'x: %d, µ: %d, ln(P(X=x;µ)): %d', x, mu, y );
35-
}
31+
logEachMap( 'x: %d, µ: %d, ln(P(X=x;µ)): %0.4f', x, mu, logpmf );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,16 @@ v = mean( -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 mean = require( '@stdlib/stats/base/dists/degenerate/mean' );
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 = mean( mu );
103-
console.log( 'µ: %d, E(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
104-
}
102+
logEachMap( 'µ: %0.4f, E(X;µ): %0.4f', mu, mean );
105103
```
106104

107105
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/mean/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 mean = 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 = mean( mu );
31-
console.log( 'µ: %d, E(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, E(X;µ): %0.4f', mu, mean );

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,16 @@ v = median( -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 median = require( '@stdlib/stats/base/dists/degenerate/median' );
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 = median( mu );
103-
console.log( 'µ: %d, Median(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
104-
}
102+
logEachMap( 'µ: %0.4f, Median(X;µ): %0.4f', mu, median );
105103
```
106104

107105
</section>

‎lib/node_modules/@stdlib/stats/base/dists/degenerate/median/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 median = 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 = median( mu );
31-
console.log( 'µ: %d, Median(X;µ): %d', mu.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'µ: %0.4f, Median(X;µ): %0.4f', mu, median );

0 commit comments

Comments
 (0)