Skip to content

Commit 993324c

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: #7888 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 33a5485 commit 993324c

File tree

10 files changed

+83
-115
lines changed

10 files changed

+83
-115
lines changed

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

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

134134
```javascript
135-
var randu = require( '@stdlib/random/base/randu' );
135+
var uniform = require( '@stdlib/random/array/uniform' );
136+
var logEachMap = require( '@stdlib/console/log-each-map' );
136137
var cdf = require( '@stdlib/stats/base/dists/f/cdf' );
137138

138-
var d1;
139-
var d2;
140-
var x;
141-
var y;
142-
var i;
143-
144-
for ( i = 0; i < 10; i++ ) {
145-
x = randu() * 10.0;
146-
d1 = randu() * 10.0;
147-
d2 = randu() * 10.0;
148-
y = cdf( x, d1, d2 );
149-
console.log( 'x: %d, d1: %d, d2: %d, F(x;d1,d2): %d', x.toFixed( 4 ), d1.toFixed( 4 ), d2.toFixed( 4 ), y.toFixed( 4 ) );
150-
}
139+
var opts = {
140+
'dtype': 'float64'
141+
};
142+
var x = uniform( 10, 0.0, 10.0, opts );
143+
var d1 = uniform( 10, 0.0, 10.0, opts );
144+
var d2 = uniform( 10, 0.0, 10.0, opts );
145+
146+
logEachMap( 'x: %0.4f, d1: %0.4f, d2: %0.4f, F(x;d1,d2): %0.4f', x, d1, d2, cdf );
151147
```
152148

153149
</section>

‎lib/node_modules/@stdlib/stats/base/dists/f/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 d1;
25-
var d2;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 10.0, opts );
29+
var d1 = uniform( 10, 0.0, 10.0, opts );
30+
var d2 = uniform( 10, 0.0, 10.0, opts );
2931

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = entropy( 3.0, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var EPS = require( '@stdlib/constants/float64/eps' );
128129
var entropy = require( '@stdlib/stats/base/dists/f/entropy' );
129130

130-
var d1;
131-
var d2;
132-
var v;
133-
var i;
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var d1 = uniform( 10, EPS, 10.0, opts );
135+
var d2 = uniform( 10, EPS, 20.0, opts );
134136

135-
for ( i = 0; i < 10; i++ ) {
136-
d1 = ( randu()*10.0 ) + EPS;
137-
d2 = ( randu()*10.0 ) + EPS;
138-
v = entropy( d1, d2 );
139-
console.log( 'd1: %d, d2: %d, h(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'd1: %0.4f, d2: %0.4f, h(X;d1,d2): %0.4f', d1, d2, entropy );
141138
```
142139

143140
</section>

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

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var entropy = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 20.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
d1 = ( randu()*10.0 ) + EPS;
32-
d2 = ( randu()*20.0 ) + EPS;
33-
v = entropy( d1, d2 );
34-
console.log( 'd1: %d, d2: %d, h(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'd1: %0.4f, d2: %0.4f, h(X;d1,d2): %0.4f', d1, d2, entropy );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -126,21 +126,18 @@ v = kurtosis( 3.0, -1.0 );
126126
<!-- eslint no-undef: "error" -->
127127

128128
```javascript
129-
var randu = require( '@stdlib/random/base/randu' );
129+
var uniform = require( '@stdlib/random/array/uniform' );
130+
var logEachMap = require( '@stdlib/console/log-each-map' );
130131
var EPS = require( '@stdlib/constants/float64/eps' );
131132
var kurtosis = require( '@stdlib/stats/base/dists/f/kurtosis' );
132133

133-
var d1;
134-
var d2;
135-
var v;
136-
var i;
134+
var opts = {
135+
'dtype': 'float64'
136+
};
137+
var d1 = uniform( 10, EPS, 10.0, opts );
138+
var d2 = uniform( 10, EPS, 20.0, opts );
137139

138-
for ( i = 0; i < 10; i++ ) {
139-
d1 = ( randu()*10.0 ) + EPS;
140-
d2 = ( randu()*20.0 ) + EPS;
141-
v = kurtosis( d1, d2 );
142-
console.log( 'd1: %d, d2: %d, Kurt(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
143-
}
140+
logEachMap( 'd1: %0.4f, d2: %0.4f, Kurt(X;d1,d2): %0.4f', d1, d2, kurtosis );
144141
```
145142

146143
</section>

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

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var kurtosis = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 20.0, opts );
2931

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,18 @@ v = mean( 1.0, -1.0 );
121121
<!-- eslint no-undef: "error" -->
122122

123123
```javascript
124-
var randu = require( '@stdlib/random/base/randu' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var EPS = require( '@stdlib/constants/float64/eps' );
126127
var mean = require( '@stdlib/stats/base/dists/f/mean' );
127128

128-
var d1;
129-
var d2;
130-
var v;
131-
var i;
129+
var opts = {
130+
'dtype': 'float64'
131+
};
132+
var d1 = uniform( 10, EPS, 10.0, opts );
133+
var d2 = uniform( 10, EPS, 10.0, opts );
132134

133-
for ( i = 0; i < 10; i++ ) {
134-
d1 = ( randu()*10.0 ) + EPS;
135-
d2 = ( randu()*10.0 ) + EPS;
136-
v = mean( d1, d2 );
137-
console.log( 'd1: %d, d2: %d, E(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
138-
}
135+
logEachMap( 'd1: %0.4f, d2: %0.4f, E(X;d1,d2): %0.4f', d1, d2, mean );
139136
```
140137

141138
</section>

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

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var mean = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 10.0, opts );
2931

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = mode( 3.0, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var EPS = require( '@stdlib/constants/float64/eps' );
128129
var mode = require( '@stdlib/stats/base/dists/f/mode' );
129130

130-
var d1;
131-
var d2;
132-
var v;
133-
var i;
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var d1 = uniform( 10, EPS, 10.0, opts );
135+
var d2 = uniform( 10, EPS, 10.0, opts );
134136

135-
for ( i = 0; i < 10; i++ ) {
136-
d1 = ( randu()*10.0 ) + EPS;
137-
d2 = ( randu()*10.0 ) + EPS;
138-
v = mode( d1, d2 );
139-
console.log( 'd1: %d, d2: %d, mode(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'd1: %0.4f, d2: %0.4f, mode(X;d1,d2): %0.4f', d1, d2, mode );
141138
```
142139

143140
</section>

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

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var mode = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 10.0, opts );
2931

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

0 commit comments

Comments
 (0)