Skip to content

Commit e4be7f9

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: #8259 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 6be75e8 commit e4be7f9

File tree

28 files changed

+242
-338
lines changed

28 files changed

+242
-338
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/logistic/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/logistic/cdf' );
131132

132-
var mu;
133-
var s;
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;
141-
s = randu() * 10.0;
142-
y = cdf( x, mu, s );
143-
console.log( 'x: %d, µ: %d, s: %d, F(x;µ,s): %d', x, mu, s, y );
144-
}
133+
var opts = {
134+
'dtype': 'float64'
135+
};
136+
var x = uniform( 10, 0.0, 10.0, opts );
137+
var mu = uniform( 10, 0.0, 10.0, opts );
138+
var s = uniform( 10, 0.0, 10.0, opts );
139+
140+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, F(x;µ,s): %0.4f', x, mu, s, cdf );
145141
```
146142

147143
</section>

‎lib/node_modules/@stdlib/stats/base/dists/logistic/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 mu;
25-
var s;
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 mu = uniform( 10, 0.0, 10.0, opts );
30+
var s = 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;
33-
s = randu() * 10.0;
34-
y = cdf( x, mu, s );
35-
console.log( 'x: %d, µ: %d, s: %d, F(x;µ,s): %d', x, mu, s, y );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, F(x;µ,s): %0.4f', x, mu, s, cdf );

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

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

113113
```javascript
114-
var randu = require( '@stdlib/random/base/randu' );
114+
var uniform = require( '@stdlib/random/array/uniform' );
115+
var logEachMap = require( '@stdlib/console/log-each-map' );
115116
var entropy = require( '@stdlib/stats/base/dists/logistic/entropy' );
116117

117-
var mu;
118-
var s;
119-
var y;
120-
var i;
118+
var opts = {
119+
'dtype': 'float64'
120+
};
121+
var mu = uniform( 10, -5.0, 5.0, opts );
122+
var s = uniform( 10, 0.0, 20.0, opts );
121123

122-
for ( i = 0; i < 10; i++ ) {
123-
mu = ( randu()*10.0 ) - 5.0;
124-
s = randu() * 20.0;
125-
y = entropy( mu, s );
126-
console.log( 'µ: %d, s: %d, h(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
127-
}
124+
logEachMap( 'µ: %0.4f, s: %0.4f, h(X;µ,s): %0.4f', mu, s, entropy );
128125
```
129126

130127
</section>

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

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

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

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

113113
```javascript
114-
var randu = require( '@stdlib/random/base/randu' );
114+
var uniform = require( '@stdlib/random/array/uniform' );
115+
var logEachMap = require( '@stdlib/console/log-each-map' );
115116
var kurtosis = require( '@stdlib/stats/base/dists/logistic/kurtosis' );
116117

117-
var mu;
118-
var s;
119-
var y;
120-
var i;
118+
var opts = {
119+
'dtype': 'float64'
120+
};
121+
var mu = uniform( 10, -5.0, 5.0, opts );
122+
var s = uniform( 10, 0.0, 20.0, opts );
121123

122-
for ( i = 0; i < 10; i++ ) {
123-
mu = ( randu()*10.0 ) - 5.0;
124-
s = randu() * 20.0;
125-
y = kurtosis( mu, s );
126-
console.log( 'µ: %d, s: %d, Kurt(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
127-
}
124+
logEachMap( 'µ: %0.4f, s: %0.4f, Kurt(X;µ,s): %0.4f', mu, s, kurtosis );
128125
```
129126

130127
</section>

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

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

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

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

138138
```javascript
139-
var randu = require( '@stdlib/random/base/randu' );
139+
var uniform = require( '@stdlib/random/array/uniform' );
140+
var logEachMap = require( '@stdlib/console/log-each-map' );
140141
var logcdf = require( '@stdlib/stats/base/dists/logistic/logcdf' );
141142

142-
var mu;
143-
var s;
144-
var x;
145-
var y;
146-
var i;
147-
148-
for ( i = 0; i < 10; i++ ) {
149-
x = randu() * 10.0;
150-
mu = randu() * 10.0;
151-
s = randu() * 10.0;
152-
y = logcdf( x, mu, s );
153-
console.log( 'x: %d, µ: %d, s: %d, ln(F(x;µ,s)): %d', x, mu, s, y );
154-
}
143+
var opts = {
144+
'dtype': 'float64'
145+
};
146+
var x = uniform( 10, 0.0, 10.0, opts );
147+
var mu = uniform( 10, 0.0, 10.0, opts );
148+
var s = uniform( 10, 0.0, 10.0, opts );
149+
150+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(F(x;µ,s)): %0.4f', x, mu, s, logcdf );
155151
```
156152

157153
</section>

‎lib/node_modules/@stdlib/stats/base/dists/logistic/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 mu;
25-
var s;
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 mu = uniform( 10, 0.0, 10.0, opts );
30+
var s = 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;
33-
s = randu() * 10.0;
34-
y = logcdf( x, mu, s );
35-
console.log( 'x: %d, µ: %d, s: %d, ln(F(x;µ,s)): %d', x, mu, s, y );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(F(x;µ,s)): %0.4f', x, mu, s, logcdf );

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

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

132132
```javascript
133-
var randu = require( '@stdlib/random/base/randu' );
133+
var uniform = require( '@stdlib/random/array/uniform' );
134+
var logEachMap = require( '@stdlib/console/log-each-map' );
134135
var logpdf = require( '@stdlib/stats/base/dists/logistic/logpdf' );
135136

136-
var mu;
137-
var s;
138-
var x;
139-
var y;
140-
var i;
141-
142-
for ( i = 0; i < 10; i++ ) {
143-
x = randu() * 10.0;
144-
mu = randu() * 10.0;
145-
s = randu() * 10.0;
146-
y = logpdf( x, mu, s );
147-
console.log( 'x: %d, µ: %d, s: %d, ln(f(x;µ,s)): %d', x, mu, s, y );
148-
}
137+
var opts = {
138+
'dtype': 'float64'
139+
};
140+
var x = uniform( 10, 0.0, 10.0, opts );
141+
var mu = uniform( 10, 0.0, 10.0, opts );
142+
var s = uniform( 10, 0.0, 10.0, opts );
143+
144+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(f(x;µ,s)): %0.4f', x, mu, s, logpdf );
149145
```
150146

151147
</section>

‎lib/node_modules/@stdlib/stats/base/dists/logistic/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 mu;
25-
var s;
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 mu = uniform( 10, 0.0, 10.0, opts );
30+
var s = uniform( 10, 0.0, 10.0, opts );
2931

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

0 commit comments

Comments
 (0)