Skip to content

Commit ee22a7f

Browse files
authored
docs: replace manual for loop in examples
PR-URL: #9057 Reviewed-by: Athan Reines <[email protected]>
1 parent 580e56b commit ee22a7f

File tree

26 files changed

+224
-312
lines changed

26 files changed

+224
-312
lines changed

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -131,22 +131,18 @@ y = mycdf( 2.5 );
131131
<!-- eslint no-undef: "error" -->
132132

133133
```javascript
134-
var randu = require( '@stdlib/random/base/randu' );
134+
var uniform = require( '@stdlib/random/array/uniform' );
135+
var logEachMap = require( '@stdlib/console/log-each-map' );
135136
var cdf = require( '@stdlib/stats/base/dists/pareto-type1/cdf' );
136137

137-
var alpha;
138-
var beta;
139-
var x;
140-
var y;
141-
var i;
142-
143-
for ( i = 0; i < 10; i++ ) {
144-
x = randu() * 8.0;
145-
alpha = randu() * 5.0;
146-
beta = randu() * 5.0;
147-
y = cdf( x, alpha, beta );
148-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
149-
}
138+
var opts = {
139+
'dtype': 'float64'
140+
};
141+
var alpha = uniform( 10, 0.0, 5.0, opts );
142+
var beta = uniform( 10, 0.0, 5.0, opts );
143+
var x = uniform( 10, 0.0, 8.0, opts );
144+
145+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
150146
```
151147

152148
</section>

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/examples/index.js

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

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var alpha = uniform( 10, 0.0, 5.0, opts );
29+
var beta = uniform( 10, 0.0, 5.0, opts );
30+
var x = uniform( 10, 0.0, 8.0, opts );
2931

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

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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' );
127127
var EPS = require( '@stdlib/constants/float64/eps' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var entropy = require( '@stdlib/stats/base/dists/pareto-type1/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/pareto-type1/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 uniform = require( '@stdlib/random/base/uniform' );
21+
var uniform = require( '@stdlib/random/array/uniform' );
2222
var EPS = require( '@stdlib/constants/float64/eps' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
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 = uniform( EPS, 10.0 );
32-
beta = uniform( EPS, 10.0 );
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/pareto-type1/kurtosis/README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -129,21 +129,18 @@ v = kurtosis( 1.0, -1.0 );
129129
<!-- eslint no-undef: "error" -->
130130

131131
```javascript
132-
var randu = require( '@stdlib/random/base/randu' );
132+
var uniform = require( '@stdlib/random/array/uniform' );
133133
var EPS = require( '@stdlib/constants/float64/eps' );
134+
var logEachMap = require( '@stdlib/console/log-each-map' );
134135
var kurtosis = require( '@stdlib/stats/base/dists/pareto-type1/kurtosis' );
135136

136-
var alpha;
137-
var beta;
138-
var v;
139-
var i;
137+
var opts = {
138+
'dtype': 'float64'
139+
};
140+
var alpha = uniform( 10, EPS + 4.0, 10.0, opts );
141+
var beta = uniform( 10, EPS, 10.0, opts );
140142

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

149146
</section>

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/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' );
2222
var EPS = require( '@stdlib/constants/float64/eps' );
23+
var logEachMap = require( '@stdlib/console/log-each-map' );
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 + 4.0, 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 ) + 4.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/pareto-type1/logcdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -141,22 +141,18 @@ y = mylogcdf( 2.5 );
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 logcdf = require( '@stdlib/stats/base/dists/pareto-type1/logcdf' );
146147

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

162158
</section>

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/examples/index.js

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

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var alpha = uniform( 10, 0.0, 5.0, opts );
29+
var beta = uniform( 10, 0.0, 5.0, opts );
30+
var x = uniform( 10, 0.0, 8.0, opts );
2931

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

lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logpdf/README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -144,22 +144,18 @@ y = mylogpdf( 2.0 );
144144
<!-- eslint no-undef: "error" -->
145145

146146
```javascript
147-
var randu = require( '@stdlib/random/base/randu' );
147+
var uniform = require( '@stdlib/random/array/uniform' );
148+
var logEachMap = require( '@stdlib/console/log-each-map' );
148149
var logpdf = require( '@stdlib/stats/base/dists/pareto-type1/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() * 8.0;
158-
alpha = randu() * 4.0;
159-
beta = randu() * 4.0;
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, 0.0, 4.0, opts );
155+
var beta = uniform( 10, 0.0, 4.0, opts );
156+
var x = uniform( 10, 0.0, 8.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/pareto-type1/logpdf/examples/index.js

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

24-
var alpha;
25-
var beta;
26-
var x;
27-
var y;
28-
var i;
25+
var opts = {
26+
'dtype': 'float64'
27+
};
28+
var alpha = uniform( 10, 0.0, 4.0, opts );
29+
var beta = uniform( 10, 0.0, 4.0, opts );
30+
var x = uniform( 10, 0.0, 8.0, opts );
2931

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

0 commit comments

Comments
 (0)