Skip to content

Commit 853f07e

Browse files
committed
docs: replace manual for loop in examples
1 parent c216291 commit 853f07e

File tree

12 files changed

+105
-147
lines changed

12 files changed

+105
-147
lines changed

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

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

131131
```javascript
132-
var randu = require( '@stdlib/random/base/randu' );
132+
var uniform = require( '@stdlib/random/array/uniform' );
133+
var logEachMap = require( '@stdlib/console/log-each-map' );
133134
var cdf = require( '@stdlib/stats/base/dists/cosine/cdf' );
134135

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

150146
</section>

lib/node_modules/@stdlib/stats/base/dists/cosine/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/cosine/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/cosine/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/cosine/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/cosine/logcdf/README.md

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

141141
```javascript
142-
var randu = require( '@stdlib/random/base/randu' );
142+
var uniform = require( '@stdlib/random/array/uniform' );
143+
var logEachMap = require( '@stdlib/console/log-each-map' );
143144
var logcdf = require( '@stdlib/stats/base/dists/cosine/logcdf' );
144145

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

160156
</section>

lib/node_modules/@stdlib/stats/base/dists/cosine/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/cosine/logpdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -130,22 +130,18 @@ y = mylogpdf( 9.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/cosine/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/cosine/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 );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,17 @@ y = mean( 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 mean = require( '@stdlib/stats/base/dists/cosine/mean' );
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 = mean( mu, s );
126-
console.log( 'µ: %d, s: %d, E(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
127-
}
124+
logEachMap( 'µ: %0.4f, s: %0.4f, E(X;µ,s): %0.4f', mu, s, mean );
128125
```
129126

130127
</section>

lib/node_modules/@stdlib/stats/base/dists/cosine/mean/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 mean = 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 = mean( mu, s );
33-
console.log( 'µ: %d, s: %d, E(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'µ: %0.4f, s: %0.4f, E(X;µ,s): %0.4f', mu, s, mean );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,20 +111,17 @@ y = median( 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 median = require( '@stdlib/stats/base/dists/cosine/median' );
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 = median( mu, s );
126-
console.log( 'µ: %d, s: %d, Median(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
127-
}
124+
logEachMap( 'µ: %0.4f, s: %0.4f, Median(X;µ,s): %0.4f', mu, s, median );
128125
```
129126

130127
</section>

lib/node_modules/@stdlib/stats/base/dists/cosine/median/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 median = 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 = median( mu, s );
33-
console.log( 'µ: %d, s: %d, Median(X;µ,s): %d', mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'µ: %0.4f, s: %0.4f, Median(X;µ,s): %0.4f', mu, s, median );

0 commit comments

Comments
 (0)