Skip to content

Commit 828cfd5

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

File tree

10 files changed

+77
-104
lines changed

10 files changed

+77
-104
lines changed

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

+10-13
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ f(x;\,k) = \frac{2^{{1-k/2}}x^{{k-1}}e^{{-x^{2}/2}}}{\Gamma(k/2)}
3939

4040
<!-- </equation> -->
4141

42-
where `k` is the degrees of freedom and `Γ` denotes the [gamma][gamma-function] function.
42+
where `k` is the degrees of freedom and `Γ` denotes the [gamma][gamma-function] function.
4343

4444
</section>
4545

@@ -120,20 +120,17 @@ y = myPDF( 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 pdf = require( '@stdlib/stats/base/dists/chi/pdf' );
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 = pdf( x, k );
135-
console.log( 'x: %d, k: %d, 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, f(x;k): %0.4f', x, k, pdf );
137134
```
138135

139136
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/pdf/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 pdf = 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 = pdf( x, k );
33-
console.log( 'x: %d, k: %d, f(x;k): %d', x.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
34-
}
31+
logEachMap( 'x: %0.4f, k: %0.4f, f(x;k): %0.4f', x, k, pdf );

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

+9-12
Original file line numberDiff line numberDiff line change
@@ -130,20 +130,17 @@ y = myquantile( 1.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 quantile = require( '@stdlib/stats/base/dists/chi/quantile' );
135136

136-
var k;
137-
var p;
138-
var y;
139-
var i;
140-
141-
for ( i = 0; i < 20; i++ ) {
142-
p = randu();
143-
k = randu() * 10.0;
144-
y = quantile( p, k );
145-
console.log( 'p: %d, k: %d, Q(p;k): %d', p.toFixed( 4 ), k.toFixed( 4 ), y.toFixed( 4 ) );
146-
}
137+
var opts = {
138+
'dtype': 'float64'
139+
};
140+
var p = uniform( 20, 0.0, 1.0, opts );
141+
var k = uniform( 20, 0.0, 10.0, opts );
142+
143+
logEachMap( 'p: %0.4f, k: %0.4f, Q(p;k): %0.4f', p, k, quantile );
147144
```
148145

149146
</section>

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

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

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

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = skewness( -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 skewness = require( '@stdlib/stats/base/dists/chi/skewness' );
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 = skewness( k );
111-
console.log( 'k: %d, skew(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, skew(X;k): %0.4f', k, skewness );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/skewness/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 skewness = 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 = skewness( k );
31-
console.log( 'k: %d, skew(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, skew(X;k): %0.4f', k, skewness );

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = stdev( -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 stdev = require( '@stdlib/stats/base/dists/chi/stdev' );
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 = stdev( k );
111-
console.log( 'k: %d, SD(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, SD(X;k): %0.4f', k, stdev );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/stdev/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 stdev = 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 = stdev( k );
31-
console.log( 'k: %d, SD(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, SD(X;k): %0.4f', k, stdev );

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

+7-10
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,16 @@ var v = variance( -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 variance = require( '@stdlib/stats/base/dists/chi/variance' );
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 = variance( k );
111-
console.log( 'k: %d, Var(X,k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
112-
}
109+
logEachMap( 'k: %0.4f, Var(X;k): %0.4f', k, variance );
113110
```
114111

115112
</section>

‎lib/node_modules/@stdlib/stats/base/dists/chi/variance/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 variance = 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 = variance( k );
31-
console.log( 'k: %d, Var(X;k): %d', k.toFixed( 4 ), v.toFixed( 4 ) );
32-
}
30+
logEachMap( 'k: %0.4f, Var(X;k): %0.4f', k, variance );

0 commit comments

Comments
 (0)