Skip to content

Commit e991da9

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #6906 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 917c6e0 commit e991da9

File tree

8 files changed

+51
-58
lines changed

8 files changed

+51
-58
lines changed

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

+7-8
Original file line numberDiff line numberDiff line change
@@ -119,17 +119,16 @@ y = myPDF( 1.0 );
119119

120120
```javascript
121121
var uniform = require( '@stdlib/random/array/uniform' );
122+
var logEachMap = require( '@stdlib/console/log-each-map' );
122123
var cdf = require( '@stdlib/stats/base/dists/bradford/cdf' );
123124

124-
var x = uniform( 10, 0.0, 1.0 );
125-
var c = uniform( 10, 0.1, 10.0 );
125+
var opts = {
126+
'dtype': 'float64'
127+
};
128+
var x = uniform( 10, 0.0, 1.0, opts );
129+
var c = uniform( 10, 0.1, 10.0, opts );
126130

127-
var y;
128-
var i;
129-
for ( i = 0; i < x.length; i++ ) {
130-
y = cdf( x[ i ], c[ i ] );
131-
console.log( 'x: %d, c: %d, F(x;c): %d', x[ i ].toFixed( 4 ), c[ i ].toFixed( 4 ), y.toFixed( 4 ) );
132-
}
131+
logEachMap( 'x: %0.4f, c: %0.4f, F(x;c): %0.4f', x, c, cdf );
133132
```
134133

135134
</section>

lib/node_modules/@stdlib/stats/base/dists/bradford/cdf/examples/index.js

+7-8
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,13 @@
1919
'use strict';
2020

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

24-
var x = uniform( 10, 0.0, 1.0 );
25-
var c = uniform( 10, 0.1, 10.0 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 1.0, opts );
29+
var c = uniform( 10, 0.1, 10.0, opts );
2630

27-
var y;
28-
var i;
29-
for ( i = 0; i < x.length; i++ ) {
30-
y = cdf( x[ i ], c[ i ] );
31-
console.log( 'x: %d, c: %d, F(x;c): %d', x[ i ].toFixed( 4 ), c[ i ].toFixed( 4 ), y.toFixed( 4 ) );
32-
}
31+
logEachMap( 'x: %0.4f, c: %0.4f, F(x;c): %0.4f', x, c, cdf );

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,15 @@ v = entropy( -1.5 );
101101

102102
```javascript
103103
var uniform = require( '@stdlib/random/array/uniform' );
104+
var logEachMap = require( '@stdlib/console/log-each-map' );
104105
var entropy = require( '@stdlib/stats/base/dists/bradford/entropy' );
105106

106-
var c = uniform( 10, 0.1, 10.0 );
107+
var opts = {
108+
'dtype': 'float64'
109+
};
110+
var c = uniform( 10, 0.1, 10.0, opts );
107111

108-
var v;
109-
var i;
110-
for ( i = 0; i < c.length; i++ ) {
111-
v = entropy( c[ i ] );
112-
console.log( 'c: %d, h(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
113-
}
112+
logEachMap( 'c: %0.4f, h(X;c): %0.4f', c, entropy );
114113
```
115114

116115
</section>

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@
1919
'use strict';
2020

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

24-
var c = uniform( 10, 0.1, 10.0 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var c = uniform( 10, 0.1, 10.0, opts );
2529

26-
var v;
27-
var i;
28-
for ( i = 0; i < c.length; i++ ) {
29-
v = entropy( c[ i ] );
30-
console.log( 'c: %d, h(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
31-
}
30+
logEachMap( 'c: %0.4f, h(X;c): %0.4f', c, entropy );

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,16 @@ v = mean( -1.5 );
101101

102102
```javascript
103103
var uniform = require( '@stdlib/random/array/uniform' );
104+
var logEachMap = require( '@stdlib/console/log-each-map' );
104105
var mean = require( '@stdlib/stats/base/dists/bradford/mean' );
105106

106-
var c = uniform( 10, 0.1, 10.0 );
107+
var opts = {
108+
'dtype': 'float64'
109+
};
110+
var c = uniform( 10, 0.1, 10.0, opts );
111+
112+
logEachMap( 'c: %0.4f, E(X;c): %0.4f', c, mean );
107113

108-
var v;
109-
var i;
110-
for ( i = 0; i < c.length; i++ ) {
111-
v = mean( c[ i ] );
112-
console.log( 'c: %d, E(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
113-
}
114114
```
115115

116116
</section>

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@
1919
'use strict';
2020

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

24-
var c = uniform( 10, 0.1, 10.0 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var c = uniform( 10, 0.1, 10.0, opts );
2529

26-
var v;
27-
var i;
28-
for ( i = 0; i < c.length; i++ ) {
29-
v = mean( c[ i ] );
30-
console.log( 'c: %d, E(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
31-
}
30+
logEachMap( 'c: %0.4f, E(X;c): %0.4f', c, mean );

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

+6-7
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,15 @@ v = median( -1.5 );
101101

102102
```javascript
103103
var uniform = require( '@stdlib/random/array/uniform' );
104+
var logEachMap = require( '@stdlib/console/log-each-map' );
104105
var median = require( '@stdlib/stats/base/dists/bradford/median' );
105106

106-
var c = uniform( 10, 0.1, 10.0 );
107+
var opts = {
108+
'dtype': 'float64'
109+
};
110+
var c = uniform( 10, 0.1, 10.0, opts );
107111

108-
var v;
109-
var i;
110-
for ( i = 0; i < c.length; i++ ) {
111-
v = median( c[ i ] );
112-
console.log( 'c: %d, Median(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
113-
}
112+
logEachMap( 'c: %0.4f, Median(X;c): %0.4f', c, median );
114113
```
115114

116115
</section>

lib/node_modules/@stdlib/stats/base/dists/bradford/median/examples/index.js

+6-7
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@
1919
'use strict';
2020

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

24-
var c = uniform( 10, 0.1, 10.0 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var c = uniform( 10, 0.1, 10.0, opts );
2529

26-
var v;
27-
var i;
28-
for ( i = 0; i < c.length; i++ ) {
29-
v = median( c[ i ] );
30-
console.log( 'c: %d, Median(X;c): %d', c[ i ].toFixed( 4 ), v.toFixed( 4 ) );
31-
}
30+
logEachMap( 'c: %0.4f, Median(X;c): %0.4f', c, median );

0 commit comments

Comments
 (0)