Skip to content

Commit ca3d958

Browse files
hrshyaPlaneshifter
andauthored
docs: replace manual for loop in examples
PR-URL: #6919 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 28f64ec commit ca3d958

File tree

8 files changed

+70
-98
lines changed

8 files changed

+70
-98
lines changed

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,18 @@ v = median( 1.0, 0.0 );
108108
<!-- eslint no-undef: "error" -->
109109

110110
```javascript
111-
var randu = require( '@stdlib/random/base/randu' );
111+
var uniform = require( '@stdlib/random/array/uniform' );
112+
var logEachMap = require( '@stdlib/console/log-each-map' );
112113
var EPS = require( '@stdlib/constants/float64/eps' );
113114
var median = require( '@stdlib/stats/base/dists/cauchy/median' );
114115

115-
var gamma;
116-
var x0;
117-
var v;
118-
var i;
116+
var opts = {
117+
'dtype': 'float64'
118+
};
119+
var gamma = uniform( 10, EPS, 10.0, opts );
120+
var x0 = uniform( 10, 0.0, 100.0, opts );
119121

120-
for ( i = 0; i < 10; i++ ) {
121-
x0 = randu() * 100.0;
122-
gamma = ( randu()*10.0 ) + EPS;
123-
v = median( x0, gamma );
124-
console.log( 'x0: %d, γ: %d, Median(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
125-
}
122+
logEachMap( 'x0: %0.4f, γ: %0.4f, Median(X;x0,γ): %0.4f', x0, gamma, median );
126123
```
127124

128125
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/median/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 median = require( './../lib' );
2425

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

30-
for ( i = 0; i < 10; i++ ) {
31-
x0 = randu() * 100.0;
32-
gamma = ( randu()*10.0 ) + EPS;
33-
v = median( x0, gamma );
34-
console.log( 'x0: %d, γ: %d, Median(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'x0: %0.4f, γ: %0.4f, Median(X;x0,γ): %0.4f', x0, gamma, median );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,18 @@ v = mode( 1.0, 0.0 );
108108
<!-- eslint no-undef: "error" -->
109109

110110
```javascript
111-
var randu = require( '@stdlib/random/base/randu' );
111+
var uniform = require( '@stdlib/random/array/uniform' );
112+
var logEachMap = require( '@stdlib/console/log-each-map' );
112113
var EPS = require( '@stdlib/constants/float64/eps' );
113114
var mode = require( '@stdlib/stats/base/dists/cauchy/mode' );
114115

115-
var gamma;
116-
var x0;
117-
var v;
118-
var i;
116+
var opts = {
117+
'dtype': 'float64'
118+
};
119+
var gamma = uniform( 10, EPS, 10.0, opts );
120+
var x0 = uniform( 10, 0.0, 100.0, opts );
119121

120-
for ( i = 0; i < 10; i++ ) {
121-
x0 = randu() * 100.0;
122-
gamma = ( randu()*10.0 ) + EPS;
123-
v = mode( x0, gamma );
124-
console.log( 'x0: %d, γ: %d, mode(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
125-
}
122+
logEachMap( 'x0: %0.4f, γ: %0.4f, mode(X;x0,γ): %0.4f', x0, gamma, mode );
126123
```
127124

128125
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/mode/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 mode = require( './../lib' );
2425

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

30-
for ( i = 0; i < 10; i++ ) {
31-
x0 = randu() * 100.0;
32-
gamma = ( randu()*10.0 ) + EPS;
33-
v = mode( x0, gamma );
34-
console.log( 'x0: %d, γ: %d, mode(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'x0: %0.4f, γ: %0.4f, mode(X;x0,γ): %0.4f', x0, gamma, mode );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -116,23 +116,19 @@ y = mypdf( 5.0 );
116116
<!-- eslint no-undef: "error" -->
117117

118118
```javascript
119-
var randu = require( '@stdlib/random/base/randu' );
119+
var uniform = require( '@stdlib/random/array/uniform' );
120+
var logEachMap = require( '@stdlib/console/log-each-map' );
120121
var EPS = require( '@stdlib/constants/float64/eps' );
121122
var pdf = require( '@stdlib/stats/base/dists/cauchy/pdf' );
122123

123-
var gamma;
124-
var x0;
125-
var x;
126-
var y;
127-
var i;
128-
129-
for ( i = 0; i < 10; i++ ) {
130-
x = randu() * 10.0;
131-
x0 = ( randu()*10.0 ) - 5.0;
132-
gamma = ( randu()*20.0 ) + EPS;
133-
y = pdf( x, gamma, x0 );
134-
console.log( 'x: %d, x0: %d, γ: %d, f(x;x0,γ): %d', x.toFixed(4), x0.toFixed(4), gamma.toFixed(4), y.toFixed(4) );
135-
}
124+
var opts = {
125+
'dtype': 'float64'
126+
};
127+
var gamma = uniform( 10, EPS, 20.0, opts );
128+
var x0 = uniform( 10, -5.0, 5.0, opts );
129+
var x = uniform( 10, 0.0, 10.0, opts );
130+
131+
logEachMap( 'x: %0.4f, x0: %0.4f, γ: %0.4f, f(x;x0,γ): %0.4f', x, x0, gamma, pdf );
136132
```
137133

138134
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/pdf/examples/index.js

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
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 pdf = require( './../lib' );
2425

25-
var gamma;
26-
var x0;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var gamma = uniform( 10, EPS, 20.0, opts );
30+
var x0 = uniform( 10, -5.0, 5.0, opts );
31+
var x = uniform( 10, 0.0, 10.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = randu() * 10.0;
33-
x0 = ( randu()*10.0 ) - 5.0;
34-
gamma = ( randu()*20.0 ) + EPS;
35-
y = pdf( x, gamma, x0 );
36-
console.log( 'x: %d, x0: %d, γ: %d, f(x;x0,γ): %d', x.toFixed(4), x0.toFixed(4), gamma.toFixed(4), y.toFixed(4) );
37-
}
33+
logEachMap( 'x: %0.4f, x0: %0.4f, γ: %0.4f, f(x;x0,γ): %0.4f', x, x0, gamma, pdf );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -126,23 +126,19 @@ y = myquantile( 0.8 );
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 quantile = require( '@stdlib/stats/base/dists/cauchy/quantile' );
132133

133-
var gamma;
134-
var x0;
135-
var p;
136-
var y;
137-
var i;
138-
139-
for ( i = 0; i < 10; i++ ) {
140-
p = randu();
141-
x0 = ( randu()*10.0 ) - 5.0;
142-
gamma = ( randu()*20.0 ) + EPS;
143-
y = quantile( p, gamma, x0 );
144-
console.log( 'p: %d, x0: %d, γ: %d, Q(p;x0,γ): %d', p.toFixed(4), x0.toFixed(4), gamma.toFixed(4), y.toFixed(4) );
145-
}
134+
var opts = {
135+
'dtype': 'float64'
136+
};
137+
var gamma = uniform( 10, EPS, 20.0, opts );
138+
var x0 = uniform( 10, -5.0, 5.0, opts );
139+
var p = uniform( 10, 0.0, 1.0, opts );
140+
141+
logEachMap( 'p: %0.4f, x0: %0.4f γ: %0.4f, Q(p;x0,γ): %0.4f', p, x0, gamma, quantile );
146142
```
147143

148144
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/quantile/examples/index.js

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,16 @@
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 quantile = require( './../lib' );
2425

25-
var gamma;
26-
var x0;
27-
var p;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var gamma = uniform( 10, EPS, 20.0, opts );
30+
var x0 = uniform( 10, -5.0, 5.0, opts );
31+
var p = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
p = randu();
33-
x0 = ( randu()*10.0 ) - 5.0;
34-
gamma = ( randu()*20.0 ) + EPS;
35-
y = quantile( p, gamma, x0 );
36-
console.log( 'p: %d, x0: %d, γ: %d, Q(p;x0,γ): %d', p.toFixed(4), x0.toFixed(4), gamma.toFixed(4), y.toFixed(4) );
37-
}
33+
logEachMap( 'p: %0.4f, x0: %0.4f, γ: %0.4f, Q(p;x0,γ): %0.4f', p, x0, gamma, quantile );

0 commit comments

Comments
 (0)