Skip to content

Commit b7ca1bd

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: #6793 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 3be1d66 commit b7ca1bd

File tree

14 files changed

+121
-169
lines changed

14 files changed

+121
-169
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/beta/mgf/README.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -143,23 +143,19 @@ y = mymgf( 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 mgf = require( '@stdlib/stats/base/dists/beta/mgf' );
149150

150-
var alpha;
151-
var beta;
152-
var t;
153-
var v;
154-
var i;
155-
156-
for ( i = 0; i < 10; i++ ) {
157-
t = randu() * 20.0;
158-
alpha = ( randu()*5.0 ) + EPS;
159-
beta = ( randu()*5.0 ) + EPS;
160-
v = mgf( t, alpha, beta );
161-
console.log( 't: %d, α: %d, β: %d, M_X(t;α,β): %d', t.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), v.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 t = uniform( 10, 0.0, 20.0, opts );
157+
158+
logEachMap( 't: %0.4f, α: %0.4f, β: %0.4f, M_X(t;α,β): %0.4f', t, alpha, beta, mgf );
163159
```
164160

165161
</section>

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

25-
var alpha;
26-
var beta;
27-
var t;
28-
var v;
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 t = uniform( 10, 0.0, 20.0, opts );
3032

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

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -123,20 +123,17 @@ v = mode( 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 mode = require( '@stdlib/stats/base/dists/beta/mode' );
128129

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

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

142139
</section>

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

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

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

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

+10-14
Original file line numberDiff line numberDiff line change
@@ -136,23 +136,19 @@ y = mypdf( 0.3 );
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 EPS = require( '@stdlib/constants/float64/eps' );
141142
var pdf = require( '@stdlib/stats/base/dists/beta/pdf' );
142143

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

158154
</section>

‎lib/node_modules/@stdlib/stats/base/dists/beta/pdf/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 pdf = 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 = pdf( 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, pdf );

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

+10-14
Original file line numberDiff line numberDiff line change
@@ -133,23 +133,19 @@ y = myquantile( 0.4 );
133133
<!-- eslint no-undef: "error" -->
134134

135135
```javascript
136-
var randu = require( '@stdlib/random/base/randu' );
136+
var uniform = require( '@stdlib/random/array/uniform' );
137+
var logEachMap = require( '@stdlib/console/log-each-map' );
137138
var EPS = require( '@stdlib/constants/float64/eps' );
138139
var quantile = require( '@stdlib/stats/base/dists/beta/quantile' );
139140

140-
var alpha;
141-
var beta;
142-
var p;
143-
var y;
144-
var i;
145-
146-
for ( i = 0; i < 10; i++ ) {
147-
p = randu();
148-
alpha = ( randu()*5.0 ) + EPS;
149-
beta = ( randu()*5.0 ) + EPS;
150-
y = quantile( p, alpha, beta );
151-
console.log( 'p: %d, α: %d, β: %d, Q(p;α,β): %d', p.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
152-
}
141+
var opts = {
142+
'dtype': 'float64'
143+
};
144+
var alpha = uniform( 10, EPS, 5.0, opts );
145+
var beta = uniform( 10, EPS, 5.0, opts );
146+
var p = uniform( 10, 0.0, 1.0, opts );
147+
148+
logEachMap( 'p: %0.4f, α: %0.4f, β: %0.4f, Q(p;α,β): %0.4f', p, alpha, beta, quantile );
153149
```
154150

155151
</section>

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

25-
var alpha;
26-
var beta;
27-
var p;
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 p = uniform( 10, 0.0, 1.0, opts );
3032

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

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = skewness( 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 skewness = require( '@stdlib/stats/base/dists/beta/skewness' );
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, EPS, 10.0, opts );
134136

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

143140
</section>

‎lib/node_modules/@stdlib/stats/base/dists/beta/skewness/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 skewness = 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, EPS, 10.0, opts );
2931

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

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = stdev( 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 stdev = require( '@stdlib/stats/base/dists/beta/stdev' );
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, EPS, 10.0, opts );
134136

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

143140
</section>

‎lib/node_modules/@stdlib/stats/base/dists/beta/stdev/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 stdev = 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, EPS, 10.0, opts );
2931

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

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

+8-11
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = variance( 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 variance = require( '@stdlib/stats/base/dists/beta/variance' );
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, EPS, 10.0, opts );
134136

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

143140
</section>

0 commit comments

Comments
 (0)