Skip to content

Commit 6d64a34

Browse files
hrshyakgryte
andauthored
docs: replace manual for loop in examples
PR-URL: #9439 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent cf0cdff commit 6d64a34

28 files changed

Lines changed: 180 additions & 208 deletions

File tree

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,16 @@ y = mycdf( 1.0 );
103103
```javascript
104104
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
105105
var uniform = require( '@stdlib/random/array/uniform' );
106+
var logEachMap = require( '@stdlib/console/log-each-map' );
106107
var cdf = require( '@stdlib/stats/base/dists/planck/cdf' );
107108

108-
var x = discreteUniform( 10, 0, 5 );
109-
var lambda = uniform( 10, 0.1, 5.0 );
109+
var opts = {
110+
'dtype': 'float64'
111+
};
112+
var x = discreteUniform( 10, 0, 5, opts );
113+
var lambda = uniform( 10, 0.1, 5.0, opts );
110114

111-
var y;
112-
var i;
113-
for ( i = 0; i < lambda.length; i++ ) {
114-
y = cdf( x[ i ], lambda[ i ] );
115-
console.log( 'x: %d, λ: %d, F(x;λ): %d', x[ i ].toFixed( 4 ), lambda[ i ].toFixed( 4 ), y.toFixed( 4 ) );
116-
}
115+
logEachMap( 'x: %d, λ: %04f, F(x;λ): %04f', x, lambda, cdf );
117116
```
118117

119118
</section>

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@
2020

2121
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
2222
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var cdf = require( './../lib' );
2425

25-
var x = discreteUniform( 10, 0, 5 );
26-
var lambda = uniform( 10, 0.1, 5.0 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = discreteUniform( 10, 0, 5, opts );
30+
var lambda = uniform( 10, 0.1, 5.0, opts );
2731

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

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,15 @@ v = entropy( -1.5 );
9696

9797
```javascript
9898
var uniform = require( '@stdlib/random/array/uniform' );
99+
var logEachMap = require( '@stdlib/console/log-each-map' );
99100
var entropy = require( '@stdlib/stats/base/dists/planck/entropy' );
100101

101-
var lambda = uniform( 10, 0.1, 5.0 );
102+
var opts = {
103+
'dtype': 'float64'
104+
};
105+
var lambda = uniform( 10, 0.1, 5.0, opts );
102106

103-
var v;
104-
var i;
105-
for ( i = 0; i < lambda.length; i++ ) {
106-
v = entropy( lambda[ i ] );
107-
console.log( 'λ: %d, H(X;λ): %d', lambda[ i ].toFixed( 4 ), v.toFixed( 4 ) );
108-
}
107+
logEachMap( 'λ: %0.4f, H(X;λ): %0.4f', lambda, entropy );
109108
```
110109

111110
</section>

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

Lines changed: 6 additions & 7 deletions
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 lambda = uniform( 10, 0.1, 5.0 );
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var lambda = uniform( 10, 0.1, 5.0, opts );
2529

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

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

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,15 @@ v = kurtosis( -1.5 );
9696

9797
```javascript
9898
var uniform = require( '@stdlib/random/array/uniform' );
99+
var logEachMap = require( '@stdlib/console/log-each-map' );
99100
var kurtosis = require( '@stdlib/stats/base/dists/planck/kurtosis' );
100101

101-
var lambda = uniform( 10, 0.1, 10.0 );
102+
var opts = {
103+
'dtype': 'float64'
104+
};
105+
var lambda = uniform( 10, 0.1, 10.0, opts );
102106

103-
var v;
104-
var i;
105-
for ( i = 0; i < lambda.length; i++ ) {
106-
v = kurtosis( lambda[ i ] );
107-
console.log( 'λ: %d, Kurt(X;λ): %d', lambda[ i ].toFixed( 4 ), v.toFixed( 4 ) );
108-
}
107+
logEachMap( 'λ: %0.4f, Kurt(X;λ): %0.4f', lambda, kurtosis );
109108
```
110109

111110
</section>

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

Lines changed: 6 additions & 7 deletions
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 kurtosis = require( './../lib' );
2324

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

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

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -113,17 +113,16 @@ y = mylogcdf( 1.0 );
113113
```javascript
114114
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
115115
var uniform = require( '@stdlib/random/array/uniform' );
116+
var logEachMap = require( '@stdlib/console/log-each-map' );
116117
var logcdf = require( '@stdlib/stats/base/dists/planck/logcdf' );
117118

118-
var x = discreteUniform( 10, 0, 5 );
119-
var lambda = uniform( 10, 0.1, 5.0 );
119+
var opts = {
120+
'dtype': 'float64'
121+
};
122+
var x = discreteUniform( 10, 0, 5, opts );
123+
var lambda = uniform( 10, 0.1, 5.0, opts );
120124

121-
var y;
122-
var i;
123-
for ( i = 0; i < lambda.length; i++ ) {
124-
y = logcdf( x[ i ], lambda[ i ] );
125-
console.log( 'x: %d, λ: %d, ln(F(x;λ)): %d', x[ i ].toFixed( 4 ), lambda[ i ].toFixed( 4 ), y.toFixed( 4 ) );
126-
}
125+
logEachMap( 'x: %0.4f, λ: %0.4f, ln(F(x;λ)): %0.4f', x, lambda, logcdf );
127126
```
128127

129128
</section>

lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/examples/index.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@
2020

2121
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
2222
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var logcdf = require( './../lib' );
2425

25-
var x = discreteUniform( 10, 0, 5 );
26-
var lambda = uniform( 10, 0.1, 5.0 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = discreteUniform( 10, 0, 5, opts );
30+
var lambda = uniform( 10, 0.1, 5.0, opts );
2731

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

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,16 @@ y = mylogpmf( 1.0 );
116116
```javascript
117117
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
118118
var uniform = require( '@stdlib/random/array/uniform' );
119+
var logEachMap = require( '@stdlib/console/log-each-map' );
119120
var logpmf = require( '@stdlib/stats/base/dists/planck/logpmf' );
120121

121-
var x = discreteUniform( 10, 0, 5 );
122-
var lambda = uniform( 10, 0.1, 5.0 );
122+
var opts = {
123+
'dtype': 'float64'
124+
};
125+
var x = discreteUniform( 10, 0, 5, opts );
126+
var lambda = uniform( 10, 0.1, 5.0, opts );
123127

124-
var y;
125-
var i;
126-
for ( i = 0; i < lambda.length; i++ ) {
127-
y = logpmf( x[ i ], lambda[ i ] );
128-
console.log( 'x: %d, λ: %d, ln( P( X = x; λ ) ): %d', x[ i ], lambda[ i ].toFixed( 4 ), y.toFixed( 4 ) );
129-
}
128+
logEachMap( 'x: %d, λ: %0.4f, ln( P( X = x; λ ) ): %0.4f', x, lambda, logpmf );
130129
```
131130

132131
</section>

lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/examples/index.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,13 @@
2020

2121
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
2222
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var logpmf = require( './../lib' );
2425

25-
var x = discreteUniform( 10, 0, 5 );
26-
var lambda = uniform( 10, 0.1, 5.0 );
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = discreteUniform( 10, 0, 5, opts );
30+
var lambda = uniform( 10, 0.1, 5.0, opts );
2731

28-
var y;
29-
var i;
30-
for ( i = 0; i < lambda.length; i++ ) {
31-
y = logpmf( x[ i ], lambda[ i ] );
32-
console.log( 'x: %d, λ: %d, ln( P( X = x; λ ) ): %d', x[ i ], lambda[ i ].toFixed( 4 ), y.toFixed( 4 ) );
33-
}
32+
logEachMap( 'x: %d, λ: %0.4f, ln( P( X = x; λ ) ): %0.4f', x, lambda, logpmf );

0 commit comments

Comments
 (0)