Skip to content

Commit 6fe0761

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #9055 Reviewed-by: Athan Reines <[email protected]>
1 parent 1c08d9e commit 6fe0761

File tree

28 files changed

+242
-338
lines changed

28 files changed

+242
-338
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -126,22 +126,18 @@ y = mycdf( 8.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 cdf = require( '@stdlib/stats/base/dists/normal/cdf' );
131132

132-
var sigma;
133-
var mu;
134-
var x;
135-
var y;
136-
var i;
137-
138-
for ( i = 0; i < 10; i++ ) {
139-
x = randu() * 10.0;
140-
mu = (randu() * 10.0) - 5.0;
141-
sigma = randu() * 20.0;
142-
y = cdf( x, mu, sigma );
143-
console.log( 'x: %d, µ: %d, σ: %d, F(x;µ,σ): %d', x, mu, sigma, y );
144-
}
133+
var opts = {
134+
'dtype': 'float64'
135+
};
136+
var sigma = uniform( 10, 0.0, 20.0, opts );
137+
var mu = uniform( 10, -5.0, 5.0, opts );
138+
var x = uniform( 10, 0.0, 10.0, opts );
139+
140+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, F(x;µ,σ): %0.4f', x, mu, sigma, cdf );
145141
```
146142

147143
</section>

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

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 10.0;
32-
mu = (randu() * 10.0) - 5.0;
33-
sigma = randu() * 20.0;
34-
y = cdf( x, mu, sigma );
35-
console.log( 'x: %d, µ: %d, σ: %d, F(x;µ,σ): %d', x, mu, sigma, y );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, F(x;µ,σ): %0.4f', x, mu, sigma, cdf );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,20 +108,17 @@ y = entropy( 0.0, -1.0 );
108108
<!-- eslint no-undef: "error" -->
109109

110110
```javascript
111-
var randu = require( '@stdlib/random/base/randu' );
111+
var uniform = require( '@stdlib/random/array/uniform' );
112+
var logEachMap = require( '@stdlib/console/log-each-map' );
112113
var entropy = require( '@stdlib/stats/base/dists/normal/entropy' );
113114

114-
var sigma;
115-
var mu;
116-
var y;
117-
var i;
115+
var opts = {
116+
'dtype': 'float64'
117+
};
118+
var sigma = uniform( 10, 0.0, 20.0, opts );
119+
var mu = uniform( 10, -5.0, 5.0, opts );
118120

119-
for ( i = 0; i < 10; i++ ) {
120-
mu = ( randu()*10.0 ) - 5.0;
121-
sigma = randu() * 20.0;
122-
y = entropy( mu, sigma );
123-
console.log( 'µ: %d, σ: %d, h(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
124-
}
121+
logEachMap( 'µ: %0.4f, σ: %0.4f, h(X;µ,σ): %0.4f', mu, sigma, entropy );
125122
```
126123

127124
</section>

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

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

29-
for ( i = 0; i < 10; i++ ) {
30-
mu = ( randu()*10.0 ) - 5.0;
31-
sigma = randu() * 20.0;
32-
y = entropy( mu, sigma );
33-
console.log( 'µ: %d, σ: %d, h(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'µ: %0.4f, σ: %0.4f, h(X;µ,σ): %0.4f', mu, sigma, entropy );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,20 +108,17 @@ y = kurtosis( 0.0, -1.0 );
108108
<!-- eslint no-undef: "error" -->
109109

110110
```javascript
111-
var randu = require( '@stdlib/random/base/randu' );
111+
var uniform = require( '@stdlib/random/array/uniform' );
112+
var logEachMap = require( '@stdlib/console/log-each-map' );
112113
var kurtosis = require( '@stdlib/stats/base/dists/normal/kurtosis' );
113114

114-
var sigma;
115-
var mu;
116-
var y;
117-
var i;
115+
var opts = {
116+
'dtype': 'float64'
117+
};
118+
var sigma = uniform( 10, 0.0, 20.0, opts );
119+
var mu = uniform( 10, -5.0, 5.0, opts );
118120

119-
for ( i = 0; i < 10; i++ ) {
120-
mu = ( randu()*10.0 ) - 5.0;
121-
sigma = randu() * 20.0;
122-
y = kurtosis( mu, sigma );
123-
console.log( 'µ: %d, σ: %d, Kurt(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
124-
}
121+
logEachMap( 'µ: %0.4f, σ: %0.4f, Kurt(X;µ,σ): %0.4f', mu, sigma, kurtosis );
125122
```
126123

127124
</section>

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

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

29-
for ( i = 0; i < 10; i++ ) {
30-
mu = ( randu()*10.0 ) - 5.0;
31-
sigma = randu() * 20.0;
32-
y = kurtosis( mu, sigma );
33-
console.log( 'µ: %d, σ: %d, Kurt(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'µ: %0.4f, σ: %0.4f, Kurt(X;µ,σ): %0.4f', mu, sigma, kurtosis );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -106,22 +106,18 @@ y = mylogcdf( 5.0 );
106106
<!-- eslint no-undef: "error" -->
107107

108108
```javascript
109-
var randu = require( '@stdlib/random/base/randu' );
109+
var uniform = require( '@stdlib/random/array/uniform' );
110+
var logEachMap = require( '@stdlib/console/log-each-map' );
110111
var logcdf = require( '@stdlib/stats/base/dists/normal/logcdf' );
111112

112-
var sigma;
113-
var mu;
114-
var x;
115-
var y;
116-
var i;
117-
118-
for ( i = 0; i < 10; i++ ) {
119-
x = randu() * 10.0;
120-
mu = (randu() * 10.0) - 5.0;
121-
sigma = randu() * 20.0;
122-
y = logcdf( x, mu, sigma );
123-
console.log( 'x: %d, µ: %d, σ: %d, ln(F(x;µ,σ)): %d', x, mu, sigma, y );
124-
}
113+
var opts = {
114+
'dtype': 'float64'
115+
};
116+
var sigma = uniform( 10, 0.0, 20.0, opts );
117+
var mu = uniform( 10, -5.0, 5.0, opts );
118+
var x = uniform( 10, 0.0, 10.0, opts );
119+
120+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(F(x;µ,σ)): %0.4f', x, mu, sigma, logcdf );
125121
```
126122

127123
</section>

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

24-
var sigma;
25-
var mu;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var sigma = uniform( 10, 0.0, 20.0, opts );
29+
var mu = uniform( 10, -5.0, 5.0, opts );
30+
var x = uniform( 10, 0.0, 10.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 10.0;
32-
mu = (randu() * 10.0) - 5.0;
33-
sigma = randu() * 20.0;
34-
y = logcdf( x, mu, sigma );
35-
console.log( 'x: %d, µ: %d, σ: %d, ln(F(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(F(x;µ,σ)): %0.4f', x, mu, sigma, logcdf );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -120,22 +120,18 @@ y = mylogpdf( 5.0 );
120120
<!-- eslint no-undef: "error" -->
121121

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
123+
var uniform = require( '@stdlib/random/array/uniform' );
124+
var logEachMap = require( '@stdlib/console/log-each-map' );
124125
var logpdf = require( '@stdlib/stats/base/dists/normal/logpdf' );
125126

126-
var sigma;
127-
var mu;
128-
var x;
129-
var y;
130-
var i;
131-
132-
for ( i = 0; i < 10; i++ ) {
133-
x = randu() * 10.0;
134-
mu = (randu() * 10.0) - 5.0;
135-
sigma = randu() * 20.0;
136-
y = logpdf( x, mu, sigma );
137-
console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x, mu, sigma, y );
138-
}
127+
var opts = {
128+
'dtype': 'float64'
129+
};
130+
var sigma = uniform( 10, 0.0, 20.0, opts );
131+
var mu = uniform( 10, -5.0, 5.0, opts );
132+
var x = uniform( 10, 0.0, 10.0, opts );
133+
134+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(f(x;µ,σ)): %0.4f', x, mu, sigma, logpdf );
139135
```
140136

141137
</section>

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

24-
var sigma;
25-
var mu;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var sigma = uniform( 10, 0.0, 20.0, opts );
29+
var mu = uniform( 10, -5.0, 5.0, opts );
30+
var x = uniform( 10, 0.0, 10.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 10.0;
32-
mu = (randu() * 10.0) - 5.0;
33-
sigma = randu() * 20.0;
34-
y = logpdf( x, mu, sigma );
35-
console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(f(x;µ,σ)): %0.4f', x, mu, sigma, logpdf );

0 commit comments

Comments
 (0)