Skip to content

Commit 28f64ec

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

File tree

8 files changed

+73
-103
lines changed

8 files changed

+73
-103
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -116,23 +116,19 @@ y = mycdf( 12.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 cdf = require( '@stdlib/stats/base/dists/cauchy/cdf' );
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;
132-
gamma = ( randu()*10.0 ) + EPS;
133-
y = cdf( x, x0, gamma );
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, 10.0, opts );
128+
var x0 = uniform( 10, 0.0, 10.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, cdf );
136132
```
137133

138134
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/cdf/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 cdf = 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, 10.0, opts );
30+
var x0 = uniform( 10, 0.0, 10.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;
34-
gamma = ( randu()*10.0 ) + EPS;
35-
y = cdf( x, x0, gamma );
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, cdf );

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,18 @@ v = entropy( 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 entropy = require( '@stdlib/stats/base/dists/cauchy/entropy' );
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 = entropy( x0, gamma );
124-
console.log( 'x0: %d, γ: %d, h(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
125-
}
122+
logEachMap( 'x0: %0.4f, γ: %0.4f, h(X;x0,γ): %0.4f', x0, gamma, entropy );
126123
```
127124

128125
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/entropy/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 entropy = 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 = entropy( x0, gamma );
34-
console.log( 'x0: %d, γ: %d, h(X;x0,γ): %d', x0.toFixed( 4 ), gamma.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'x0: %0.4f, γ: %0.4f, h(X;x0,γ): %0.4f', x0, gamma, entropy );

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

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

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

148144
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/logcdf/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 logcdf = 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, 10.0, opts );
30+
var x0 = uniform( 10, 0.0, 10.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;
34-
gamma = ( randu()*10.0 ) + EPS;
35-
y = logcdf( x, x0, gamma );
36-
console.log( 'x: %d, x0: %d, γ: %d, ln(F(x;x0,γ)): %d', x, x0, gamma, y );
37-
}
33+
logEachMap( 'x: %0.4f, x0: %0.4f, γ: %0.4f, ln(F(x;x0,γ)): %0.4f', x, x0, gamma, logcdf );

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -123,23 +123,19 @@ y = mylogpdf( 5.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 logpdf = require( '@stdlib/stats/base/dists/cauchy/logpdf' );
129130

130-
var gamma;
131-
var x0;
132-
var x;
133-
var y;
134-
var i;
135-
136-
for ( i = 0; i < 10; i++ ) {
137-
x = randu() * 10.0;
138-
x0 = ( randu()*10.0 ) - 5.0;
139-
gamma = ( randu()*20.0 ) + EPS;
140-
y = logpdf( x, gamma, x0 );
141-
console.log( 'x: %d, x0: %d, γ: %d, ln(f(x;x0,γ)): %d', x.toFixed(4), x0.toFixed(4), gamma.toFixed(4), y.toFixed(4) );
142-
}
131+
var opts = {
132+
'dtype': 'float64'
133+
};
134+
var gamma = uniform( 10, EPS, 20.0, opts );
135+
var x0 = uniform( 10, -5.0, 5.0, opts );
136+
var x = uniform( 10, 0.0, 10.0, opts );
137+
138+
logEachMap( 'x: %0.4f, x0: %0.4f, γ: %0.4f, ln(f(x;x0,γ)): %0.4f', x, x0, gamma, logpdf );
143139
```
144140

145141
</section>

lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/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 logpdf = 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 = logpdf( x, x0, gamma );
36-
console.log( 'x: %d, x0: %d, γ: %d, ln(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, ln(f(x;x0,γ)): %0.4f', x, x0, gamma, logpdf );

0 commit comments

Comments
 (0)