Skip to content

Commit 70429b3

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #6792 Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Harsh <[email protected]>
1 parent b7ca1bd commit 70429b3

File tree

14 files changed

+123
-171
lines changed

14 files changed

+123
-171
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -141,23 +141,19 @@ y = mycdf( 0.3 );
141141
<!-- eslint no-undef: "error" -->
142142

143143
```javascript
144-
var randu = require( '@stdlib/random/base/randu' );
144+
var uniform = require( '@stdlib/random/array/uniform' );
145+
var logEachMap = require( '@stdlib/console/log-each-map' );
145146
var EPS = require( '@stdlib/constants/float64/eps' );
146147
var cdf = require( '@stdlib/stats/base/dists/beta/cdf' );
147148

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

163159
</section>

lib/node_modules/@stdlib/stats/base/dists/beta/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 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/beta/entropy/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = entropy( 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 entropy = require( '@stdlib/stats/base/dists/beta/entropy' );
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 = entropy( alpha, beta );
139-
console.log( 'α: %d, β: %d, h(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'α: %0.4f, β: %0.4f, h(X;α,β): %0.4f', alpha, beta, entropy );
141138
```
142139

143140
</section>

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

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

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,18 @@ v = kurtosis( 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 kurtosis = require( '@stdlib/stats/base/dists/beta/kurtosis' );
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 = kurtosis( alpha, beta );
139-
console.log( 'α: %d, β: %d, Kurt(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
140-
}
137+
logEachMap( 'α: %0.4f, β: %0.4f, Kurt(X;α,β): %0.4f', alpha, beta, kurtosis );
141138
```
142139

143140
</section>

lib/node_modules/@stdlib/stats/base/dists/beta/kurtosis/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 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, 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 = 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/beta/logcdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -151,23 +151,19 @@ y = mylogcdf( 0.3 );
151151
<!-- eslint no-undef: "error" -->
152152

153153
```javascript
154-
var randu = require( '@stdlib/random/base/randu' );
154+
var uniform = require( '@stdlib/random/array/uniform' );
155+
var logEachMap = require( '@stdlib/console/log-each-map' );
155156
var EPS = require( '@stdlib/constants/float64/eps' );
156157
var logcdf = require( '@stdlib/stats/base/dists/beta/logcdf' );
157158

158-
var alpha;
159-
var beta;
160-
var x;
161-
var y;
162-
var i;
163-
164-
for ( i = 0; i < 10; i++ ) {
165-
x = randu();
166-
alpha = ( randu()*5.0 ) + EPS;
167-
beta = ( randu()*5.0 ) + EPS;
168-
y = logcdf( x, alpha, beta );
169-
console.log( 'x: %d, α: %d, β: %d, ln(F(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
170-
}
159+
var opts = {
160+
'dtype': 'float64'
161+
};
162+
var alpha = uniform( 10, EPS, 10.0, opts );
163+
var beta = uniform( 10, EPS, 10.0, opts );
164+
var x = uniform( 10, 0.0, 1.0, opts );
165+
166+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(F(x;α,β)): %0.4f', x, alpha, beta, logcdf );
171167
```
172168

173169
</section>

lib/node_modules/@stdlib/stats/base/dists/beta/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 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, 10.0, opts );
30+
var beta = uniform( 10, EPS, 10.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/beta/logpdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -146,23 +146,19 @@ y = mylogPDF( 0.3 );
146146
<!-- eslint no-undef: "error" -->
147147

148148
```javascript
149-
var randu = require( '@stdlib/random/base/randu' );
149+
var uniform = require( '@stdlib/random/array/uniform' );
150+
var logEachMap = require( '@stdlib/console/log-each-map' );
150151
var EPS = require( '@stdlib/constants/float64/eps' );
151152
var logpdf = require( '@stdlib/stats/base/dists/beta/logpdf' );
152153

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

168164
</section>

lib/node_modules/@stdlib/stats/base/dists/beta/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 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 );

0 commit comments

Comments
 (0)