Skip to content

Commit b2aa3f7

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #6830 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 816f519 commit b2aa3f7

File tree

10 files changed

+89
-125
lines changed

10 files changed

+89
-125
lines changed

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

+10-14
Original file line numberDiff line numberDiff line change
@@ -135,23 +135,19 @@ y = mycdf( 0.3 );
135135
<!-- eslint no-undef: "error" -->
136136

137137
```javascript
138-
var randu = require( '@stdlib/random/base/randu' );
138+
var uniform = require( '@stdlib/random/array/uniform' );
139+
var logEachMap = require( '@stdlib/console/log-each-map' );
139140
var EPS = require( '@stdlib/constants/float64/eps' );
140141
var cdf = require( '@stdlib/stats/base/dists/betaprime/cdf' );
141142

142-
var alpha;
143-
var beta;
144-
var x;
145-
var y;
146-
var i;
147-
148-
for ( i = 0; i < 10; i++ ) {
149-
x = randu();
150-
alpha = ( randu()*5.0 ) + EPS;
151-
beta = ( randu()*5.0 ) + EPS;
152-
y = cdf( x, alpha, beta );
153-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
154-
}
143+
var opts = {
144+
'dtype': 'float64'
145+
};
146+
var alpha = uniform( 10, EPS, 5.0, opts );
147+
var beta = uniform( 10, EPS, 5.0, opts );
148+
var x = uniform( 10, 0.0, 1.0, opts );
149+
150+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
155151
```
156152

157153
</section>

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

+9-13
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 alpha;
26-
var beta;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var alpha = uniform( 10, EPS, 5.0, opts );
30+
var beta = uniform( 10, EPS, 5.0, opts );
31+
var x = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = randu();
33-
alpha = ( randu()*5.0 ) + EPS;
34-
beta = ( randu()*5.0 ) + EPS;
35-
y = cdf( x, alpha, beta );
36-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -126,21 +126,18 @@ v = kurtosis( 1.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 kurtosis = require( '@stdlib/stats/base/dists/betaprime/kurtosis' );
132133

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

138-
for ( i = 0; i < 10; i++ ) {
139-
alpha = ( randu()*10.0 ) + EPS;
140-
beta = ( randu()*10.0 ) + 4.0 + EPS;
141-
v = kurtosis( alpha, beta );
142-
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
143-
}
140+
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );
144141
```
145142

146143
</section>

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

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

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

30-
for ( i = 0; i < 10; i++ ) {
31-
alpha = ( randu()*10.0 ) + EPS;
32-
beta = ( randu()*10.0 ) + 4.0 + EPS;
33-
v = kurtosis( alpha, beta );
34-
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );

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

+10-14
Original file line numberDiff line numberDiff line change
@@ -145,23 +145,19 @@ y = mylogcdf( 0.3 );
145145
<!-- eslint no-undef: "error" -->
146146

147147
```javascript
148-
var randu = require( '@stdlib/random/base/randu' );
148+
var uniform = require( '@stdlib/random/array/uniform' );
149+
var logEachMap = require( '@stdlib/console/log-each-map' );
149150
var EPS = require( '@stdlib/constants/float64/eps' );
150151
var logcdf = require( '@stdlib/stats/base/dists/betaprime/logcdf' );
151152

152-
var alpha;
153-
var beta;
154-
var x;
155-
var y;
156-
var i;
157-
158-
for ( i = 0; i < 10; i++ ) {
159-
x = randu();
160-
alpha = ( randu()*5.0 ) + EPS;
161-
beta = ( randu()*5.0 ) + EPS;
162-
y = logcdf( x, alpha, beta );
163-
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
164-
}
153+
var opts = {
154+
'dtype': 'float64'
155+
};
156+
var alpha = uniform( 10, EPS, 5.0, opts );
157+
var beta = uniform( 10, EPS, 5.0, opts );
158+
var x = uniform( 10, 0.0, 1.0, opts );
159+
160+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(F(x;α,β)): %0.4f', x, alpha, beta, logcdf );
165161
```
166162

167163
</section>

lib/node_modules/@stdlib/stats/base/dists/betaprime/logcdf/examples/index.js

+9-13
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 alpha;
26-
var beta;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var alpha = uniform( 10, EPS, 5.0, opts );
30+
var beta = uniform( 10, EPS, 5.0, opts );
31+
var x = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = randu();
33-
alpha = ( randu()*5.0 ) + EPS;
34-
beta = ( randu()*5.0 ) + EPS;
35-
y = logcdf( x, alpha, beta );
36-
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(F(x;α,β)): %0.4f', x, alpha, beta, logcdf );

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

+10-14
Original file line numberDiff line numberDiff line change
@@ -143,23 +143,19 @@ y = mylogPDF( 0.3 );
143143
<!-- eslint no-undef: "error" -->
144144

145145
```javascript
146-
var randu = require( '@stdlib/random/base/randu' );
146+
var uniform = require( '@stdlib/random/array/uniform' );
147+
var logEachMap = require( '@stdlib/console/log-each-map' );
147148
var EPS = require( '@stdlib/constants/float64/eps' );
148149
var logpdf = require( '@stdlib/stats/base/dists/betaprime/logpdf' );
149150

150-
var alpha;
151-
var beta;
152-
var x;
153-
var y;
154-
var i;
155-
156-
for ( i = 0; i < 10; i++ ) {
157-
x = randu();
158-
alpha = ( randu()*5.0 ) + EPS;
159-
beta = ( randu()*5.0 ) + EPS;
160-
y = logpdf( x, alpha, beta );
161-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
162-
}
151+
var opts = {
152+
'dtype': 'float64'
153+
};
154+
var alpha = uniform( 10, EPS, 5.0, opts );
155+
var beta = uniform( 10, EPS, 5.0, opts );
156+
var x = uniform( 10, 0.0, 1.0, opts );
157+
158+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );
163159
```
164160

165161
</section>

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

+9-13
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 alpha;
26-
var beta;
27-
var x;
28-
var y;
29-
var i;
26+
var opts = {
27+
'dtype': 'float64'
28+
};
29+
var alpha = uniform( 10, EPS, 5.0, opts );
30+
var beta = uniform( 10, EPS, 5.0, opts );
31+
var x = uniform( 10, 0.0, 1.0, opts );
3032

31-
for ( i = 0; i < 10; i++ ) {
32-
x = randu();
33-
alpha = ( randu()*5.0 ) + EPS;
34-
beta = ( randu()*5.0 ) + EPS;
35-
y = logpdf( x, alpha, beta );
36-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
37-
}
33+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = mean( 1.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 mean = require( '@stdlib/stats/base/dists/betaprime/mean' );
129130

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

135-
for ( i = 0; i < 10; i++ ) {
136-
alpha = ( randu()*10.0 ) + EPS;
137-
beta = ( randu()*10.0 ) + 1.0 + EPS;
138-
v = mean( alpha, beta );
139-
console.log( 'α: %d, β: %d, E(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'α: %0.4f, β: %0.4f, E(X;α,β): %0.4f', alpha, beta, mean );
141138
```
142139

143140
</section>

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

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

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

30-
for ( i = 0; i < 10; i++ ) {
31-
alpha = ( randu()*10.0 ) + EPS;
32-
beta = ( randu()*10.0 ) + 1.0 + EPS;
33-
v = mean( alpha, beta );
34-
console.log( 'α: %d, β: %d, E(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
35-
}
32+
logEachMap( 'α: %0.4f, β: %0.4f, E(X;α,β): %0.4f', alpha, beta, mean );

0 commit comments

Comments
 (0)