Skip to content

Commit 3b39228

Browse files
authored
docs: replace manual for loop in examples
PR-URL: stdlib-js#8263 Reviewed-by: Athan Reines <[email protected]>
1 parent be6826b commit 3b39228

File tree

26 files changed

+225
-313
lines changed

26 files changed

+225
-313
lines changed

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

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

116116
```javascript
117-
var randu = require( '@stdlib/random/base/randu' );
117+
var uniform = require( '@stdlib/random/array/uniform' );
118+
var logEachMap = require( '@stdlib/console/log-each-map' );
118119
var cdf = require( '@stdlib/stats/base/dists/lognormal/cdf' );
119120

120-
var sigma;
121-
var mu;
122-
var x;
123-
var y;
124-
var i;
125-
126-
for ( i = 0; i < 10; i++ ) {
127-
x = randu() * 10.0;
128-
mu = (randu() * 10.0) - 5.0;
129-
sigma = randu() * 20.0;
130-
y = cdf( x, mu, sigma );
131-
console.log( 'x: %d, µ: %d, σ: %d, F(x;µ,σ): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
132-
}
121+
var opts = {
122+
'dtype': 'float64'
123+
};
124+
var x = uniform( 10, 0.0, 10.0, opts );
125+
var mu = uniform( 10, -5.0, 5.0, opts );
126+
var sigma = uniform( 10, 0.0, 20.0, opts );
127+
128+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, F(x;µ,σ): %0.4f', x, mu, sigma, cdf );
133129
```
134130

135131
</section>

lib/node_modules/@stdlib/stats/base/dists/lognormal/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 x = uniform( 10, 0.0, 10.0, opts );
29+
var mu = uniform( 10, -5.0, 5.0, opts );
30+
var sigma = uniform( 10, 0.0, 20.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.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
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/lognormal/entropy/README.md

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

116116
```javascript
117-
var randu = require( '@stdlib/random/base/randu' );
117+
var uniform = require( '@stdlib/random/array/uniform' );
118+
var logEachMap = require( '@stdlib/console/log-each-map' );
118119
var entropy = require( '@stdlib/stats/base/dists/lognormal/entropy' );
119120

120-
var sigma;
121-
var mu;
122-
var y;
123-
var i;
121+
var opts = {
122+
'dtype': 'float64'
123+
};
124+
var mu = uniform( 10, -5.0, 5.0, opts );
125+
var sigma = uniform( 10, 0.0, 20.0, opts );
124126

125-
for ( i = 0; i < 10; i++ ) {
126-
mu = ( randu()*10.0 ) - 5.0;
127-
sigma = randu() * 20.0;
128-
y = entropy( mu, sigma );
129-
console.log( 'µ: %d, σ: %d, h(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
130-
}
127+
logEachMap( 'µ: %0.4f, σ: %0.4f, h(X;µ,σ): %0.4f', mu, sigma, entropy );
131128
```
132129

133130
</section>

lib/node_modules/@stdlib/stats/base/dists/lognormal/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 mu = uniform( 10, -5.0, 5.0, opts );
29+
var sigma = uniform( 10, 0.0, 20.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/lognormal/kurtosis/README.md

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

116116
```javascript
117-
var randu = require( '@stdlib/random/base/randu' );
117+
var uniform = require( '@stdlib/random/array/uniform' );
118+
var logEachMap = require( '@stdlib/console/log-each-map' );
118119
var kurtosis = require( '@stdlib/stats/base/dists/lognormal/kurtosis' );
119120

120-
var sigma;
121-
var mu;
122-
var y;
123-
var i;
121+
var opts = {
122+
'dtype': 'float64'
123+
};
124+
var mu = uniform( 10, -5.0, 5.0, opts );
125+
var sigma = uniform( 10, 0.0, 20.0, opts );
124126

125-
for ( i = 0; i < 10; i++ ) {
126-
mu = ( randu()*10.0 ) - 5.0;
127-
sigma = ( randu()*4.9 ) + 0.1;
128-
y = kurtosis( mu, sigma );
129-
console.log( 'µ: %d, σ: %d, Kurt(X;µ,σ): %d', mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
130-
}
127+
logEachMap( 'µ: %0.4f, σ: %0.4f, Kurt(X;µ,σ): %0.4f', mu, sigma, kurtosis );
131128
```
132129

133130
</section>

lib/node_modules/@stdlib/stats/base/dists/lognormal/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 mu = uniform( 10, -5.0, 5.0, opts );
29+
var sigma = uniform( 10, 0.0, 20.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/lognormal/logcdf/README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ var y = logcdf( 2.0, 8.0, 0.0 );
7575
// returns -Infinity
7676

7777
y = logcdf( 8.0, 8.0, 0.0 );
78-
// returns 0.0
78+
// returns -Infinity
7979

8080
y = logcdf( 10.0, 8.0, 0.0 );
81-
// returns 0.0
81+
// returns -Infinity
8282
```
8383

8484
#### logcdf.factory( mu, sigma )
@@ -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/lognormal/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 x = uniform( 10, 0.0, 10.0, opts );
117+
var mu = uniform( 10, -5.0, 5.0, opts );
118+
var sigma = uniform( 10, 0.0, 20.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/lognormal/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 x = uniform( 10, 0.0, 10.0, opts );
29+
var mu = uniform( 10, -5.0, 5.0, opts );
30+
var sigma = uniform( 10, 0.0, 20.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/lognormal/logpdf/README.md

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

118118
```javascript
119-
var randu = require( '@stdlib/random/base/randu' );
119+
var uniform = require( '@stdlib/random/array/uniform' );
120+
var logEachMap = require( '@stdlib/console/log-each-map' );
120121
var logpdf = require( '@stdlib/stats/base/dists/lognormal/logpdf' );
121122

122-
var sigma;
123-
var mu;
124-
var x;
125-
var y;
126-
var i;
127-
128-
for ( i = 0; i < 10; i++ ) {
129-
x = randu() * 10.0;
130-
mu = (randu() * 10.0) - 5.0;
131-
sigma = randu() * 20.0;
132-
y = logpdf( x, mu, sigma );
133-
console.log( 'x: %d, µ: %d, σ: %d, ln(f(x;µ,σ)): %d', x.toFixed( 4 ), mu.toFixed( 4 ), sigma.toFixed( 4 ), y.toFixed( 4 ) );
134-
}
123+
var opts = {
124+
'dtype': 'float64'
125+
};
126+
var x = uniform( 10, 0.0, 10.0, opts );
127+
var mu = uniform( 10, -5.0, 5.0, opts );
128+
var sigma = uniform( 10, 0.0, 20.0, opts );
129+
130+
logEachMap( 'x: %0.4f, µ: %0.4f, σ: %0.4f, ln(f(x;µ,σ)): %0.4f', x, mu, sigma, logpdf );
135131
```
136132

137133
</section>

lib/node_modules/@stdlib/stats/base/dists/lognormal/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 x = uniform( 10, 0.0, 10.0, opts );
29+
var mu = uniform( 10, -5.0, 5.0, opts );
30+
var sigma = uniform( 10, 0.0, 20.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)