Skip to content

Commit 5bed283

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #7075 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent d3e9442 commit 5bed283

File tree

14 files changed

+121
-169
lines changed

14 files changed

+121
-169
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -113,22 +113,18 @@ var y = mymgf( 0.1 );
113113
<!-- eslint no-undef: "error" -->
114114

115115
```javascript
116-
var randu = require( '@stdlib/random/base/randu' );
116+
var uniform = require( '@stdlib/random/array/uniform' );
117+
var logEachMap = require( '@stdlib/console/log-each-map' );
117118
var mgf = require( '@stdlib/stats/base/dists/cosine/mgf' );
118119

119-
var mu;
120-
var s;
121-
var t;
122-
var y;
123-
var i;
124-
125-
for ( i = 0; i < 10; i++ ) {
126-
t = randu() * 10.0;
127-
mu = randu() * 10.0;
128-
s = randu() * 10.0;
129-
y = mgf( t, mu, s );
130-
console.log( 't: %d, µ: %d, s: %d, M_X(t;µ,s): %d', t.toFixed( 4 ), mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
131-
}
120+
var opts = {
121+
'dtype': 'float64'
122+
};
123+
var t = uniform( 10, 0.0, 10.0, opts );
124+
var mu = uniform( 10, 0.0, 10.0, opts );
125+
var s = uniform( 10, 0.0, 10.0, opts );
126+
127+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, M_X(t;µ,s): %0.4f', t, mu, s, mgf );
132128
```
133129

134130
</section>

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

24-
var mu;
25-
var s;
26-
var t;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var t = 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-
t = randu() * 10.0;
32-
mu = randu() * 10.0;
33-
s = randu() * 10.0;
34-
y = mgf( t, mu, s );
35-
console.log( 'x: %d, µ: %d, s: %d, M_X(t;µ,s): %d', t.toFixed( 4 ), mu.toFixed( 4 ), s.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, M_X(t;µ,s): %0.4f', t, mu, s, mgf );

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

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

130127
</section>

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

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -120,22 +120,18 @@ y = mypdf( 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 pdf = require( '@stdlib/stats/base/dists/cosine/pdf' );
125126

126-
var mu;
127-
var s;
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;
135-
s = randu() * 10.0;
136-
y = pdf( x, mu, s );
137-
console.log( 'x: %d, µ: %d, s: %d, f(x;µ,s): %d', x, mu, s, y );
138-
}
127+
var opts = {
128+
'dtype': 'float64'
129+
};
130+
var x = uniform( 10, 0.0, 10.0, opts );
131+
var mu = uniform( 10, 0.0, 10.0, opts );
132+
var s = uniform( 10, 0.0, 10.0, opts );
133+
134+
logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, f(x;µ,s): %0.4f', x, mu, s, pdf );
139135
```
140136

141137
</section>

lib/node_modules/@stdlib/stats/base/dists/cosine/pdf/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 pdf = 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 = pdf( 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, pdf );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,22 +111,18 @@ y = myQuantile( 0.9 );
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 quantile = require( '@stdlib/stats/base/dists/cosine/quantile' );
116117

117-
var mu;
118-
var s;
119-
var p;
120-
var y;
121-
var i;
122-
123-
for ( i = 0; i < 10; i++ ) {
124-
p = randu();
125-
mu = randu() * 10.0;
126-
s = randu() * 10.0;
127-
y = quantile( p, mu, s );
128-
console.log( 'p: %d, µ: %d, s: %d, Q(p;µ,s): %d', p, mu, s, y );
129-
}
118+
var opts = {
119+
'dtype': 'float64'
120+
};
121+
var p = uniform( 10, 0.0, 1.0, opts );
122+
var mu = uniform( 10, 0.0, 10.0, opts );
123+
var s = uniform( 10, 0.0, 10.0, opts );
124+
125+
logEachMap( 'p: %0.4f, µ: %0.4f, s: %0.4f, Q(p;µ,s): %0.4f', p, mu, s, quantile );
130126
```
131127

132128
</section>

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

24-
var mu;
25-
var s;
26-
var p;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var p = uniform( 10, 0.0, 1.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-
p = randu();
32-
mu = randu() * 10.0;
33-
s = randu() * 10.0;
34-
y = quantile( p, mu, s );
35-
console.log( 'p: %d, µ: %d, s: %d, Q(p;µ,s): %d', p, mu, s, y );
36-
}
32+
logEachMap( 'p: %0.4f, µ: %0.4f, s: %0.4f, Q(p;µ,s): %0.4f', p, mu, s, quantile );

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

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

130127
</section>

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

0 commit comments

Comments
 (0)