Skip to content

Commit 150854b

Browse files
hrshyahrshya
authored
docs: replace manual for loop in examples
PR-URL: stdlib-js#8229 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com>
1 parent 4a599d7 commit 150854b

File tree

22 files changed

+188
-262
lines changed

22 files changed

+188
-262
lines changed

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

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -213,22 +213,18 @@ int main( void ) {
213213
<!-- eslint no-undef: "error" -->
214214

215215
```javascript
216-
var randu = require( '@stdlib/random/base/randu' );
216+
var uniform = require( '@stdlib/random/array/uniform' );
217+
var logEachMap = require( '@stdlib/console/log-each-map' );
217218
var cdf = require( '@stdlib/stats/base/dists/invgamma/cdf' );
218219

219-
var alpha;
220-
var beta;
221-
var x;
222-
var y;
223-
var i;
224-
225-
for ( i = 0; i < 10; i++ ) {
226-
x = randu() * 2.0;
227-
alpha = randu() * 5.0;
228-
beta = randu() * 5.0;
229-
y = cdf( x, alpha, beta );
230-
console.log( 'x: %d, α: %d, β: %d, F(x;α,β): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
231-
}
220+
var opts = {
221+
'dtype': 'float64'
222+
};
223+
var x = uniform( 10, 0.0, 2.0, opts );
224+
var alpha = uniform( 10, 0.0, 5.0, opts );
225+
var beta = uniform( 10, 0.0, 5.0, opts );
226+
227+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf );
232228
```
233229

234230
</section>

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/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 x = uniform( 10, 0.0, 2.0, opts );
29+
var alpha = uniform( 10, 0.0, 5.0, opts );
30+
var beta = uniform( 10, 0.0, 5.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 2.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/invgamma/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' );
127126
var EPS = require( '@stdlib/constants/float64/eps' );
127+
var uniform = require( '@stdlib/random/array/uniform' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var entropy = require( '@stdlib/stats/base/dists/invgamma/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/invgamma/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/invgamma/kurtosis/README.md‎

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

125125
```javascript
126-
var randu = require( '@stdlib/random/base/randu' );
127126
var EPS = require( '@stdlib/constants/float64/eps' );
127+
var uniform = require( '@stdlib/random/array/uniform' );
128+
var logEachMap = require( '@stdlib/console/log-each-map' );
128129
var kurtosis = require( '@stdlib/stats/base/dists/invgamma/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/invgamma/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/invgamma/logpdf/README.md‎

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,18 @@ var y = mylogPDF( 2.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 logpdf = require( '@stdlib/stats/base/dists/invgamma/logpdf' );
128129

129-
var alpha;
130-
var beta;
131-
var x;
132-
var y;
133-
var i;
134-
135-
for ( i = 0; i < 10; i++ ) {
136-
x = randu() * 2.0;
137-
alpha = randu() * 5.0;
138-
beta = randu() * 5.0;
139-
y = logpdf( x, alpha, beta );
140-
console.log( 'x: %d, α: %d, β: %d, ln(f(x;α,β)): %d', x.toFixed( 4 ), alpha.toFixed( 4 ), beta.toFixed( 4 ), y.toFixed( 4 ) );
141-
}
130+
var opts = {
131+
'dtype': 'float64'
132+
};
133+
var x = uniform( 10, 0.0, 2.0, opts );
134+
var alpha = uniform( 10, 0.0, 5.0, opts );
135+
var beta = uniform( 10, 0.0, 5.0, opts );
136+
137+
logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, beta, logpdf );
142138
```
143139

144140
</section>

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/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 x = uniform( 10, 0.0, 2.0, opts );
29+
var alpha = uniform( 10, 0.0, 5.0, opts );
30+
var beta = uniform( 10, 0.0, 5.0, opts );
2931

30-
for ( i = 0; i < 10; i++ ) {
31-
x = randu() * 2.0;
32-
alpha = randu() * 5.0;
33-
beta = randu() * 5.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 );

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

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

122122
```javascript
123-
var randu = require( '@stdlib/random/base/randu' );
124123
var EPS = require( '@stdlib/constants/float64/eps' );
124+
var uniform = require( '@stdlib/random/array/uniform' );
125+
var logEachMap = require( '@stdlib/console/log-each-map' );
125126
var mean = require( '@stdlib/stats/base/dists/invgamma/mean' );
126127

127-
var alpha;
128-
var beta;
129-
var v;
130-
var i;
128+
var opts = {
129+
'dtype': 'float64'
130+
};
131+
var alpha = uniform( 10, EPS, 10.0, opts );
132+
var beta = uniform( 10, EPS, 10.0, opts );
131133

132-
for ( i = 0; i < 10; i++ ) {
133-
alpha = ( randu()*10.0 ) + EPS;
134-
beta = ( randu()*10.0 ) + EPS;
135-
v = mean( alpha, beta );
136-
console.log( 'α: %d, β: %d, E(X;α,β): %d', alpha.toFixed( 4 ), beta.toFixed( 4 ), v.toFixed( 4 ) );
137-
}
134+
logEachMap( 'α: %0.4f, β: %0.4f, E(X;α,β): %0.4f', alpha, beta, mean );
138135
```
139136

140137
</section>

‎lib/node_modules/@stdlib/stats/base/dists/invgamma/mean/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 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, 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 = 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)