Skip to content

Commit 7788818

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: #6921 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Harsh <[email protected]>
1 parent 828cfd5 commit 7788818

File tree

12 files changed

+93
-125
lines changed

12 files changed

+93
-125
lines changed

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

+10-13
Original file line numberDiff line numberDiff line change
@@ -132,21 +132,18 @@ y = mycdf( 1.5 );
132132
<!-- eslint no-undef: "error" -->
133133

134134
```javascript
135-
var randu = require( '@stdlib/random/base/randu' );
136-
var round = require( '@stdlib/math/base/special/round' );
135+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
136+
var uniform = require( '@stdlib/random/array/uniform' );
137+
var logEachMap = require( '@stdlib/console/log-each-map' );
137138
var cdf = require( '@stdlib/stats/base/dists/chi/cdf' );
138139

139-
var k;
140-
var x;
141-
var y;
142-
var i;
143-
144-
for ( i = 0; i < 20; i++ ) {
145-
x = randu() * 10.0;
146-
k = round( randu()*5.0 );
147-
y = cdf( x, k );
148-
console.log( 'x: %d, k: %d, F(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
149-
}
140+
var opts = {
141+
'dtype': 'float64'
142+
};
143+
var x = uniform( 20, 0.0, 10.0, opts );
144+
var k = discreteUniform( 20, 0, 10, opts );
145+
146+
logEachMap( 'x: %0.4f, k: %0.4f, F(x;k): %0.4f', x, k, cdf );
150147
```
151148

152149
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/cdf/examples/index.js

+9-12
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,15 @@
1818

1919
'use strict';
2020

21-
var randu = require( '@stdlib/random/base/randu' );
22-
var round = require( '@stdlib/math/base/special/round' );
21+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
22+
var uniform = require( '@stdlib/random/array/uniform' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
2324
var cdf = require( './../lib' );
2425

25-
var k;
26-
var x;
27-
var y;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var x = uniform( 20, 0.0, 10.0, opts );
30+
var k = discreteUniform( 20, 0, 10, opts );
2931

30-
for ( i = 0; i < 20; i++ ) {
31-
x = randu() * 10.0;
32-
k = round( randu() * 10.0 );
33-
y = cdf( x, k );
34-
console.log( 'x: %d, k: %d, F(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
35-
}
32+
logEachMap( 'x: %0.4f, k: %0.4f, F(x;k): %0.4f', x, k, cdf );

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = entropy( -1.0 );
9797
<!-- eslint no-undef: "error" -->
9898

9999
```javascript
100-
var randu = require( '@stdlib/random/base/randu' );
101-
var round = require( '@stdlib/math/base/special/round' );
100+
var uniform = require( '@stdlib/random/array/uniform' );
101+
var logEachMap = require( '@stdlib/console/log-each-map' );
102102
var entropy = require( '@stdlib/stats/base/dists/chi/entropy' );
103103

104-
var k;
105-
var v;
106-
var i;
104+
var opts = {
105+
'dtype': 'float64'
106+
};
107+
var k = uniform( 10, 0.0, 20.0, opts );
107108

108-
for ( i = 0; i < 10; i++ ) {
109-
k = randu() * 20.0;
110-
v = entropy( k );
111-
console.log( 'k: %d, h(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, h(X;k): %0.4f', k, entropy );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/entropy/examples/index.js

+7-9
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 i;
25-
var k;
26-
var v;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var k = uniform( 10, 0.0, 20.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
k = randu() * 20.0;
30-
v = entropy( k );
31-
console.log( 'k: %d, h(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, h(X;k): %0.4f', k, entropy );

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = kurtosis( -1.0 );
9797
<!-- eslint no-undef: "error" -->
9898

9999
```javascript
100-
var randu = require( '@stdlib/random/base/randu' );
101-
var round = require( '@stdlib/math/base/special/round' );
100+
var uniform = require( '@stdlib/random/array/uniform' );
101+
var logEachMap = require( '@stdlib/console/log-each-map' );
102102
var kurtosis = require( '@stdlib/stats/base/dists/chi/kurtosis' );
103103

104-
var k;
105-
var v;
106-
var i;
104+
var opts = {
105+
'dtype': 'float64'
106+
};
107+
var k = uniform( 10, 0.0, 20.0, opts );
107108

108-
for ( i = 0; i < 10; i++ ) {
109-
k = randu() * 20.0;
110-
v = kurtosis( k );
111-
console.log( 'k: %d, Kurt(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, Kurt(X;k): %0.4f', k, kurtosis );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/kurtosis/examples/index.js

+7-9
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 i;
25-
var k;
26-
var v;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var k = uniform( 10, 0.0, 20.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
k = randu() * 20.0;
30-
v = kurtosis( k );
31-
console.log( 'k: %d, Kurt(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, Kurt(X;k): %0.4f', k, kurtosis );

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

+9-12
Original file line numberDiff line numberDiff line change
@@ -120,20 +120,17 @@ y = mylogPDF( 1.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/chi/logpdf' );
125126

126-
var k;
127-
var x;
128-
var y;
129-
var i;
130-
131-
for ( i = 0; i < 20; i++ ) {
132-
x = randu() * 10.0;
133-
k = randu() * 10.0;
134-
y = logpdf( x, k );
135-
console.log( 'x: %d, k: %d, ln(f(x;k)): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
136-
}
127+
var opts = {
128+
'dtype': 'float64'
129+
};
130+
var x = uniform( 20, 0.0, 10.0, opts );
131+
var k = uniform( 20, 0.0, 10.0, opts );
132+
133+
logEachMap( 'x: %0.4f, k: %0.4f, ln(f(x;k)): %0.4f', x, k, logpdf );
137134
```
138135

139136
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/logpdf/examples/index.js

+8-11
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 logpdf = require( './../lib' );
2324

24-
var k;
25-
var x;
26-
var y;
27-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 20, 0.0, 10.0, opts );
29+
var k = uniform( 20, 0.0, 10.0, opts );
2830

29-
for ( i = 0; i < 20; i++ ) {
30-
x = randu() * 10.0;
31-
k = randu() * 10.0;
32-
y = logpdf( x, k );
33-
console.log( 'x: %d, k: %d, ln(f(x;k)): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'x: %0.4f, k: %0.4f, ln(f(x;k)): %0.4f', x, k, logpdf );

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = mean( -1.0 );
9797
<!-- eslint no-undef: "error" -->
9898

9999
```javascript
100-
var randu = require( '@stdlib/random/base/randu' );
101-
var round = require( '@stdlib/math/base/special/round' );
100+
var uniform = require( '@stdlib/random/array/uniform' );
101+
var logEachMap = require( '@stdlib/console/log-each-map' );
102102
var mean = require( '@stdlib/stats/base/dists/chi/mean' );
103103

104-
var k;
105-
var v;
106-
var i;
104+
var opts = {
105+
'dtype': 'float64'
106+
};
107+
var k = uniform( 10, 0.0, 20.0, opts );
107108

108-
for ( i = 0; i < 10; i++ ) {
109-
k = randu() * 20.0;
110-
v = mean( k );
111-
console.log( 'k: %d, E(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, E(X;k): %0.4f', k, mean );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/mean/examples/index.js

+7-9
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 i;
25-
var k;
26-
var v;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var k = uniform( 10, 0.0, 20.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
k = randu() * 20.0;
30-
v = mean( k );
31-
console.log( 'k: %d, E(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, E(X;k): %0.4f', k, mean );

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -100,19 +100,16 @@ v = mode( 0.9 );
100100
<!-- eslint no-undef: "error" -->
101101

102102
```javascript
103-
var randu = require( '@stdlib/random/base/randu' );
104-
var round = require( '@stdlib/math/base/special/round' );
103+
var uniform = require( '@stdlib/random/array/uniform' );
104+
var logEachMap = require( '@stdlib/console/log-each-map' );
105105
var mode = require( '@stdlib/stats/base/dists/chi/mode' );
106106

107-
var k;
108-
var v;
109-
var i;
107+
var opts = {
108+
'dtype': 'float64'
109+
};
110+
var k = uniform( 10, 0.0, 20.0, opts );
110111

111-
for ( i = 0; i < 10; i++ ) {
112-
k = randu() * 20.0;
113-
v = mode( k );
114-
console.log( 'k: %d, mode(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
115-
}
112+
logEachMap( 'k: %0.4f, mode(X;k): %0.4f', k, mode );
116113
```
117114

118115
</section>
@@ -194,7 +191,7 @@ int main( void ) {
194191
double k;
195192
double y;
196193
int i;
197-
194+
198195
for ( i = 0; i < 25; i++ ) {
199196
k = random_uniform( 0.0, 20.0 );
200197
y = stdlib_base_dists_chi_mode( k );

‎lib/node_modules/@stdlib/stats/base/dists/chi/mode/examples/index.js

+7-9
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,13 @@
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 i;
25-
var k;
26-
var v;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var k = uniform( 10, 0.0, 20.0, opts );
2729

28-
for ( i = 0; i < 10; i++ ) {
29-
k = randu() * 20.0;
30-
v = mode( k );
31-
console.log( 'k: %d, mode(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, mode(X;k): %0.4f', k, mode );

0 commit comments

Comments
 (0)