Skip to content

Commit b8343ec

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

File tree

10 files changed

+86
-120
lines changed

10 files changed

+86
-120
lines changed

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

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

127127
```javascript
128-
var randu = require( '@stdlib/random/base/randu' );
128+
var uniform = require( '@stdlib/random/array/uniform' );
129+
var logEachMap = require( '@stdlib/console/log-each-map' );
129130
var pdf = require( '@stdlib/stats/base/dists/f/pdf' );
130131

131-
var d1;
132-
var d2;
133-
var x;
134-
var y;
135-
var i;
136-
137-
for ( i = 0; i < 10; i++ ) {
138-
x = randu() * 4.0;
139-
d1 = randu() * 10.0;
140-
d2 = randu() * 10.0;
141-
y = pdf( x, d1, d2 );
142-
console.log( 'x: %d, d1: %d, d2: %d, f(x;d1,d2): %d', x.toFixed( 4 ), d1.toFixed( 4 ), d2.toFixed( 4 ), y.toFixed( 4 ) );
143-
}
132+
var opts = {
133+
'dtype': 'float64'
134+
};
135+
var x = uniform( 10, 0.0, 4.0, opts );
136+
var d1 = uniform( 10, 0.0, 10.0, opts );
137+
var d2 = uniform( 10, 0.0, 10.0, opts );
138+
139+
logEachMap( 'x: %0.4f, d1: %0.4f, d2: %0.4f, f(x;d1,d2): %0.4f', x, d1, d2, pdf );
144140
```
145141

146142
</section>

lib/node_modules/@stdlib/stats/base/dists/f/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 d1;
25-
var d2;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var x = uniform( 10, 0.0, 4.0, opts );
29+
var d1 = uniform( 10, 0.0, 10.0, opts );
30+
var d2 = uniform( 10, 0.0, 10.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 4.0;
32-
d1 = randu() * 10.0;
33-
d2 = randu() * 10.0;
34-
y = pdf( x, d1, d2 );
35-
console.log( 'x: %d, d1: %d, d2: %d, f(x;d1,d2): %d', x.toFixed( 4 ), d1.toFixed( 4 ), d2.toFixed( 4 ), y.toFixed( 4 ) );
36-
}
32+
logEachMap( 'x: %0.4f, d1: %0.4f, d2: %0.4f, f(x;d1,d2): %0.4f', x, d1, d2, pdf );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -136,22 +136,18 @@ y = myquantile( 0.8 );
136136
<!-- eslint no-undef: "error" -->
137137

138138
```javascript
139-
var randu = require( '@stdlib/random/base/randu' );
139+
var uniform = require( '@stdlib/random/array/uniform' );
140+
var logEachMap = require( '@stdlib/console/log-each-map' );
140141
var quantile = require( '@stdlib/stats/base/dists/f/quantile' );
141142

142-
var d1;
143-
var d2;
144-
var p;
145-
var y;
146-
var i;
147-
148-
for ( i = 0; i < 10; i++ ) {
149-
p = randu();
150-
d1 = randu() * 10.0;
151-
d2 = randu() * 10.0;
152-
y = quantile( p, d1, d2 );
153-
console.log( 'p: %d, d1: %d, d2: %d, Q(p;d1,d2): %d', p.toFixed( 4 ), d1.toFixed( 4 ), d2.toFixed( 4 ), y.toFixed( 4 ) );
154-
}
143+
var opts = {
144+
'dtype': 'float64'
145+
};
146+
var p = uniform( 10, 0.0, 1.0, opts );
147+
var d1 = uniform( 10, 0.0, 10.0, opts );
148+
var d2 = uniform( 10, 0.0, 10.0, opts );
149+
150+
logEachMap( 'p: %0.4f, d1: %0.4f, d2: %0.4f, Q(p;d1,d2): %0.4f', p, d1, d2, quantile );
155151
```
156152

157153
</section>

lib/node_modules/@stdlib/stats/base/dists/f/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 d1;
25-
var d2;
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 d1 = uniform( 10, 0.0, 10.0, opts );
30+
var d2 = uniform( 10, 0.0, 10.0, opts );
2931

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -126,21 +126,18 @@ v = skewness( 3.0, -1.0 );
126126
<!-- eslint no-undef: "error" -->
127127

128128
```javascript
129-
var randu = require( '@stdlib/random/base/randu' );
129+
var uniform = require( '@stdlib/random/array/uniform' );
130+
var logEachMap = require( '@stdlib/console/log-each-map' );
130131
var EPS = require( '@stdlib/constants/float64/eps' );
131132
var skewness = require( '@stdlib/stats/base/dists/f/skewness' );
132133

133-
var d1;
134-
var d2;
135-
var v;
136-
var i;
134+
var opts = {
135+
'dtype': 'float64'
136+
};
137+
var d1 = uniform( 10, EPS, 10.0, opts );
138+
var d2 = uniform( 10, EPS, 20.0, opts );
137139

138-
for ( i = 0; i < 10; i++ ) {
139-
d1 = ( randu()*10.0 ) + EPS;
140-
d2 = ( randu()*20.0 ) + EPS;
141-
v = skewness( d1, d2 );
142-
console.log( 'd1: %d, d2: %d, skew(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
143-
}
140+
logEachMap( 'd1: %0.4f, d2: %0.4f, skew(X;d1,d2): %0.4f', d1, d2, skewness );
144141
```
145142

146143
</section>

lib/node_modules/@stdlib/stats/base/dists/f/skewness/examples/index.js

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var skewness = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 20.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
d1 = ( randu()*10.0 ) + EPS;
32-
d2 = ( randu()*20.0 ) + EPS;
33-
v = skewness( d1, d2 );
34-
console.log( 'd1: %d, d2: %d, skew(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'd1: %0.4f, d2: %0.4f, skew(X;d1,d2): %0.4f', d1, d2, skewness );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = stdev( 3.0, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var EPS = require( '@stdlib/constants/float64/eps' );
128129
var stdev = require( '@stdlib/stats/base/dists/f/stdev' );
129130

130-
var d1;
131-
var d2;
132-
var v;
133-
var i;
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var d1 = uniform( 10, EPS, 10.0, opts );
135+
var d2 = uniform( 10, EPS, 20.0, opts );
134136

135-
for ( i = 0; i < 10; i++ ) {
136-
d1 = ( randu()*10.0 ) + EPS;
137-
d2 = ( randu()*20.0 ) + EPS;
138-
v = stdev( d1, d2 );
139-
console.log( 'd1: %d, d2: %d, SD(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'd1: %0.4f, d2: %0.4f, SD(X;d1,d2): %0.4f', d1, d2, stdev );
141138
```
142139

143140
</section>

lib/node_modules/@stdlib/stats/base/dists/f/stdev/examples/index.js

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var stdev = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 20.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
d1 = ( randu()*10.0 ) + EPS;
32-
d2 = ( randu()*20.0 ) + EPS;
33-
v = stdev( d1, d2 );
34-
console.log( 'd1: %d, d2: %d, SD(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'd1: %0.4f, d2: %0.4f, SD(X;d1,d2): %0.4f', d1, d2, stdev );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = variance( 3.0, -1.0 );
123123
<!-- eslint no-undef: "error" -->
124124

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
126+
var uniform = require( '@stdlib/random/array/uniform' );
127+
var logEachMap = require( '@stdlib/console/log-each-map' );
127128
var EPS = require( '@stdlib/constants/float64/eps' );
128129
var variance = require( '@stdlib/stats/base/dists/f/variance' );
129130

130-
var d1;
131-
var d2;
132-
var v;
133-
var i;
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var d1 = uniform( 10, EPS, 10.0, opts );
135+
var d2 = uniform( 10, EPS, 20.0, opts );
134136

135-
for ( i = 0; i < 10; i++ ) {
136-
d1 = ( randu()*10.0 ) + EPS;
137-
d2 = ( randu()*20.0 ) + EPS;
138-
v = variance( d1, d2 );
139-
console.log( 'd1: %d, d2: %d, Var(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'd1: %0.4f, d2: %0.4f, Var(X;d1,d2): %0.4f', d1, d2, variance );
141138
```
142139

143140
</section>

lib/node_modules/@stdlib/stats/base/dists/f/variance/examples/index.js

Lines changed: 8 additions & 11 deletions
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' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
22+
var logEachMap = require( '@stdlib/console/log-each-map' );
2223
var EPS = require( '@stdlib/constants/float64/eps' );
2324
var variance = require( './../lib' );
2425

25-
var d1;
26-
var d2;
27-
var v;
28-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var d1 = uniform( 10, EPS, 10.0, opts );
30+
var d2 = uniform( 10, EPS, 20.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
d1 = ( randu()*10.0 ) + EPS;
32-
d2 = ( randu()*20.0 ) + EPS;
33-
v = variance( d1, d2 );
34-
console.log( 'd1: %d, d2: %d, Var(X;d1,d2): %d', d1.toFixed( 4 ), d2.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'd1: %0.4f, d2: %0.4f, Var(X;d1,d2): %0.4f', d1, d2, variance );

0 commit comments

Comments
 (0)